Returns the list of views on the page containing loaded content.
Returns the list of views on the page containing loaded content.
Returns an array of fully-qualified view names.
Returns the list of views currently available on the page, by fully-qualified name.
Returns the list of views currently available on the page, by fully-qualified name.
Returns an array of fully-qualified view names.
Deactivates a ViewConfig.
Deactivates a ViewConfig.
This function deactivates a ViewConfig.
After calling sync, it will un-pair from any ui-view with which it is currently paired.
The ViewConfig view to deregister.
Registers a ui-view component
Registers a ui-view component
When a ui-view component is created, it uses this method to register itself.
After registration the sync method is used to ensure all ui-view are configured with the proper ViewConfig.
Note: the ui-view component uses the ViewConfig to determine what view should be loaded inside the ui-view,
and what the view's state context is.
Note: There is no corresponding deregisterUIView.
A ui-view should hang on to the return value of registerUIView and invoke it to deregister itself.
The metadata for a UIView
a de-registration function used when the view is destroyed.
Given a ui-view and a ViewConfig, determines if they "match".
Given a ui-view and a ViewConfig, determines if they "match".
A ui-view has a fully qualified name (fqn) and a context object. The fqn is built from its overall location in the DOM, describing its nesting relationship to any parent ui-view tags it is nested inside of.
A ViewConfig has a target ui-view name and a context anchor. The ui-view name can be a simple name, or can be a segmented ui-view path, describing a portion of a ui-view fqn.
In order for a ui-view to match ViewConfig, ui-view's $type must match the ViewConfig's $type
If the ViewConfig's target ui-view name is a simple name (no dots), then a ui-view matches if:
If the ViewConfig's target ui-view name is a segmented name (with dots), then a ui-view matches if:
Example:
DOM:
uiViews: [ { fqn: "$default", creationContext: { name: "" } }, { fqn: "$default.foo", creationContext: { name: "A" } }, { fqn: "$default.foo.$default", creationContext: { name: "A.B" } } { fqn: "$default.foo.$default.bar", creationContext: { name: "A.B.C" } } ]
These four view configs all match the ui-view with the fqn: "$default.foo.$default.bar":
Using ViewConfig3 as an example, it matches the ui-view with fqn "$default.foo.$default.bar" because:
Normalizes a view's name from a state.views configuration block.
Normalizes a view's name from a state.views configuration block.
This should be used by a framework implementation to calculate the values for ViewDeclaration.$uiViewName and <a href="../interfaces/state.viewdeclaration.html#uiviewcontextanchor">ViewDeclaration.$uiViewContextAnchor.
the context object (state declaration) that the view belongs to
the name of the view, as declared in the StateDeclaration.views
the normalized uiViewName and uiViewContextAnchor that the view targets
Generated using TypeDoc
The View service
This service pairs existing
ui-viewcomponents (which live in the DOM) with view configs (from the state declaration objects: StateDeclaration.views).After a successful Transition, the views from the newly entered states are activated via activateViewConfig. The views from exited states are deactivated via deactivateViewConfig. (See: the registerActivateViews Transition Hook)
As
ui-viewcomponents pop in and out of existence, they register themselves using registerUIView.When the sync function is called, the registered
ui-view(s) (ActiveUIView) are configured with the matching ViewConfig(s)