W3cubDocs

/Ember.js

Ember.Route (public)

Ember.ActionHandler
Extends: Ember.Object
Uses: Ember.Evented ,
Defined in: packages/ember-routing/lib/system/route.js:67
Module: ember

activate public

This hook is executed when the router enters the route. It is not executed when the model for the route changes.

addObserver (key, target, method) public

key
String
The key to observe
target
Object
The target object to invoke
method
String|Function
The method to invoke

Adds an observer on a property.

This is the core method used to register an observer for a property.

Once you call this method, any time the key's value is set, your observer will be notified. Note that the observers are triggered any time the value is set, regardless of whether it has actually changed. Your observer should be prepared to handle that.

Observer Methods

Observer methods have the following signature:

export default Ember.Component.extend({
  init() {
    this._super(...arguments);
    this.addObserver('foo', this, 'fooDidChange');
  },

  fooDidChange(sender, key, value, rev) {
    // your code
  }
});

The sender is the object that changed. The key is the property that changes. The value property is currently reserved and unused. The rev is the last property revision of the object when it changed, which you can use to detect if the key value has really changed or not.

Usually you will not need the value or revision parameters at the end. In this case, it is common to write observer methods that take only a sender and key value as parameters or, if you aren't interested in any of these values, to write an observer that has no parameters at all.

afterModel (resolvedModel, transition) Any | Promise<any> public

resolvedModel
Object
the value returned from `model`, or its resolved value if it was a promise
transition
Transition
returns
Any | Promise<any>
if the value returned from this hook is a promise, the transition will pause until the transition resolves. Otherwise, non-promise return values are not utilized in any way.

This hook is called after this route's model has resolved. It follows identical async/promise semantics to beforeModel but is provided the route's resolved model in addition to the transition, and is therefore suited to performing logic that can only take place after the model has already resolved.

import Ember from 'ember';

export default Ember.Route.extend({
  afterModel(posts, transition) {
    if (posts.get('length') === 1) {
      this.transitionTo('post.show', posts.get('firstObject'));
    }
  }
});

Refer to documentation for beforeModel for a description of transition-pausing semantics when a promise is returned from this hook.

beforeModel (transition) Any | Promise<any> public

transition
Transition
returns
Any | Promise<any>
if the value returned from this hook is a promise, the transition will pause until the transition resolves. Otherwise, non-promise return values are not utilized in any way.

This hook is the first of the route entry validation hooks called when an attempt is made to transition into a route or one of its children. It is called before model and afterModel, and is appropriate for cases when:

1) A decision can be made to redirect elsewhere without needing to resolve the model first. 2) Any async operations need to occur first before the model is attempted to be resolved.

This hook is provided the current transition attempt as a parameter, which can be used to .abort() the transition, save it for a later .retry(), or retrieve values set on it from a previous hook. You can also just call this.transitionTo to another route to implicitly abort the transition.

You can return a promise from this hook to pause the transition until the promise resolves (or rejects). This could be useful, for instance, for retrieving async code from the server that is required to enter a route.

cacheFor (keyName) Object public

keyName
String
returns
Object
The cached value of the computed property, if any

Returns the cached value of a computed property, if it exists. This allows you to inspect the value of a computed property without accidentally invoking it if it is intended to be generated lazily.

controllerFor (name) Ember.Controller public

name
String
the name of the route or controller
returns
Ember.Controller

Returns the controller of the current route, or a parent (or any ancestor) route in a route hierarchy.

The controller instance must already have been created, either through entering the associated route or using generateController.

import Ember from 'ember';

export default Ember.Route.extend({
  setupController(controller, post) {
    this._super(controller, post);
    this.controllerFor('posts').set('currentPost', post);
  }
});

create (arguments) public

arguments

Creates an instance of a class. Accepts either no arguments, or an object containing values to initialize the newly instantiated object with.

const Person = Ember.Object.extend({
  helloWorld() {
    alert(`Hi, my name is ${this.get('name')}`);
  }
});

let tom = Person.create({
  name: 'Tom Dale'
});

tom.helloWorld(); // alerts "Hi, my name is Tom Dale".

create will call the init function if defined during Ember.AnyObject.extend

If no arguments are passed to create, it will not set values to the new instance during initialization:

let noName = Person.create();
noName.helloWorld(); // alerts undefined

