RouterService - 3.13 - Ember API Documentation

addObserver (key, target, method, sync) Observable public

Module: @ember/routing

Inherited from Observable packages/@ember/-internals/runtime/lib/mixins/observable.js:286

key: String; The key to observe
target: Object; The target object to invoke
method: String|Function; The method to invoke
sync: Boolean; Whether the observer is sync or not
returns: Observable

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.

There are two common invocation patterns for .addObserver():

Passing two arguments:
- the name of the property to observe (as a string)
- the function to invoke (an actual function)
Passing three arguments:
- the name of the property to observe (as a string)
- the target object (will be used to look up and invoke a function on)
- the name of the function to invoke on the target object (as a string).

        
              component.js
            
              import Component from '@ember/component';

export default Component.extend({
  init() {
    this._super(...arguments);

    // the following are equivalent:

    // using three arguments
    this.addObserver('foo', this, 'fooDidChange');

    // using two arguments
    this.addObserver('foo', (...args) => {
      this.fooDidChange(...args);
    });
  },

  fooDidChange() {
    // your custom logic code
  }
});

component.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21	import Component from '@ember/component'; export default Component.extend({ init() { this._super(...arguments); // the following are equivalent: // using three arguments this.addObserver('foo', this, 'fooDidChange'); // using two arguments this.addObserver('foo', (...args) => { this.fooDidChange(...args); }); }, fooDidChange() { // your custom logic code } });

Observer Methods

Observer methods have the following signature:

        
              component.js
            
              import Component from '@ember/component';

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

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

component.js
1 2 3 4 5 6 7 8 9 10 11 12	import Component from '@ember/component'; export default 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.

cacheFor (keyName) Object public

Module: @ember/routing

Inherited from Observable packages/@ember/-internals/runtime/lib/mixins/observable.js:486

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.

decrementProperty (keyName, decrement) Number public

Module: @ember/routing

Inherited from Observable packages/@ember/-internals/runtime/lib/mixins/observable.js:447

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 EmberObject public

Module: @ember/routing

Inherited from CoreObject packages/@ember/-internals/runtime/lib/system/core_object.js:546

returns: EmberObject; 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.

get (keyName) Object public

Module: @ember/routing

Inherited from Observable packages/@ember/-internals/runtime/lib/mixins/observable.js:93

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:

        
              import { computed } from '@ember/object';

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

Module: @ember/routing

Inherited from Observable packages/@ember/-internals/runtime/lib/mixins/observable.js:138

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

Module: @ember/routing

Inherited from Observable packages/@ember/-internals/runtime/lib/mixins/observable.js:407

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');

incrementProperty (keyName, increment) Number public

Module: @ember/routing

Inherited from Observable packages/@ember/-internals/runtime/lib/mixins/observable.js:425

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

Module: @ember/routing

Inherited from CoreObject packages/@ember/-internals/runtime/lib/system/core_object.js:328

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

Example:

        
              import EmberObject from '@ember/object';

const Person = EmberObject.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.

isActive (routeName, models, options) Boolean public

Module: @ember/routing

Defined in packages/@ember/-internals/routing/lib/services/router.ts:241

routeName: String; the name of the route
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: Boolean; true if the provided routeName/models/queryParams are active

Determines whether a route is active.

notifyPropertyChange (keyName) Observable public

Module: @ember/routing

Inherited from Observable packages/@ember/-internals/runtime/lib/mixins/observable.js:268

keyName: String; The property key to be notified about.
returns: 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 instead. Calling this method will notify all observers that the property has potentially changed value.

recognize (url) public

Module: @ember/routing

Defined in packages/@ember/-internals/routing/lib/services/router.ts:275

url: String

Takes a string URL and returns a RouteInfo for the leafmost route represented by the URL. Returns null if the URL is not recognized. This method expects to receive the actual URL as seen by the browser including the app's rootURL.

See RouteInfo for more info.

In the following example recognize is used to verify if a path belongs to our application before transitioning to it.

        
              import Component from '@ember/component';
import { inject as service } from '@ember/service';

export default Component.extend({
  router: service(),
  path: '/',

  click() {
    if(this.router.recognize(this.path)) {
      this.router.transitionTo(this.path);
    }
  }
});

recognizeAndLoad (url) public

Module: @ember/routing

Defined in packages/@ember/-internals/routing/lib/services/router.ts:314

url: String

Takes a string URL and returns a promise that resolves to a RouteInfoWithAttributes for the leafmost route represented by the URL. The promise rejects if the URL is not recognized or an unhandled exception is encountered. This method expects to receive the actual URL as seen by the browser including the app's rootURL.

removeObserver (key, target, method, sync) Observable public

Module: @ember/routing

Inherited from Observable packages/@ember/-internals/runtime/lib/mixins/observable.js:374

key: String; The key to observe
target: Object; The target object to invoke
method: String|Function; The method to invoke
sync: Boolean; Whether the observer is async or not
returns: Observable

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.

replaceWith (routeNameOrUrl, models, options) Transition public

Module: @ember/routing

Defined in packages/@ember/-internals/routing/lib/services/router.ts:134

routeNameOrUrl: 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. The route may be either a single route or route path:

See replaceWith for more info.

Calling replaceWith from the Router service will cause default query parameter values to be included in the URL. This behavior is different from calling replaceWith on a route. See the Router Service RFC for more info.

Usage example:

        
              app/routes/application.js
            
              import Route from '@ember/routing/route';

export default Route.extend({
  beforeModel() {
    if (!authorized()){
      this.replaceWith('unauthorized');
    }
  }
});

app/routes/application.js
1 2 3 4 5 6 7 8 9	import Route from '@ember/routing/route'; export default Route.extend({ beforeModel() { if (!authorized()){ this.replaceWith('unauthorized'); } } });

set (keyName, value) Object public

Module: @ember/routing

Inherited from Observable packages/@ember/-internals/runtime/lib/mixins/observable.js:163

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

Module: @ember/routing

Inherited from Observable packages/@ember/-internals/runtime/lib/mixins/observable.js:211

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' });

toString String public

Module: @ember/routing

Inherited from CoreObject packages/@ember/-internals/runtime/lib/system/core_object.js:597

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.

        
              import EmberObject from '@ember/object';

const Person = EmberObject.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

Module: @ember/routing

Inherited from Observable packages/@ember/-internals/runtime/lib/mixins/observable.js:469

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 (routeNameOrUrl, models, options) Transition public

Module: @ember/routing

Defined in packages/@ember/-internals/routing/lib/services/router.ts:83

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

See transitionTo for more info.

Calling transitionTo from the Router service will cause default query parameter values to be included in the URL. This behavior is different from calling transitionTo on a route or transitionToRoute on a controller. See the Router Service RFC for more info.

In the following example we use the Router service to navigate to a route with a specific model from a Component.

        
              import Component from '@ember/component';
import { inject as service } from '@ember/service';

export default Component.extend({
  router: service(),

  actions: {
    goToComments(post) {
      this.router.transitionTo('comments', post);
    }
  }
});

urlFor (routeName, models, options) String public

Module: @ember/routing

Defined in packages/@ember/-internals/routing/lib/services/router.ts:172

routeName: String; the name of the route
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: String; the string representing the generated URL

Generate a URL based on the supplied route name and optionally a model. The URL is returned as a string that can be used for any purpose.

In this example, the URL for the author.books route for a given author is copied to the clipboard.

        
              link.js
            
              import Component from '@ember/component';
import {inject as service} from '@ember/service';

export default Component.extend({
  router: service('router'),
  clipboard: service('clipboard')

  // Provided in the template
  // { id: 'tomster', name: 'Tomster' }
  author: null,

  copyBooksURL() {
    if (this.author) {
      const url = this.router.urlFor('author.books', this.author);
      this.clipboard.set(url);
      // Clipboard now has /author/tomster/books
    }
  }
});

link.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19	import Component from '@ember/component'; import {inject as service} from '@ember/service'; export default Component.extend({ router: service('router'), clipboard: service('clipboard') // Provided in the template // { id: 'tomster', name: 'Tomster' } author: null, copyBooksURL() { if (this.author) { const url = this.router.urlFor('author.books', this.author); this.clipboard.set(url); // Clipboard now has /author/tomster/books } } });

Just like with transitionTo and replaceWith, urlFor can also handle query parameters.

        
          
              link.js
            

          
              
              import Component from '@ember/component';
import {inject as service} from '@ember/service';

export default Component.extend({
  router: service('router'),
  clipboard: service('clipboard')

  // Provided in the template
  // { id: 'tomster', name: 'Tomster' }
  author: null,

  copyOnlyEmberBooksURL() {
    if (this.author) {
      const url = this.router.urlFor('author.books', this.author, {
        queryParams: { filter: 'emberjs' }
      });
      this.clipboard.set(url);
      // Clipboard now has /author/tomster/books?filter=emberjs
    }
  }
});
            

        
      

link.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21	import Component from '@ember/component'; import {inject as service} from '@ember/service'; export default Component.extend({ router: service('router'), clipboard: service('clipboard') // Provided in the template // { id: 'tomster', name: 'Tomster' } author: null, copyOnlyEmberBooksURL() { if (this.author) { const url = this.router.urlFor('author.books', this.author, { queryParams: { filter: 'emberjs' } }); this.clipboard.set(url); // Clipboard now has /author/tomster/books?filter=emberjs } } });

willDestroy public

Module: @ember/routing

Inherited from CoreObject packages/@ember/-internals/runtime/lib/system/core_object.js:574

Override to implement teardown.

Class RouterService

addObserver (key, target, method, sync) Observable public

Observer Methods

cacheFor (keyName) Object public

decrementProperty (keyName, decrement) Number public

destroy EmberObject public

get (keyName) Object public

Computed Properties

Unknown Properties

getProperties (list) Object public

getWithDefault (keyName, defaultValue) Object public

incrementProperty (keyName, increment) Number public

init public

isActive (routeName, models, options) Boolean public

notifyPropertyChange (keyName) Observable public

recognize (url) public

recognizeAndLoad (url) public

removeObserver (key, target, method, sync) Observable public

replaceWith (routeNameOrUrl, models, options) Transition public

set (keyName, value) Object public

Computed Properties

Unknown Properties

Property Observers

setProperties (hash) Object public

toString String public

toggleProperty (keyName) Boolean public

transitionTo (routeNameOrUrl, models, options) Transition public

urlFor (routeName, models, options) String public

willDestroy public