ControllerMixin
Ember.ControllerMixin Class
PRIVATE
Uses: Ember.ActionHandler
Defined in: packages/ember-runtime/lib/mixins/controller.js:5
Module: ember-routing
_qpChangedprivate
During Ember.Route#setup
observers are created to invoke this method when any of the query params declared in Ember.Controller#queryParams
property are changed.
When invoked this method uses the currently active query param update delegate (see Ember.Controller.prototype._qpDelegate
for details) and invokes it with the QP key/value being changed.
_qpDelegateprivate
This property is updated to various different callback functions depending on the current "state" of the backing route. It is used by Ember.Controller.prototype._qpChanged
.
The methods backing each state can be found in the Ember.Route.prototype._qp
computed property return value (the .states
property). The current values are listed here for the sanity of future travelers:
-
inactive
- This state is used when this controller instance is not part of the active route heirarchy. Set inEmber.Route.prototype._reset
(arouter.js
microlib hook) andEmber.Route.prototype.actions.finalizeQueryParamChange
. -
active
- This state is used when this controller instance is part of the active route heirarchy. Set inEmber.Route.prototype.actions.finalizeQueryParamChange
. -
allowOverrides
- This state is used inEmber.Route.prototype.setup
(route.js
microlib hook).
replaceRoute (name, models) public
Transition into another route while replacing the current URL, if possible. This will replace the current history entry instead of adding a new one. Beside that, it is identical to transitionToRoute
in all other respects.
aController.replaceRoute('blogPosts'); aController.replaceRoute('blogPosts.recentEntries');
Optionally supply a model for the route in question. The model will be serialized into the URL using the serialize
hook of the route:
aController.replaceRoute('blogPost', aPost);
If a literal is passed (such as a number or a string), it will be treated as an identifier instead. In this case, the model
hook of the route will be triggered:
aController.replaceRoute('blogPost', 1);
Multiple models will be applied last to first recursively up the route tree.
App.Router.map(function() { this.route('blogPost', { path: ':blogPostId' }, function() { this.route('blogComment', { path: ':blogCommentId', resetNamespace: true }); }); }); aController.replaceRoute('blogComment', aPost, aComment); aController.replaceRoute('blogComment', 1, 13);
It is also possible to pass a URL (a string that starts with a /
). This is intended for testing and debugging purposes and should rarely be used in production code.
aController.replaceRoute('/'); aController.replaceRoute('/blog/post/1/comment/13');
Parameters:
-
name
String
- the name of the route or a URL
-
models
...Object
- the model(s) or identifier(s) to be used while transitioning to the route.
transitionToRoute (name, models, options) public
Transition the application into another route. The route may be either a single route or route path:
aController.transitionToRoute('blogPosts'); aController.transitionToRoute('blogPosts.recentEntries');
Optionally supply a model for the route in question. The model will be serialized into the URL using the serialize
hook of the route:
aController.transitionToRoute('blogPost', aPost);
If a literal is passed (such as a number or a string), it will be treated as an identifier instead. In this case, the model
hook of the route will be triggered:
aController.transitionToRoute('blogPost', 1);
Multiple models will be applied last to first recursively up the route tree.
App.Router.map(function() { this.route('blogPost', { path: ':blogPostId' }, function() { this.route('blogComment', { path: ':blogCommentId', resetNamespace: true }); }); }); aController.transitionToRoute('blogComment', aPost, aComment); aController.transitionToRoute('blogComment', 1, 13);
It is also possible to pass a URL (a string that starts with a /
). This is intended for testing and debugging purposes and should rarely be used in production code.
aController.transitionToRoute('/'); aController.transitionToRoute('/blog/post/1/comment/13'); aController.transitionToRoute('/blog/posts?sort=title');
An options hash with a queryParams
property may be provided as the final argument to add query parameters to the destination URL.
aController.transitionToRoute('blogPost', 1, { queryParams: { showComments: 'true' } }); // if you just want to transition the query parameters without changing the route aController.transitionToRoute({ queryParams: { sort: 'date' } });
See also replaceRoute.
Parameters:
-
name
String
- the name of the route or a URL
-
models
...Object
- the model(s) or identifier(s) to be used while transitioning to the route.
-
options
[Object]
- optional hash with a queryParams property containing a mapping of query parameters
modelpublic
The controller's current model. When retrieving or modifying a controller's model, this property should be used instead of the content
property.
queryParamspublic
Defines which query parameters the controller accepts. If you give the names ['category','page']
it will bind the values of these query parameters to the variables this.category
and this.page
targetpublic
The object to which actions from the view should be sent.
For example, when a Handlebars template uses the {{action}}
helper, it will attempt to send the action to the view's controller's target
.
By default, the value of the target property is set to the router, and is injected when a controller is instantiated. This injection is applied as part of the application's initialization process. In most cases the target
property will automatically be set to the logical consumer of actions for the controller.
Default: null
© 2017 Yehuda Katz, Tom Dale and Ember.js contributors
Licensed under the MIT License.
https://emberjs.com/api/classes/Ember.ControllerMixin.html