NOTE: For performance reasons, you cannot declare methods or computed properties during create. You should instead declare methods and computed properties when using extend.

deactivate public

This hook is executed when the router completely exits this route. It is not executed when the model for the route changes.

decrementProperty (keyName, decrement) Number public

keyName
String
The name of the property to decrement
decrement
Number
The amount to decrement by. Defaults to 1
returns
Number
The new property value

Set the value of a property to the current value minus some amount.

player.decrementProperty('lives');
orc.decrementProperty('health', 5);

destroy Ember.Object public

returns
Ember.Object
receiver

Destroys an object by setting the isDestroyed flag and removing its metadata, which effectively destroys observers and bindings.

If you try to set a property on a destroyed object, an exception will be raised.

Note that destruction is scheduled for the end of the run loop and does not happen immediately. It will set an isDestroying flag immediately.

disconnectOutlet (options) public

options
Object|String
the options hash or outlet name

Disconnects a view that has been rendered into an outlet.

You may pass any or all of the following options to disconnectOutlet:

  • outlet: the name of the outlet to clear (default: 'main')
  • parentView: the name of the view containing the outlet to clear (default: the view rendered by the parent route)

Example:

import Ember from 'ember';

export default App.Route.extend({
  actions: {
    showModal(evt) {
      this.render(evt.modalName, {
        outlet: 'modal',
        into: 'application'
      });
    },
    hideModal(evt) {
      this.disconnectOutlet({
        outlet: 'modal',
        parentView: 'application'
      });
    }
  }
});

Alternatively, you can pass the outlet name directly as a string.

Example:

