The raw name for the view declaration, i.e., the StateDeclaration.views property name.
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)
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).
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.
An object which maps resolve
s to component bindings
.
A property of Ng1StateDeclaration or Ng1ViewDeclaration:
When using a component declaration (component: 'myComponent'
), each input binding for the component is supplied
data from a resolve of the same name, by default. You may supply data from a different resolve name by mapping it here.
Each key in this object is the name of one of the component's input bindings. Each value is the name of the resolve that should be provided to that binding.
Any component bindings that are omitted from this map get the default behavior of mapping to a resolve of the same name.
$stateProvider.state('foo', {
resolve: {
foo: function(FooService) { return FooService.get(); },
bar: function(BarService) { return BarService.get(); }
},
component: 'Baz',
// The component's `baz` binding gets data from the `bar` resolve
// The component's `foo` binding gets data from the `foo` resolve (default behavior)
bindings: {
baz: 'bar'
}
});
app.component('Baz', {
templateUrl: 'baz.html',
controller: 'BazController',
bindings: {
foo: '<', // foo binding
baz: '<' // baz binding
}
});
The name of the component to use for this view.
A property of Ng1StateDeclaration or Ng1ViewDeclaration:
The name of an angular 1.5+ .component()
(or directive with
bindToController and/or scope declaration) which will be used for this view.
Resolve data can be provided to the component via the component's bindings
object (for 1.3+ directives, the
bindToController
is used; for other directives, the scope
declaration is used). For each binding declared
on the component, any resolve with the same name is set on the component's controller instance. The binding
is provided to the component as a one-time-binding. In general, components should likewise declare their
input bindings as one-way ("<").
Note: inside a "views:" block, a bare string "foo"
is shorthand for { component: "foo" }
Note: Mapping from resolve names to component inputs may be specified using bindings.
.state('profile', {
// Use the <my-profile></my-profile> component for the Unnamed view
component: 'MyProfile',
}
.state('messages', {
// use the <nav-bar></nav-bar> component for the view named 'header'
// use the <message-list></message-list> component for the view named 'content'
views: {
header: { component: 'NavBar' },
content: { component: 'MessageList' }
}
}
.state('contacts', {
// Inside a "views:" block, a bare string "NavBar" is shorthand for { component: "NavBar" }
// use the <nav-bar></nav-bar> component for the view named 'header'
// use the <contact-list></contact-list> component for the view named 'content'
views: {
header: 'NavBar',
content: 'ContactList'
}
}
Note: When using component
to define a view, you may not use any of: template
, templateUrl
,
templateProvider
, controller
, controllerProvider
, controllerAs
.
See also: Todd Motto's angular 1.3 and 1.4 backport of .component()
Dynamic component provider function.
A property of Ng1StateDeclaration or Ng1ViewDeclaration:
This is an injectable provider function which returns the name of the component to use. The provider will invoked during a Transition in which the view's state is entered. The provider is called after the resolve data is fetched.
componentProvider: function(MyResolveData, $transition$) {
if (MyResolveData.foo) {
return "fooComponent"
} else if ($transition$.to().name === 'bar') {
return "barComponent";
}
}
The view's controller function or name
A property of Ng1StateDeclaration or Ng1ViewDeclaration:
The controller function, or the name of a registered controller. The controller function will be used to control the contents of the directives.uiView directive.
If specified as a string, controllerAs can be declared here, i.e., "FooController as foo" instead of in a separate controllerAs property.
See: Ng1Controller for information about component-level router hooks.
A controller alias name.
A property of Ng1StateDeclaration or Ng1ViewDeclaration:
If present, the controller will be published to scope under the controllerAs
name.
See: https://docs.angularjs.org/api/ng/directive/ngController
Dynamic controller provider function.
A property of Ng1StateDeclaration or Ng1ViewDeclaration:
This is an injectable provider function which returns the actual controller function, or the name of a registered controller. The provider will invoked during a Transition in which the view's state is entered. The provider is called after the resolve data is fetched.
controllerProvider: function(MyResolveData, $transition$) {
if (MyResolveData.foo) {
return "FooCtrl"
} else if ($transition$.to().name === 'bar') {
return "BarCtrl";
} else {
return function($scope) {
$scope.baz = "Qux";
}
}
}
The scope variable name to use for resolve data.
A property of Ng1StateDeclaration or Ng1ViewDeclaration:
When a view is activated, the resolved data for the state which the view belongs to is put on the scope. This property sets the name of the scope variable to use for the resolved data.
Defaults to $resolve
.
The HTML template for the view.
A property of Ng1StateDeclaration or Ng1ViewDeclaration:
HTML template as a string, or a function which returns an html template as a string. This template will be used to render the corresponding directives.uiView directive.
This property takes precedence over templateUrl.
If template
is a function, it will be called with the Transition parameters as the first argument.
template: "<h1>inline template definition</h1><div ui-view></div>"
template: function(params) {
return "<h1>generated template</h1>";
}
Injected function which returns the HTML template.
A property of Ng1StateDeclaration or Ng1ViewDeclaration:
Injected function which returns the HTML template. The template will be used to render the corresponding directives.uiView directive.
templateProvider: function(MyTemplateService, $transition$) {
return MyTemplateService.getTemplate($transition$.params().pageId);
}
The URL for the HTML template for the view.
A property of Ng1StateDeclaration or Ng1ViewDeclaration:
A path or a function that returns a path to an html template. The template will be fetched and used to render the corresponding directives.uiView directive.
If templateUrl
is a function, it will be called with the Transition parameters as the first argument.
templateUrl: "/templates/home.html"
templateUrl: function(params) {
return myTemplates[params.pageId];
}
Generated using TypeDoc
The context that this view is declared within.