Versions Compared

Old Version 3

changes.mady.by.user Nick Reid

Saved on

compared with

New Version 4

changes.mady.by.user Nick Reid

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Currently Supported

  • Localizable Strings
    Allows for updating strings or adding languages through transifex 
  • SCSS/CSS
    Replace variable settings, change layouts, colors, ect 
  • Add UI-Path & Navigation Options
    Add additional pages into UI, and they get exposed 
  • Backend Extensions
    Requisitions product grid has columns that are defined entirely through the backend 

In Process and Undocumented

  • File Overwrite
    Update logo files, template layout files, or how a service operates internally 
  • UI-Route Overwrite
    Change a view definition at runtime, changing the template or controller  


Gliffy
nameExtention screen shots

Depth of Extendability

  • UI-View (Global)
     Allow views defined in UI-Router to have additional content added before or after
  • Requisition Page
    Take the time to build extendable hooks into highly used pages, so that implementers can add functionality to those specific pages. This would discourage developers from forking main parts of mark-up, but it would be important to have enough documentation to support these features or changes.   
  • Budget popover
    Many large pages have small sections that may require extension, but the functionality here is limited and fairly small. Is it worth investment to build hooks into these components or allow for small pieces of code to be forked.


Questions

IssueDiscussionDecisionTicket(s)

Extendable UI-Views

Need: Ability to add or modify the components within a page's layout

Solution (A):

UI-View

Extension

Currently we use UI-Router to coordinate the application, where a UI-View element is implemented to display a single page component. We could extend UI-View to take a list of components, allowing multiple components to be shown in one page area

Directive

Create an angular directive that allows implementers to register a state to a uniquely named extension directive. This would allow a HTML layout template to display a set of components in the order they were registered. This extension directive could be inserted into administration forms to allow for single checkboxes form configuration items to be added to a page. The feature set for this extension would include:

  • Component registration with a unique id
  • Component order enforced by priority
  • Resolved values injected into controller (not passed by scope)

Gliffy
nameExtendable diagram

Solution (B): Template overload

In the build process, we are planning to combine UI-repositories/docker-volumes by merging file structures based on file paths. This allows an implementer to replace the HTML markup for a page's layout and add the components that they need.


(A)(B)
Pro
  • Possible to unit test component integration
  • Component registration files easy to notice
  • No additional work needed
  • Most layout files have simple code, that shouldn't change much
Con
  • Implementation could be difficult
  • Effectively forks the template files that are being overloaded
  • Impossible to unit test
  • Relies on components being modular (not including variables from $scope)






Documentation

What is the best way to document extension points?

  • JS Documentation
  • Markdown documentation guide
  • Sample extension git repository

Form Extensions

A theoretical pain point for implementers is to add a single checkbox or configuration option to a configuration screen. Example: Assign a color selection to a user setting.

This proposal would allow for Templates/Controllers to be added to a `<form>` element programatically. This would function much like extendable UI-Views, but the large technical difference is there would need to be a way to register a function to execute when the form is submitted.