State._viewdeclaration

Base interface for declaring a view

This interface defines the basic data that a normalized view declaration will have on it. Framework-specific implementations should add additional fields (to their interfaces which extend this interface).

Hierarchy

_ViewDeclaration

Index

Properties

$context: ViewContext

The context that this view is declared within.

$name: string

The raw name for the view declaration, i.e., the StateDeclaration.views property name.

$type: string

A type identifier for the View

This is used when loading prerequisites for the view, before it enters the DOM. Different types of views may load differently (e.g., templateProvider+controllerProvider vs component class)

$uiViewContextAnchor: string

The normalized context anchor (state name) for the uiViewName

When targeting a ui-view, the uiViewName address is anchored to a context name (state name).

$uiViewName: string

The normalized address for the ui-view which this ViewConfig targets.

A ViewConfig targets a ui-view in the DOM (relative to the uiViewContextAnchor) which has a specific name.

example

header or $default

The uiViewName can also target a nested view by providing a dot-notation address

example

foo.bar or foo.$default.bar