Ember.Route Class packages/ember-routing/lib/system/route.js:34


The Ember.Route class is used to define individual routes. Refer to the routing guide for documentation.

Show:

_reset

private
Defined in packages/ember-routing/lib/system/route.js:329
Available since 1.7.0

_scheduledDestroy

private

Invoked by the run loop to actually destroy the object. This is scheduled for execution by the destroy method.

_stashNames

private

_updatingQPChanged

private

activate

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)

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.

You can also pass an optional context parameter to this method. The context will be passed to your observer method whenever it is triggered. Note that if you add the same target/method pair on a key multiple times with different context parameters, your observer will only be called once with the last context you passed.

Observer Methods

Observer methods you pass should generally have the following signature if you do not pass a context parameter:

1
fooDidChange: function(sender, key, value, rev) { };

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.

If you pass a context parameter, the context will be passed before the revision like so:

1
fooDidChange: function(sender, key, value, context, rev) { };

Usually you will not need the value, context 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.

Parameters:

key String
The key to observer
target Object
The target object to invoke
method String|Function
The method to invoke.

afterModel

(resolvedModel, transition, queryParams) Promise

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.

1
2
3
4
5
6
7
App.PostsRoute = Ember.Route.extend({
  afterModel: function(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.

Parameters:

resolvedModel Object
the value returned from `model`, or its resolved value if it was a promise
transition Transition
queryParams Object
the active query params for this handler

Returns:

Promise
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.

beforeModel

(transition, queryParams) Promise

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.

1
2
3
4
5
6
7
App.PostRoute = Ember.Route.extend({
  beforeModel: function(transition) {
    if (!App.Post) {
      return Ember.$.getScript('/models/post.js');
    }
  }
});

If App.Post doesn't exist in the above example, beforeModel will use jQuery's getScript, which returns a promise that resolves after the server has successfully retrieved and executed the code from the server. Note that if an error were to occur, it would be passed to the error hook on Ember.Route, but it's also possible to handle errors specific to beforeModel right from within the hook (to distinguish from the shared error handling behavior of the error hook):

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
App.PostRoute = Ember.Route.extend({
  beforeModel: function(transition) {
    if (!App.Post) {
      var self = this;
      return Ember.$.getScript('post.js').then(null, function(e) {
        self.transitionTo('help');

        // Note that the above transitionTo will implicitly
        // halt the transition. If you were to return
        // nothing from this promise reject handler,
        // according to promise semantics, that would
        // convert the reject into a resolve and the
        // transition would continue. To propagate the
        // error so that it'd be handled by the `error`
        // hook, you would have to either
        return Ember.RSVP.reject(e);
      });
    }
  }
});

Parameters:

transition Transition
queryParams Object
the active query params for this route

Returns:

Promise
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.

beginPropertyChanges

Ember.Observable

Begins a grouping of property changes.

You can use this method to group property changes so that notifications will not be sent until the changes are finished. If you plan to make a large number of changes to an object at one time, you should call this method at the beginning of the changes to begin deferring change notifications. When you are done making changes, call endPropertyChanges() to deliver the deferred change notifications and end deferring.

Returns:

Ember.Observable

cacheFor

(keyName) Object

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.

Parameters:

keyName String

Returns:

Object
The cached value of the computed property, if any

contextDidChange

private

Called when the context is changed by router.js.

controllerFor

(name) Ember.Controller

Returns the controller for a particular route or name.

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

1
2
3
4
5
6
App.PostRoute = Ember.Route.extend({
  setupController: function(controller, post) {
    this._super(controller, post);
    this.controllerFor('posts').set('currentPost', post);
  }
});

Parameters:

name String
the name of the route or controller

Returns:

Ember.Controller

create

(arguments) static

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

1
2
3
4
5
6
7
8
9
10
11
App.Person = Ember.Object.extend({
  helloWorld: function() {
    alert("Hi, my name is " + this.get('name'));
  }
});

var tom = App.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:

1
2
var noName = App.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 or use the createWithMixins shorthand.

Parameters:

arguments []

createWithMixins

(arguments) static

Equivalent to doing extend(arguments).create(). If possible use the normal create method instead.

Parameters:

arguments []

deactivate

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

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

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

Parameters:

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

deserialize

(params, transition) Object|Promise private

Parameters:

params Object
the parameters extracted from the URL
transition Transition

Returns:

Object|Promise
the model for this route. Router.js hook.

deserializeQueryParam

destroy

Ember.Object

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.

Returns:

Ember.Object
receiver

disconnectOutlet

(options)

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:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
App.ApplicationRoute = App.Route.extend({
  actions: {
    showModal: function(evt) {
      this.render(evt.modalName, {
        outlet: 'modal',
        into: 'application'
      });
    },
    hideModal: function(evt) {
      this.disconnectOutlet({
        outlet: 'modal',
        parentView: 'application'
      });
    }
  }
});

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

Example:

1
2
3
hideModal: function(evt) {
  this.disconnectOutlet('modal');
}

Parameters:

options Object|String
the options hash or outlet name

eachComputedProperty

(callback, binding)

Iterate over each computed property for the class, passing its name and any associated metadata (see metaForProperty) to the callback.

Parameters:

callback Function
binding Object

endPropertyChanges

Ember.Observable

Ends a grouping of property changes.

You can use this method to group property changes so that notifications will not be sent until the changes are finished. If you plan to make a large number of changes to an object at one time, you should call beginPropertyChanges() at the beginning of the changes to defer change notifications. When you are done making changes, call this method to deliver the deferred change notifications and end deferring.

Returns:

Ember.Observable

enter

private

events

deprecated

Please use actions instead.

exit

private

extend

(mixins, arguments) static

Creates a new subclass.

1
2
3
4
5
App.Person = Ember.Object.extend({
  say: function(thing) {
    alert(thing);
   }
});

This defines a new subclass of Ember.Object: App.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.View class:

1
2
3
4
App.PersonView = Ember.View.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:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
App.Person = Ember.Object.extend({
  say: function(thing) {
    var name = this.get('name');
    alert(name + ' says: ' + thing);
  }
});

App.Soldier = App.Person.extend({
  say: function(thing) {
    this._super(thing + ", sir!");
  },
  march: function(numberOfHours) {
    alert(this.get('name') + ' marches for ' + numberOfHours + ' hours.')
  }
});

var yehuda = App.Soldier.create({
  name: "Yehuda Katz"
});

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

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
App.Person = Ember.Object.extend({
  say: function(thing) {
    alert(this.get('name') + ' says: ' + thing);
  }
});

App.SingingMixin = Mixin.create({
  sing: function(thing){
    alert(this.get('name') + ' sings: la la la ' + thing);
  }
});

App.BroadwayStar = App.Person.extend(App.SingingMixin, {
  dance: function() {
    alert(this.get('name') + ' dances: tap tap tap tap ');
  }
});

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

Parameters:

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

findModel

(type, value)

Parameters:

type String
the model type
value Object
the value passed to find

generateController

(name, model)

Generates a controller for a route.

If the optional model is passed then the controller type is determined automatically, e.g., an ArrayController for arrays.

Example

1
2
3
4
5
6
App.PostRoute = Ember.Route.extend({
  setupController: function(controller, post) {
    this._super(controller, post);
    this.generateController('posts', post);
  }
});

Parameters:

name String
the name of the controller
model Object
the model to infer the type of the controller (optional)

get

(keyName) Object

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:

1
2
3
fullName: function() {
  return this.get('firstName') + ' ' + this.get('lastName');
}.property('firstName', '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.

Parameters:

keyName String
The property to retrieve

Returns:

Object
The property value or undefined.

getProperties

(list) Hash

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

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

is equivalent to:

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

Parameters:

list String...|Array
of keys to get

Returns:

Hash

getWithDefault

(keyName, defaultValue) Object

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

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

Parameters:

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.

hasObserverFor

(key) Boolean

Returns true if the object currently has observers registered for a particular key. You can use this method to potentially defer performing an expensive action until someone begins observing a particular property on the object.

Parameters:

key String
Key to check

Returns:

Boolean

incrementProperty

(keyName, increment) Number

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

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

Parameters:

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

init

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

Example:

1
2
3
4
5
6
7
8
9
10
11
App.Person = Ember.Object.extend({
  init: function() {
    alert('Name is ' + this.get('name'));
  }
});

var steve = App.Person.create({
  name: "Steve"
});

// alerts 'Name is Steve'.

NOTE: If you do override init for a framework class like Ember.View or Ember.ArrayController, be sure to call this._super() 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)
Defined in packages/ember-routing/lib/system/route.js:839
Available since 1.2.0

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.

Parameters:

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

metaForProperty

(key)

In some cases, you may want to annotate computed properties with additional metadata about how they function or what values they operate on. For example, computed property functions may close over variables that are then no longer available for introspection.

You can pass a hash of these values to a computed property like this:

1
2
3
4
person: function() {
  var personId = this.get('personId');
  return App.Person.create({ id: personId });
}.property().meta({ type: App.Person })

Once you've done this, you can retrieve the values saved to the computed property from your class like this:

1
MyClass.metaForProperty('person');

This will return the original hash that was passed to meta().

Parameters:

key String
property name

model

(params, transition, queryParams) Object|Promise

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

1
2
3
App.Router.map(function() {
  this.resource('post', {path: '/posts/:post_id'});
});

The model for the post route is App.Post.find(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.

1
2
3
4
5
6
7
8
9
// no dynamic segment, model hook always called
this.transitionTo('posts');

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

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

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

1
2
3
4
5
App.PostRoute = Ember.Route.extend({
  model: function(params) {
    return App.Post.find(params.post_id);
  }
});

Parameters:

params Object
the parameters extracted from the URL
transition Transition
queryParams Object
the query params for this route

Returns:

Object|Promise
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.

modelFor

(name) Object

Returns the 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.

Example

1
2
3
4
5
6
7
8
9
10
11
App.Router.map(function() {
    this.resource('post', { path: '/post/:post_id' }, function() {
        this.resource('comments');
    });
});

App.CommentsRoute = Ember.Route.extend({
    afterModel: function() {
        this.set('post', this.modelFor('post'));
    }
});

Parameters:

name String
the name of the route

Returns:

Object
the model object

notifyPropertyChange

(keyName) Ember.Observable

Convenience method to call propertyWillChange and propertyDidChange in succession.

Parameters:

keyName String
The property key to be notified about.

Returns:

Ember.Observable

paramsFor

propertyDidChange

(keyName) Ember.Observable

Notify the observer system that a property has just changed.

Sometimes you need to change a value directly or indirectly without actually calling get() or set() on it. In this case, you can use this method and propertyWillChange() instead. Calling these two methods together will notify all observers that the property has potentially changed value.

Note that you must always call propertyWillChange and propertyDidChange as a pair. If you do not, it may get the property change groups out of order and cause notifications to be delivered more often than you would like.

Parameters:

keyName String
The property key that has just changed.

Returns:

Ember.Observable

propertyWillChange

(keyName) Ember.Observable

Notify the observer system that a property is about to change.

Sometimes you need to change a value directly or indirectly without actually calling get() or set() on it. In this case, you can use this method and propertyDidChange() instead. Calling these two methods together will notify all observers that the property has potentially changed value.

Note that you must always call propertyWillChange and propertyDidChange as a pair. If you do not, it may get the property change groups out of order and cause notifications to be delivered more often than you would like.

Parameters:

keyName String
The property key that is about to change.

Returns:

Ember.Observable

redirect

(model, 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.

Parameters:

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

refresh

Transition
Defined in packages/ember-routing/lib/system/route.js:860
Available since 1.4.0

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.

Returns:

Transition
the transition object associated with this attempted transition

removeObserver

(key, target, method)

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.

Parameters:

key String
The key to observer
target Object
The target object to invoke
method String|Function
The method to invoke.

render

(name, 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:

1
2
3
Router.map(function() {
  this.resource('photos');
});
1
2
3
4
<!-- application.hbs -->
<div class='something-in-the-app-hbs'>
  {{outlet "anOutletName"}}
</div>
1
2
<!-- photos.hbs -->
<h1>Photos</h1>

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

1
2
3
4
5
6
7
8
9
// posts route
Ember.Route.extend({
  renderTemplate: function(){
    this.render('posts', {
      into: 'application',
      outlet: 'anOutletName'
    })
  }
});

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

1
2
3
4
5
6
7
8
9
10
11
12
// posts route
Ember.Route.extend({
  renderTemplate: function(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.
      view: 'aViewName',      // the view to use for this template, referenced by name
      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, view, 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.

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, viewName and and templateName properties.

For example:

1
2
3
4
5
// router
Router.map(function() {
  this.route('index');
  this.resource('post', {path: '/posts/:post_id'});
});
1
2
3
4
5
6
// post route
PostRoute = App.Route.extend({
  renderTemplate: function() {
    this.render(); // all defaults apply
  }
});

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

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

1
2
3
4
5
6
7
//
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}},
  view: 'post',        // the view associated with the 'post' Route
  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.

Parameters:

name String
the name of the template to render
options [Object]
the options
into [String]
the template to render into, referenced by name. Defaults to the parent template
outlet [String]
the outlet inside `options.template` to render into. Defaults to 'main'
controller [String]
the controller to use for this template, referenced by name. Defaults to the Route's paired controller
model [String]
the model object to set on `options.controller` Defaults to the return value of the Route's model hook

renderTemplate

(controller, 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.

1
2
3
4
5
6
7
8
9
10
11
12
13
App.PostsRoute = Ember.Route.extend({
  renderTemplate: function(controller, model) {
    var favController = this.controllerFor('favoritePost');

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

Parameters:

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

reopen

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
MyObject = Ember.Object.extend({
  name: 'an object'
});

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

MyObject.reopen({
  say: function(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

Augments a constructor's own properties and functions:

1
2
3
4
5
6
7
8
9
10
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.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
App.Person = Ember.Object.extend({
  name : "",
  sayHello : function(){
    alert("Hello. My name is " + this.get('name'));
  }
});

App.Person.reopenClass({
  species : "Homo sapiens",
  createPerson: function(newPersonsName){
    return App.Person.create({
      name:newPersonsName
    });
  }
});

var tom = App.Person.create({
  name : "Tom Dale"
});
var yehuda = App.Person.createPerson("Yehuda Katz");

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

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

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

replaceWith

(name, models) 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

1
2
3
4
5
6
7
8
9
10
11
12
App.Router.map(function() {
  this.route("index");
  this.route("secret");
});

App.SecretRoute = Ember.Route.extend({
  afterModel: function() {
    if (!authorized()){
      this.replaceWith('index');
    }
  }
});

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.

Returns:

Transition
the transition object associated with this attempted transition

resetController

(controller, isExiting, transition)
Defined in packages/ember-routing/lib/system/route.js:295
Available since 1.7.0

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

1
2
3
4
5
6
7
8
9
App.ArticlesRoute = Ember.Route.extend({
  // ...

  resetController: function (controller, isExiting, transition) {
    if (isExiting) {
      controller.set('page', 1);
    }
  }
});

Parameters:

controller Controller
instance
isExiting Boolean
transition Object

send

(name, 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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
App.Router.map(function() {
  this.route("index");
});

App.ApplicationRoute = Ember.Route.extend({
  actions: {
    track: function(arg) {
      console.log(arg, 'was clicked');
    }
  }
});

App.IndexRoute = Ember.Route.extend({
  actions: {
    trackIfDebug: function(arg) {
      if (debug) {
        this.send('track', arg);
      }
    }
  }
});

Parameters:

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

serialize

(model, params) Object

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
App.Router.map(function() {
  this.resource('post', {path: '/posts/:post_id'});
});

App.PostRoute = Ember.Route.extend({
  model: function(params) {
    // the server returns `{ id: 12 }`
    return jQuery.getJSON("/posts/" + params.post_id);
  },

  serialize: function(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.

Parameters:

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

Returns:

Object
the serialized parameters

serializeQueryParam

serializeQueryParamKey

set

(keyName, value) Ember.Observable

Sets the provided key or path to the 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.

Chaining

In addition to property changes, set() returns the value of the object itself so you can do chaining like this:

1
record.set('firstName', 'Charles').set('lastName', 'Jolley');

Parameters:

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

Returns:

Ember.Observable

setProperties

(hash) Ember.Observable

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

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

Parameters:

hash Hash
the hash of keys and values to set

Returns:

Ember.Observable

setup

private

This hook is the entry point for router.js

setupController

(controller, model)

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:

1
2
3
4
5
6
7
8
9
10
11
12
App.PhotosRoute = Ember.Route.extend({
  model: function() {
    return App.Photo.find();
  },

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

This means that your template will get a proxy for the model as its context, and you can act as though the model itself was the context.

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

If no explicit controller is defined, Ember will automatically create an appropriate controller for the model.

  • if the model is an Ember.Array (including record arrays from Ember Data), the controller is an Ember.ArrayController.
  • otherwise, the controller is an Ember.ObjectController.

As an example, consider the router:

1
2
3
App.Router.map(function() {
  this.resource('post', {path: '/posts/:post_id'});
});

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

Example

1
2
3
4
5
App.PostRoute = Ember.Route.extend({
  setupController: function(controller, model) {
    controller.set('model', model);
  }
});

Parameters:

controller Controller
instance
model Object

store

(store)

Store property provides a hook for data persistence libraries to inject themselves.

By default, this store property provides the exact same functionality previously in the model hook.

Currently, the required interface is:

store.find(modelName, findArguments)

Parameters:

store Object

teardownViews

private

toString

String

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

1
2
3
App.Person = Em.Object.extend()
person = App.Person.create()
person.toString() //=> "<App.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:

1
2
3
Student = App.Person.extend()
student = Student.create()
student.toString() //=> "<(subclass of App.Person):ember1025>"

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

1
2
3
4
5
6
7
App.Teacher = App.Person.extend({
  toStringExtension: function() {
    return this.get('fullName');
  }
});
teacher = App.Teacher.create()
teacher.toString(); //=> "<App.Teacher:ember1026:Tom Dale>"

Returns:

String
string representation

toggleProperty

(keyName) Object

Set the value of a boolean property to the opposite of it's current value.

1
starship.toggleProperty('warpDriveEngaged');

Parameters:

keyName String
The name of the property to toggle

Returns:

Object
The new property value

transitionTo

(name, models) Transition

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

1
2
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:

1
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:

1
this.transitionTo('blogPost', 1);

Multiple models will be applied last to first recursively up the resource tree.

1
2
3
4
5
6
7
8
App.Router.map(function() {
  this.resource('blogPost', {path:':blogPostId'}, function(){
    this.resource('blogComment', {path: ':blogCommentId'});
  });
});

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.

1
2
this.transitionTo('/');
this.transitionTo('/blog/post/1/comment/13');

See also 'replaceWith'.

Simple Transition Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
App.Router.map(function() {
  this.route("index");
  this.route("secret");
  this.route("fourOhFour", { path: "*:"});
});

App.IndexRoute = Ember.Route.extend({
  actions: {
    moveToSecret: function(context){
      if (authorized()){
        this.transitionTo('secret', context);
      }
        this.transitionTo('fourOhFour');
    }
  }
});

Transition to a nested route

1
2
3
4
5
6
7
8
9
10
11
12
13
App.Router.map(function() {
  this.resource('articles', { path: '/articles' }, function() {
    this.route('new');
  });
});

App.IndexRoute = Ember.Route.extend({
  actions: {
    transitionToNewArticle: function() {
      this.transitionTo('articles.new');
    }
  }
});

Multiple Models Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
App.Router.map(function() {
  this.route("index");
  this.resource('breakfast', {path:':breakfastId'}, function(){
    this.resource('cereal', {path: ':cerealId'});
  });
});

App.IndexRoute = Ember.Route.extend({
  actions: {
    moveToChocolateCereal: function(){
      var cereal = { cerealId: "ChocolateYumminess"},
          breakfast = {breakfastId: "CerealAndMilk"};

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

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.

Returns:

Transition
the transition object associated with this attempted transition

willDestroy

Override to implement teardown.

willMergeMixin

private

Moves actions to _actions at extend time. Note that this currently modifies the mixin themselves, which is technically dubious but is practically of little consequence. This may change in the future.

Show:

_activeQPChanged

private

_fireQueryParamTransition

private

_names

private

_qp

private

_updateSerializedQPValue

private

actions

Hash

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.:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
App.CanDisplayBanner = Ember.Mixin.create({
  actions: {
    displayBanner: function(msg) {
      // ...
    }
  }
});

App.WelcomeRoute = Ember.Route.extend(App.CanDisplayBanner, {
  actions: {
    playMusic: function() {
      // ...
    }
  }
});

// `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, View or Component's action handler, the value of the this context is the Controller, Route, View or Component object:

1
2
3
4
5
6
7
8
9
App.SongRoute = Ember.Route.extend({
  actions: {
    myAction: function() {
      this.controllerFor("song");
      this.transitionTo("other.route");
      ...
    }
  }
});

It is also possible to call this._super() from within an action handler if it overrides a handler defined on a parent class or mixin:

Take for example the following routes:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
App.DebugRoute = Ember.Mixin.create({
  actions: {
    debugRouteInformation: function() {
      console.debug("trololo");
    }
  }
});

App.AnnoyingDebugRoute = Ember.Route.extend(App.DebugRoute, {
  actions: {
    debugRouteInformation: function() {
      // also call the debugRouteInformation of mixed in App.DebugRoute
      this._super();

      // 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:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
App.Router.map(function() {
  this.resource("album", function() {
    this.route("song");
  });
});

App.AlbumRoute = Ember.Route.extend({
  actions: {
    startPlaying: function() {
    }
  }
});

App.AlbumSongRoute = Ember.Route.extend({
  actions: {
    startPlaying: function() {
      // ...

      if (actionShouldAlsoBeTriggeredOnParentRoute) {
        return true;
      }
    }
  }
});

Default: null

concatenatedProperties

Array

Defines the properties that will be concatenated from the superclass (instead of overridden).

By default, when you extend an Ember class a property defined in the subclass overrides a property with the same name that is defined in the superclass. However, there are some cases where it is preferable to build up a property's value by combining the superclass' property value with the subclass' value. An example of this in use within Ember is the classNames property of Ember.View.

Here is some sample code showing the difference between a concatenated property and a normal one:

1
2
3
4
5
6
7
8
9
10
11
12
13
App.BarView = Ember.View.extend({
  someNonConcatenatedProperty: ['bar'],
  classNames: ['bar']
});

App.FooBarView = App.BarView.extend({
  someNonConcatenatedProperty: ['foo'],
  classNames: ['foo']
});

var fooBarView = App.FooBarView.create();
fooBarView.get('someNonConcatenatedProperty'); // ['foo']
fooBarView.get('classNames'); // ['ember-view', 'bar', 'foo']

This behavior extends to object creation as well. Continuing the above example:

1
2
3
4
5
6
var view = App.FooBarView.create({
  someNonConcatenatedProperty: ['baz'],
  classNames: ['baz']
})
view.get('someNonConcatenatedProperty'); // ['baz']
view.get('classNames'); // ['ember-view', 'bar', 'foo', 'baz']

Adding a single property that is not an array will just add it in the array:

1
2
3
4
var view = App.FooBarView.create({
  classNames: 'baz'
})
view.get('classNames'); // ['ember-view', 'bar', 'foo', 'baz']

Using the concatenatedProperties property, we can tell to Ember that mix the content of the properties.

In Ember.View the classNameBindings and attributeBindings properties are also concatenated, in addition to classNames.

This feature is available for you to use throughout the Ember object model, although typical app developers are likely to use it infrequently. Since it changes expectations about behavior of properties, you should properly document its usage in each individual concatenated property (to not mislead your users to think they can override the property in a subclass).

Default: null

controller

Ember.Controller
Defined in packages/ember-routing/lib/system/route.js:565
Available since 1.6.0

The controller associated with this route.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
App.FormRoute = Ember.Route.extend({
  actions: {
    willTransition: function(transition) {
      if (this.controller.get('userHasEnteredData') &&
          !confirm("Are you sure you want to abandon progress?")) {
        transition.abort();
      } else {
        // Bubble the `willTransition` action so that
        // parent routes can decide whether or not to abort.
        return true;
      }
    }
  }
});

controllerName

String
Defined in packages/ember-routing/lib/system/route.js:402
Available since 1.4.0

The name of the controller to associate with this route.

By default, Ember will lookup a route's controller that matches the name of the route (i.e. App.PostController for App.PostRoute). However, if you would like to define a specific controller to use, you can do so using this property.

This is useful in many ways, as the controller specified will be:

  • passed to the setupController method.
  • used as the controller for the view being rendered by the route.
  • returned from a call to controllerFor for the route.

Default: null

isDestroyed

Destroyed object property flag.

if this property is true the observers and bindings were already removed by the effect of calling the destroy() method.

Default: false

isDestroying

Destruction scheduled flag. The destroy() method has been called.

The object stays intact until the end of the run loop at which point the isDestroyed flag is set.

Default: false

queryParams

Hash

Configuration hash for this route's queryParams. The possible configuration options and their defaults are as follows (assuming a query param whose URL key is page):

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
queryParams: {
  page: {
    // By default, controller query param properties don't
    // cause a full transition when they are changed, but
    // rather only cause the URL to update. Setting
    // `refreshModel` to true will cause an "in-place"
    // transition to occur, whereby the model hooks for
    // this route (and any child routes) will re-fire, allowing
    // you to reload models (e.g., from the server) using the
    // updated query param values.
    refreshModel: false,

    // By default, changes to controller query param properties
    // cause the URL to update via `pushState`, which means an
    // item will be added to the browser's history, allowing
    // you to use the back button to restore the app to the
    // previous state before the query param property was changed.
    // Setting `replace` to true will use `replaceState` (or its
    // hash location equivalent), which causes no browser history
    // item to be added. This options name and default value are
    // the same as the `link-to` helper's `replace` option.
    replace: false
  }
}

templateName

String
Defined in packages/ember-routing/lib/system/route.js:379
Available since 1.4.0

The name of the template to use by default when rendering this routes template.

This is similar with viewName, but is useful when you just want a custom template without a view.

1
2
3
4
5
6
var PostsList = Ember.Route.extend({
  templateName: 'posts/list'
});

App.PostsIndexRoute = PostsList.extend();
App.PostsArchivedRoute = PostsList.extend();

Default: null

viewName

String
Defined in packages/ember-routing/lib/system/route.js:352
Available since 1.4.0

The name of the view to use by default when rendering this routes template.

When rendering a template, the route will, by default, determine the template and view to use from the name of the route itself. If you need to define a specific view, set this property.

This is useful when multiple routes would benefit from using the same view because it doesn't require a custom renderTemplate method. For example, the following routes will all render using the App.PostsListView view:

1
2
3
4
5
6
var PostsList = Ember.Route.extend({
  viewName: 'postsList'
});

App.PostsIndexRoute = PostsList.extend();
App.PostsArchivedRoute = PostsList.extend();

Default: null

Show:

didTransition

Defined in packages/ember-routing/lib/system/route.js:458
Available since 1.2.0

The didTransition action is fired after a transition has successfully been completed. This occurs after the normal model hooks (beforeModel, model, afterModel, setupController) have resolved. The didTransition action has no arguments, however, it can be useful for tracking page views or resetting state on the controller.

1
2
3
4
5
6
7
8
App.LoginRoute = Ember.Route.extend({
  actions: {
    didTransition: function() {
      this.controller.get('errors.base').clear();
      return true; // Bubble the didTransition event
    }
  }
});

error

(error, transition)

When attempting to transition into a route, any of the hooks may return a promise that rejects, at which point an error action will be fired on the partially-entered routes, allowing for per-route error handling logic, or shared error handling logic defined on a parent route.

Here is an example of an error handler that will be invoked for rejected promises from the various hooks on the route, as well as any unhandled errors from child routes:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
App.AdminRoute = Ember.Route.extend({
  beforeModel: function() {
    return Ember.RSVP.reject("bad things!");
  },

  actions: {
    error: function(error, transition) {
      // Assuming we got here due to the error in `beforeModel`,
      // we can expect that error === "bad things!",
      // but a promise model rejecting would also
      // call this hook, as would any errors encountered
      // in `afterModel`.

      // The `error` hook is also provided the failed
      // `transition`, which can be stored and later
      // `.retry()`d if desired.

      this.transitionTo('login');
    }
  }
});

error actions that bubble up all the way to ApplicationRoute will fire a default error handler that logs the error. You can specify your own global default error handler by overriding the error handler on ApplicationRoute:

1
2
3
4
5
6
7
App.ApplicationRoute = Ember.Route.extend({
  actions: {
    error: function(error, transition) {
      this.controllerFor('banner').displayError(error.message);
    }
  }
});

Parameters:

error Error
transition Transition

loading

(transition, route)
Defined in packages/ember-routing/lib/system/route.js:481
Available since 1.2.0

The loading action is fired on the route when a route's model hook returns a promise that is not already resolved. The current Transition object is the first parameter and the route that triggered the loading event is the second parameter.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
App.ApplicationRoute = Ember.Route.extend({
  actions: {
    loading: function(transition, route) {
      var view = Ember.View.create({
        classNames: ['app-loading']
      })
      .append();

      this.router.one('didTransition', function () {
        view.destroy();
      });
      return true; // Bubble the loading event
    }
  }
});

Parameters:

transition Transition
route Ember.Route
The route that triggered the loading event

willTransition

(transition)

The willTransition action is fired at the beginning of any attempted transition with a Transition object as the sole argument. This action can be used for aborting, redirecting, or decorating the transition from the currently active routes.

A good example is preventing navigation when a form is half-filled out:

1
2
3
4
5
6
7
8
9
10
App.ContactFormRoute = Ember.Route.extend({
  actions: {
    willTransition: function(transition) {
      if (this.controller.get('userHasEnteredData')) {
        this.controller.displayNavigationConfirm();
        transition.abort();
      }
    }
  }
});

You can also redirect elsewhere by calling this.transitionTo('elsewhere') from within willTransition. Note that willTransition will not be fired for the redirecting transitionTo, since willTransition doesn't fire when there is already a transition underway. If you want subsequent willTransition actions to fire for the redirecting transition, you must first explicitly call transition.abort().

Parameters:

transition Transition