Shim that adds support for routable components to Ember
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
addon
app/initializers
config
tests
vendor
.bowerrc
.editorconfig
.ember-cli
.gitignore
.jshintrc
.npmignore
.travis.yml
.watchmanconfig
LICENSE.md
README.md
bower.json
ember-cli-build.js
index.js
package.json
testem.js

README.md

ember-routable-components-shim

Build Status Ember Observer Score

This addon adds support for routable components to Ember.js.

Controllers can be replaced with routable components. Routable components do not retain state between transitions. The route's model attribute is available to the component, and actions not handled by the component will bubble up to the route.

Supports Ember.js version 2.7 and greater. If you need support for 2.6 and below, use v0.0.2 (see instructions on that tag).

Installation

ember install ember-routable-components-shim

Usage

Create your routable component (instead of a controller):

// components/post.js
import Ember from 'ember';

export default Ember.Component.extend({
  componentProperty: 'componentValue'
});
{{!-- templates/components/post.hbs --}}
Model property: {{model.modelProperty}}<br/>
Component property: {{componentProperty}}

Create a route:

// routes/post.js
import Ember from 'ember';

export default Ember.Route.extend({
  model: function () {
    return {
      modelProperty: 'modelValue'
    };
  }
});

Add the route to router.js as normal:

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

Visiting /post should now render your routable component.

Query params

If you wish to pass query params to your route, you can add a controller which defines those query params. You can then access them from the params argument passed to the route's model function.

// controllers/post.js
import Ember from 'ember';

export default Ember.Controller.extend({
  queryParams: ['sort'],
  sort: null
});

Usage with pods

If you use pods, you can keep each route and routable component/template in the same directory. Use the resolver included in this addon instead of the default:

// resolver.js
import Resolver from 'ember-routable-components-shim/resolver';

export default Resolver;

Create your route and routable component:

// pods/components/post/route.js
import Ember from 'ember';

export default Ember.Route.extend({
  model: function () {
    return {
      modelProperty: 'modelValue'
    };
  }
});
// pods/components/post/component.js
import Ember from 'ember';

export default Ember.Component.extend({
  componentProperty: 'componentValue'
});
{{!-- pods/components/post/template.hbs --}}
Model property: {{model.modelProperty}}<br/>
Component property: {{componentProperty}}

Add the route to router.js:

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

Visiting /post should now render your routable component.