Class Ember.ControllerMixin private
Methods
replaceRoute (name, models) : Transition public
Defined in packages/@ember/-internals/routing/lib/ext/controller.ts:177
- 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.
- returns
- Transition
the transition object associated with this attempted transition
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.
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
/).
aController.replaceRoute('/');
aController.replaceRoute('/blog/post/1/comment/13');send (actionName, context) public
Inherited from Ember.ActionHandler packages/@ember/-internals/runtime/lib/mixins/action_handler.js:167
- actionName
- String
The action to trigger
- context
- *
a context to send with the action
Triggers a named action on the ActionHandler. Any parameters
supplied after the actionName string will be passed as arguments
to the action target function.
If the ActionHandler has its target property set, actions may
bubble to the target. Bubbling happens when an actionName can
not be found in the ActionHandler's actions hash or if the
action target function returns true.
Example
import Route from '@ember/routing/route';
export default Route.extend({
actions: {
playTheme() {
this.send('playMusic', 'theme.mp3');
},
playMusic(track) {
// ...
}
}
});
templateOnly (moduleName) public
Defined in packages/@ember/component/template-only.ts:6
- moduleName
- String
the module name that the template only component represents, this will be used for debugging purposes
This utility function is used to declare a given component has no backing class. When the rendering engine detects this it
is able to perform a number of optimizations. Templates that are associated with templateOnly() will be rendered as is
without adding a wrapping <div> (or any of the other element customization behaviors of @ember/component).
Specifically, this means that the template will be rendered as "outer HTML".
In general, this method will be used by build time tooling and would not be directly written in an application. However,
at times it may be useful to use directly to leverage the "outer HTML" semantics mentioned above. For example, if an addon would like
to use these semantics for its templates but cannot be certain it will only be consumed by applications that have enabled the
template-only-glimmer-components optional feature.
Properties
actions public
Inherited from Ember.ActionHandler packages/@ember/-internals/runtime/lib/mixins/action_handler.js:22
The collection of functions, keyed by name, available on this
ActionHandler as action targets.
These functions will be invoked when a matching {{action}} is triggered
from within a template and the application's current route is this route.
Actions can also be invoked from other parts of your application
via ActionHandler#send.
The actions hash will inherit action handlers from
the actions hash defined on extended parent classes
or mixins rather than just replace the entire hash, e.g.:
import Mixin from '@ember/mixin';
export default Mixin.create({
actions: {
displayBanner(msg) {
// ...
}
}
});
import Route from '@ember/routing/route';
import CanDisplayBanner from '../mixins/can-display-banner';
export default Route.extend(CanDisplayBanner, {
actions: {
playMusic() {
// ...
}
}
});
// `WelcomeRoute`, when active, will be able to respond
// to both actions, since the actions hash is merged rather
// then replaced when extending mixins / parent classes.
this.send('displayBanner');
this.send('playMusic');
Within a Controller, Route or Component's action handler,
the value of the this context is the Controller, Route or
Component object:
import Route from '@ember/routing/route';
export default Route.extend({
actions: {
myAction() {
this.controllerFor("song");
this.transitionTo("other.route");
...
}
}
});
It is also possible to call this._super(...arguments) from within an
action handler if it overrides a handler defined on a parent
class or mixin:
Take for example the following routes:
import Mixin from '@ember/mixin';
export default Mixin.create({
actions: {
debugRouteInformation() {
console.debug("It's a-me, console.debug!");
}
}
});
import Route from '@ember/routing/route';
import DebugRoute from '../mixins/debug-route';
export default Route.extend(DebugRoute, {
actions: {
debugRouteInformation() {
// also call the debugRouteInformation of mixed in DebugRoute
this._super(...arguments);
// show additional annoyance
window.alert(...);
}
}
});
Bubbling
By default, an action will stop bubbling once a handler defined
on the actions hash handles it. To continue bubbling the action,
you must return true from the handler:
Router.map(function() {
this.route("album", function() {
this.route("song");
});
});
import Route from '@ember/routing/route';
export default Route.extend({
actions: {
startPlaying: function() {
}
}
});
import Route from '@ember/routing/route';
export default Route.extend({
actions: {
startPlaying() {
// ...
if (actionShouldAlsoBeTriggeredOnParentRoute) {
return true;
}
}
}
});
model public
Defined in packages/@ember/controller/lib/controller_mixin.js:41
The controller's current model. When retrieving or modifying a controller's
model, this property should be used instead of the content property.
queryParams public
Defined in packages/@ember/-internals/routing/lib/ext/controller.ts:22
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.
By default, query parameters are parsed as strings. This
may cause unexpected behavior if a query parameter is used with toggleProperty,
because the initial value set for param=false will be the string "false", which is truthy.
To avoid this, you may specify that the query parameter should be parsed as a boolean
by using the following verbose form with a type property:
queryParams: [{
category: {
type: 'boolean'
}
}]
Available values for the type parameter are 'boolean', 'number', 'array', and 'string'.
If query param type is not specified, it will default to 'string'.
target public
Defined in packages/@ember/controller/lib/controller_mixin.js:21
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.