```app/routes/application.js import Ember from 'ember';

export default App.Route.extend({ actions: { showModal(evt) { // ... }, hideModal(evt) { this.disconnectOutlet('modal'); } } });

extend (mixins, arguments) public

mixins
Mixin
One or more Mixin classes
arguments
Object
Object containing values to use within the new class

Creates a new subclass.

const Person = Ember.Object.extend({
  say(thing) {
    alert(thing);
   }
});

This defines a new subclass of Ember.Object: Person. It contains one method: say().

You can also create a subclass from any existing class by calling its extend() method. For example, you might want to create a subclass of Ember's built-in Ember.Component class:

const PersonComponent = Ember.Component.extend({
  tagName: 'li',
  classNameBindings: ['isAdministrator']
});

When defining a subclass, you can override methods but still access the implementation of your parent class by calling the special _super() method:

const Person = Ember.Object.extend({
  say(thing) {
    let name = this.get('name');
    alert(`${name} says: ${thing}`);
  }
});

const Soldier = Person.extend({
  say(thing) {
    this._super(`${thing}, sir!`);
  },
  march(numberOfHours) {
    alert(`${this.get('name')} marches for ${numberOfHours} hours.`);
  }
});

let yehuda = Soldier.create({
  name: 'Yehuda Katz'
});

yehuda.say('Yes');  // alerts "Yehuda Katz says: Yes, sir!"

The create() on line #17 creates an instance of the Soldier class. The extend() on line #8 creates a subclass of Person. Any instance of the Person class will not have the march() method.

You can also pass Mixin classes to add additional properties to the subclass.

const Person = Ember.Object.extend({
  say(thing) {
    alert(`${this.get('name')} says: ${thing}`);
  }
});

const SingingMixin = Mixin.create({
  sing(thing){
    alert(`${this.get('name')} sings: la la la ${thing}`);
  }
});

const BroadwayStar = Person.extend(SingingMixin, {
  dance() {
    alert(`${this.get('name')} dances: tap tap tap tap `);
  }
});

The BroadwayStar class contains three methods: say(), sing(), and dance().

get (keyName) Object public

keyName
String
The property to retrieve
returns
Object
The property value or undefined.

Retrieves the value of a property from the object.

This method is usually similar to using object[keyName] or object.keyName, however it supports both computed properties and the unknownProperty handler.

Because get unifies the syntax for accessing all these kinds of properties, it can make many refactorings easier, such as replacing a simple property with a computed property, or vice versa.

Computed Properties

Computed properties are methods defined with the property modifier declared at the end, such as:

fullName: Ember.computed('firstName', 'lastName', function() {
  return this.get('firstName') + ' ' + this.get('lastName');
})

When you call get on a computed property, the function will be called and the return value will be returned instead of the function itself.

Unknown Properties

Likewise, if you try to call get on a property whose value is undefined, the unknownProperty() method will be called on the object. If this method returns any value other than undefined, it will be returned instead. This allows you to implement "virtual" properties that are not defined upfront.

getProperties (list) Object public

list
String...|Array
of keys to get
returns
Object

To get the values of multiple properties at once, call getProperties with a list of strings or an array:

record.getProperties('firstName', 'lastName', 'zipCode');
// { firstName: 'John', lastName: 'Doe', zipCode: '10011' }

is equivalent to:

record.getProperties(['firstName', 'lastName', 'zipCode']);
// { firstName: 'John', lastName: 'Doe', zipCode: '10011' }

getWithDefault (keyName, defaultValue) Object public

keyName
String
The name of the property to retrieve
defaultValue
Object
The value to return if the property value is undefined
returns
Object
The property value or the defaultValue.

Retrieves the value of a property, or a default value in the case that the property returns undefined.

person.getWithDefault('lastName', 'Doe');

has (name) Boolean public

name
String
The name of the event
returns
Boolean
does the object have a subscription for event

Checks to see if object has any subscriptions for named event.

incrementProperty (keyName, increment) Number public

keyName
String
The name of the property to increment
increment
Number
The amount to increment by. Defaults to 1
returns
Number
The new property value

Set the value of a property to the current value plus some amount.

person.incrementProperty('age');
team.incrementProperty('score', 2);

init public

An overridable method called when objects are instantiated. By default, does nothing unless it is overridden during class definition.

Example:

const Person = Ember.Object.extend({
  init() {
    alert(`Name is ${this.get('name')}`);
  }
});

let steve = Person.create({
  name: 'Steve'
});

// alerts 'Name is Steve'.

NOTE: If you do override init for a framework class like Ember.View, be sure to call this._super(...arguments) in your init declaration! If you don't, Ember may not have an opportunity to do important setup work, and you'll see strange behavior in your application.

intermediateTransitionTo (name, models) public

name
String
the name of the route
models
...Object
the model(s) to be used while transitioning to the route.

Perform a synchronous transition into another route without attempting to resolve promises, update the URL, or abort any currently active asynchronous transitions (i.e. regular transitions caused by transitionTo or URL changes).

This method is handy for performing intermediate transitions on the way to a final destination route, and is called internally by the default implementations of the error and loading handlers.

model (params, transition) Any | Promise<any> public

params
Object
the parameters extracted from the URL
transition
Transition
returns
Any | Promise<any>
the model for this route. If a promise is returned, the transition will pause until the promise resolves, and the resolved value of the promise will be used as the model for this route.

A hook you can implement to convert the URL into the model for this route.

// ...

Router.map(function() {
  this.route('post', { path: '/posts/:post_id' });
});

export default Router;

The model for the post route is store.findRecord('post', params.post_id).

By default, if your route has a dynamic segment ending in _id:

  • The model class is determined from the segment (post_id's class is App.Post)
  • The find method is called on the model class with the value of the dynamic segment.

Note that for routes with dynamic segments, this hook is not always executed. If the route is entered through a transition (e.g. when using the link-to Handlebars helper or the transitionTo method of routes), and a model context is already provided this hook is not called.

A model context does not include a primitive string or number, which does cause the model hook to be called.

Routes without dynamic segments will always execute the model hook.

// no dynamic segment, model hook always called
this.transitionTo('posts');

// model passed in, so model hook not called
thePost = store.findRecord('post', 1);
this.transitionTo('post', thePost);

// integer passed in, model hook is called
this.transitionTo('post', 1);

// model id passed in, model hook is called
// useful for forcing the hook to execute
thePost = store.findRecord('post', 1);
this.transitionTo('post', thePost.id);

This hook follows the asynchronous/promise semantics described in the documentation for beforeModel. In particular, if a promise returned from model fails, the error will be handled by the error hook on Ember.Route.

Example

import Ember from 'ember';

export default Ember.Route.extend({
  model(params) {
    return this.store.findRecord('post', params.post_id);
  }
});

modelFor (name) Object public

name
String
the name of the route
returns
Object
the model object

Returns the resolved model of a parent (or any ancestor) route in a route hierarchy. During a transition, all routes must resolve a model object, and if a route needs access to a parent route's model in order to resolve a model (or just reuse the model from a parent), it can call this.modelFor(theNameOfParentRoute) to retrieve it. If the ancestor route's model was a promise, its resolved result is returned.

Example

// ...

Router.map(function() {
  this.route('post', { path: '/posts/:post_id' }, function() {
    this.route('comments');
  });
});

export default Router;
import Ember from 'ember';

export default Ember.Route.extend({
  model() {
    let post = this.modelFor('post');
    return post.get('comments');
  }
});

notifyPropertyChange (keyName) Ember.Observable public

keyName
String
The property key to be notified about.
returns
Ember.Observable

Convenience method to call propertyWillChange and propertyDidChange in succession.

off (name, target, method) public

name
String
The name of the event
target
Object
The target of the subscription
method
Function
The function of the subscription
returns
this

Cancels subscription for given name, target, and method.

on (name, target, method) public

name
String
The name of the event
target
Object
The "this" binding for the callback
method
Function
The callback to execute
returns
this

Subscribes to a named event with given function.

person.on('didLoad', function() {
  // fired once the person has loaded
});

An optional target can be passed in as the 2nd argument that will be set as the "this" for the callback. This is a good way to give your function access to the object triggering the event. When the target parameter is used the callback becomes the third argument.

one (name, target, method) public

name
String
The name of the event
target
Object
The "this" binding for the callback
method
Function
The callback to execute
returns
this

Subscribes a function to a named event and then cancels the subscription after the first time the event is triggered. It is good to use one when you only care about the first time an event has taken place.

This function takes an optional 2nd argument that will become the "this" value for the callback. If this argument is passed then the 3rd argument becomes the function.

paramsFor (name) Object public

name
String
returns
Object
hash containing the parameters of the route `name`

Returns a hash containing the parameters of an ancestor route.

Example

// ...

Router.map(function() {
  this.route('member', { path: ':name' }, function() {
    this.route('interest', { path: ':interest' });
  });
});
export default Ember.Route.extend({
  queryParams: {
    memberQp: { refreshModel: true }
  }
});
export default Ember.Route.extend({
  queryParams: {
    interestQp: { refreshModel: true }
  },

  model() {
    return this.paramsFor('member');
  }
});

If we visit /turing/maths?memberQp=member&interestQp=interest the model for the member.interest route is hash with:

  • name: turing
  • memberQp: member

redirect (model, transition) public

model
Object
the model for this route
transition
Transition
the transition object associated with the current transition

A hook you can implement to optionally redirect to another route.

If you call this.transitionTo from inside of this hook, this route will not be entered in favor of the other hook.

redirect and afterModel behave very similarly and are called almost at the same time, but they have an important distinction in the case that, from one of these hooks, a redirect into a child route of this route occurs: redirects from afterModel essentially invalidate the current attempt to enter this route, and will result in this route's beforeModel, model, and afterModel hooks being fired again within the new, redirecting transition. Redirects that occur within the redirect hook, on the other hand, will not cause these hooks to be fired again the second time around; in other words, by the time the redirect hook has been called, both the resolved model and attempted entry into this route are considered to be fully validated.

refresh Transition public

returns
Transition
the transition object associated with this attempted transition

Refresh the model on this route and any child routes, firing the beforeModel, model, and afterModel hooks in a similar fashion to how routes are entered when transitioning in from other route. The current route params (e.g. article_id) will be passed in to the respective model hooks, and if a different model is returned, setupController and associated route hooks will re-fire as well.

An example usage of this method is re-querying the server for the latest information using the same parameters as when the route was first entered.

Note that this will cause model hooks to fire even on routes that were provided a model object when the route was initially entered.

removeObserver (key, target, method) public

key
String
The key to observe
target
Object
The target object to invoke
method
String|Function
The method to invoke

Remove an observer you have previously registered on this object. Pass the same key, target, and method you passed to addObserver() and your target will no longer receive notifications.

render (name, options) public

name
String
the name of the template to render
options
Object
the options

render is used to render a template into a region of another template (indicated by an {{outlet}}). render is used both during the entry phase of routing (via the renderTemplate hook) and later in response to user interaction.

For example, given the following minimal router and templates:

// ...

Router.map(function() {
  this.route('photos');
});

export default Router;
<!-- application.hbs -->
<div class='something-in-the-app-hbs'>
  {{outlet "anOutletName"}}
</div>
<!-- photos.hbs -->
<h1>Photos</h1>

You can render photos.hbs into the "anOutletName" outlet of application.hbs by calling render:

import Ember from 'ember';

export default Ember.Route.extend({
  renderTemplate() {
    this.render('photos', {
      into: 'application',
      outlet: 'anOutletName'
    })
  }
});

render additionally allows you to supply which controller and model objects should be loaded and associated with the rendered template.

import Ember from 'ember';

export default Ember.Route.extend({
  renderTemplate(controller, model){
    this.render('posts', {    // the template to render, referenced by name
      into: 'application',    // the template to render into, referenced by name
      outlet: 'anOutletName', // the outlet inside `options.template` to render into.
      controller: 'someControllerName', // the controller to use for this template, referenced by name
      model: model            // the model to set on `options.controller`.
    })
  }
});

The string values provided for the template name, and controller will eventually pass through to the resolver for lookup. See Ember.Resolver for how these are mapped to JavaScript objects in your application. The template to render into needs to be related to either the current route or one of its ancestors.

Not all options need to be passed to render. Default values will be used based on the name of the route specified in the router or the Route's controllerName and templateName properties.

For example:

// ...

Router.map(function() {
  this.route('index');
  this.route('post', { path: '/posts/:post_id' });
});

export default Router;
import Ember from 'ember';

export default Ember.Route.extend({
  renderTemplate() {
    this.render(); // all defaults apply
  }
});

The name of the route, defined by the router, is post.

The following equivalent default options will be applied when the Route calls render:

this.render('post', {  // the template name associated with 'post' Route
  into: 'application', // the parent route to 'post' Route
  outlet: 'main',      // {{outlet}} and {{outlet 'main'}} are synonymous,
  controller: 'post',  // the controller associated with the 'post' Route
})

By default the controller's model will be the route's model, so it does not need to be passed unless you wish to change which model is being used.

renderTemplate (controller, model) public

controller
Object
the route's controller
model
Object
the route's model

A hook you can use to render the template for the current route.

This method is called with the controller for the current route and the model supplied by the model hook. By default, it renders the route's template, configured with the controller for the route.

This method can be overridden to set up and render additional or alternative templates.

import Ember from 'ember';

export default Ember.Route.extend({
  renderTemplate(controller, model) {
    let favController = this.controllerFor('favoritePost');

    // Render the `favoritePost` template into
    // the outlet `posts`, and display the `favoritePost`
    // controller.
    this.render('favoritePost', {
      outlet: 'posts',
      controller: favController
    });
  }
});

reopen public

Augments a constructor's prototype with additional properties and functions:

const MyObject = Ember.Object.extend({
  name: 'an object'
});

o = MyObject.create();
o.get('name'); // 'an object'

MyObject.reopen({
  say(msg) {
    console.log(msg);
  }
});

o2 = MyObject.create();
o2.say('hello'); // logs "hello"

o.say('goodbye'); // logs "goodbye"

To add functions and properties to the constructor itself, see reopenClass

reopenClass public

Augments a constructor's own properties and functions:

const MyObject = Ember.Object.extend({
  name: 'an object'
});

MyObject.reopenClass({
  canBuild: false
});

MyObject.canBuild; // false
o = MyObject.create();

In other words, this creates static properties and functions for the class. These are only available on the class and not on any instance of that class.

const Person = Ember.Object.extend({
  name: '',
  sayHello() {
    alert(`Hello. My name is ${this.get('name')}`);
  }
});

Person.reopenClass({
  species: 'Homo sapiens',

  createPerson(name) {
    return Person.create({ name });
  }
});

let tom = Person.create({
  name: 'Tom Dale'
});
let yehuda = Person.createPerson('Yehuda Katz');

tom.sayHello(); // "Hello. My name is Tom Dale"
yehuda.sayHello(); // "Hello. My name is Yehuda Katz"
alert(Person.species); // "Homo sapiens"

Note that species and createPerson are not valid on the tom and yehuda variables. They are only valid on Person.

To add functions and properties to instances of a constructor by extending the constructor's prototype see reopen

replaceWith (name, models, options) Transition public

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
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 transitionTo in all other respects. See 'transitionTo' for additional information regarding multiple models.

Example

// ...

Router.map(function() {
  this.route('index');
  this.route('secret');
});

export default Router;
import Ember from 'ember';

export default Ember.Route.extend({
  afterModel() {
    if (!authorized()){
      this.replaceWith('index');
    }
  }
});

resetController (controller, isExiting, transition) public

controller
Controller
instance
isExiting
Boolean
transition
Object

A hook you can use to reset controller values either when the model changes or the route is exiting.

import Ember from 'ember';

export default Ember.Route.extend({
  resetController(controller, isExiting, transition) {
    if (isExiting) {
      controller.set('page', 1);
    }
  }
});

send (name, args) public

name
String
the name of the action to trigger
args
...*

Sends an action to the router, which will delegate it to the currently active route hierarchy per the bubbling rules explained under actions.

Example

// ...

Router.map(function() {
  this.route('index');
});

export default Router;
import Ember from 'ember';

export default Ember.Route.extend({
  actions: {
    track(arg) {
      console.log(arg, 'was clicked');
    }
  }
});
import Ember from 'ember';

export default Ember.Route.extend({
  actions: {
    trackIfDebug(arg) {
      if (debug) {
        this.send('track', arg);
      }
    }
  }
});

send (actionName, context) public

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

App.WelcomeRoute = Ember.Route.extend({
  actions: {
    playTheme() {
       this.send('playMusic', 'theme.mp3');
    },
    playMusic(track) {
      // ...
    }
  }
});

serialize (model, params) Object public

model
Object
the routes model
params
Array
an Array of parameter names for the current route (in the example, `['post_id']`.
returns
Object
the serialized parameters

A hook you can implement to convert the route's model into parameters for the URL.

// ...

Router.map(function() {
  this.route('post', { path: '/posts/:post_id' });
});
import Ember from 'ember';

export default Ember.Route.extend({
  model(params) {
    // the server returns `{ id: 12 }`
    return Ember.$.getJSON('/posts/' + params.post_id);
  },

  serialize(model) {
    // this will make the URL `/posts/12`
    return { post_id: model.id };
  }
});

The default serialize method will insert the model's id into the route's dynamic segment (in this case, :post_id) if the segment contains '_id'. If the route has multiple dynamic segments or does not contain '_id', serialize will return Ember.getProperties(model, params)

This method is called when transitionTo is called with a context in order to populate the URL.

set (keyName, value) Object public

keyName
String
The property to set
value
Object
The value to set or `null`.
returns
Object
The passed value

Sets the provided key or path to the value.

record.set("key", value);

This method is generally very similar to calling object["key"] = value or object.key = value, except that it provides support for computed properties, the setUnknownProperty() method and property observers.

Computed Properties

If you try to set a value on a key that has a computed property handler defined (see the get() method for an example), then set() will call that method, passing both the value and key instead of simply changing the value itself. This is useful for those times when you need to implement a property that is composed of one or more member properties.

Unknown Properties

If you try to set a value on a key that is undefined in the target object, then the setUnknownProperty() handler will be called instead. This gives you an opportunity to implement complex "virtual" properties that are not predefined on the object. If setUnknownProperty() returns undefined, then set() will simply set the value on the object.

Property Observers

In addition to changing the property, set() will also register a property change with the object. Unless you have placed this call inside of a beginPropertyChanges() and endPropertyChanges(), any "local" observers (i.e. observer methods declared on the same object), will be called immediately. Any "remote" observers (i.e. observer methods declared on another object) will be placed in a queue and called at a later time in a coalesced manner.

setProperties (hash) Object public

hash
Object
the hash of keys and values to set
returns
Object
The passed in hash

Sets a list of properties at once. These properties are set inside a single beginPropertyChanges and endPropertyChanges batch, so observers will be buffered.

record.setProperties({ firstName: 'Charles', lastName: 'Jolley' });

setupController (controller, model) public

controller
Controller
instance
model
Object

A hook you can use to setup the controller for the current route.

This method is called with the controller for the current route and the model supplied by the model hook.

By default, the setupController hook sets the model property of the controller to the model.

If you implement the setupController hook in your Route, it will prevent this default behavior. If you want to preserve that behavior when implementing your setupController function, make sure to call _super:

import Ember from 'ember';

export default Ember.Route.extend({
  model() {
    return this.store.findAll('photo');
  },

  setupController(controller, model) {
    // Call _super for default behavior
    this._super(controller, model);
    // Implement your custom setup after
    this.controllerFor('application').set('showingPhotos', true);
  }
});

The provided controller will be one resolved based on the name of this route.

If no explicit controller is defined, Ember will automatically create one.

As an example, consider the router:

// ...

Router.map(function() {
  this.route('post', { path: '/posts/:post_id' });
});

export default Router;

For the post route, a controller named App.PostController would be used if it is defined. If it is not defined, a basic Ember.Controller instance would be used.

Example

import Ember from 'ember';

export default Ember.Route.extend({
  setupController(controller, model) {
    controller.set('model', model);
  }
});

toString String public

returns
String
string representation

Returns a string representation which attempts to provide more information than Javascript's toString typically does, in a generic way for all Ember objects.

const Person = Ember.Object.extend()
person = Person.create()
person.toString() //=> "<Person:ember1024>"

If the object's class is not defined on an Ember namespace, it will indicate it is a subclass of the registered superclass:

const Student = Person.extend()
let student = Student.create()
student.toString() //=> "<(subclass of Person):ember1025>"

If the method toStringExtension is defined, its return value will be included in the output.

const Teacher = Person.extend({
  toStringExtension() {
    return this.get('fullName');
  }
});
teacher = Teacher.create()
teacher.toString(); //=> "<Teacher:ember1026:Tom Dale>"

toggleProperty (keyName) Boolean public

keyName
String
The name of the property to toggle
returns
Boolean
The new property value

Set the value of a boolean property to the opposite of its current value.

starship.toggleProperty('warpDriveEngaged');

transitionTo (name, models, options) Transition public

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
returns
Transition
the transition object associated with this attempted transition

Transition the application into another route. The route may be either a single route or route path:

this.transitionTo('blogPosts');
this.transitionTo('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:

this.transitionTo('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:

this.transitionTo('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' });
  });
});

export default Router;
this.transitionTo('blogComment', aPost, aComment);
this.transitionTo('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.

this.transitionTo('/');
this.transitionTo('/blog/post/1/comment/13');
this.transitionTo('/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.

this.transitionTo('blogPost', 1, {
  queryParams: { showComments: 'true' }
});

// if you just want to transition the query parameters without changing the route
this.transitionTo({ queryParams: { sort: 'date' } });

See also replaceWith.

Simple Transition Example

// ...

Router.map(function() {
  this.route('index');
  this.route('secret');
  this.route('fourOhFour', { path: '*:' });
});

export default Router;
import Ember from 'ember':

export Ember.Route.extend({
  actions: {
    moveToSecret(context) {
      if (authorized()) {
        this.transitionTo('secret', context);
      } else {
        this.transitionTo('fourOhFour');
      }
    }
  }
});

Transition to a nested route

// ...

Router.map(function() {
  this.route('articles', { path: '/articles' }, function() {
    this.route('new');
  });
});

export default Router;
import Ember from 'ember';

export default Ember.Route.extend({
  actions: {
    transitionToNewArticle() {
      this.transitionTo('articles.new');
    }
  }
});

Multiple Models Example

// ...

Router.map(function() {
  this.route('index');

  this.route('breakfast', { path: ':breakfastId' }, function() {
    this.route('cereal', { path: ':cerealId' });
  });
});

export default Router;
import Ember from 'ember';

export default Ember.Route.extend({
  actions: {
    moveToChocolateCereal() {
      let cereal = { cerealId: 'ChocolateYumminess' };
      let breakfast = { breakfastId: 'CerealAndMilk' };

      this.transitionTo('breakfast.cereal', breakfast, cereal);
    }
  }
});

Nested Route with Query String Example

// ...

Router.map(function() {
  this.route('fruits', function() {
    this.route('apples');
  });
});

export default Router;
import Ember from 'ember';

export default Ember.Route.extend({
  actions: {
    transitionToApples() {
      this.transitionTo('fruits.apples', { queryParams: { color: 'red' } });
    }
  }
});

trigger (name, args) public

name
String
The name of the event
args
Object...
Optional arguments to pass on

Triggers a named event for the object. Any additional arguments will be passed as parameters to the functions that are subscribed to the event.

person.on('didEat', function(food) {
  console.log('person ate some ' + food);
});

person.trigger('didEat', 'broccoli');

// outputs: person ate some broccoli

willDestroy public

Override to implement teardown.

© 2017 Yehuda Katz, Tom Dale and Ember.js contributors
Licensed under the MIT License.
https://emberjs.com/api/ember/2.14/classes/Ember.Route/methods