forked from emberjs/ember.js
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add guide for Route and Controller transition methods deprecation (em…
…berjs#706) * add guide for Route and Controller transition methods deprecation * fix code sample paths and indentation, give files non-foo names Co-authored-by: Isaac Lee <16869656+ijlee2@users.noreply.github.com>
- Loading branch information
Showing
1 changed file
with
91 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
--- | ||
id: routing.transition-methods | ||
title: Deprecate transition methods of routes and controllers | ||
until: '4.0.0' | ||
since: 'Upcoming Features' | ||
--- | ||
|
||
The following methods are deprecated: | ||
- `transitionTo` on `Route` | ||
- `replaceWith` on `Route` | ||
- `transitionToRoute` on `Controller` | ||
- `replaceRoute` on `Controller` | ||
|
||
Instead, the user should inject the router service in the respective class and use its methods. | ||
|
||
### Route example | ||
|
||
Before: | ||
|
||
```javascript | ||
// app/routes/settings.js | ||
import Route from '@ember/routing/route'; | ||
import { inject as service } from '@ember/service'; | ||
|
||
export default class SettingsRoute extends Route { | ||
@service session; | ||
|
||
beforeModel() { | ||
if (!this.session.isAuthenticated) { | ||
this.transitionTo('login'); | ||
} | ||
} | ||
} | ||
``` | ||
|
||
After: | ||
|
||
```javascript | ||
// app/routes/settings.js | ||
import Route from '@ember/routing/route'; | ||
import { inject as service } from '@ember/service'; | ||
|
||
export default class SettingsRoute extends Route { | ||
@service router; | ||
@service session; | ||
|
||
beforeModel() { | ||
if (!this.session.isAuthenticated) { | ||
this.router.transitionTo('login'); | ||
} | ||
} | ||
} | ||
``` | ||
|
||
### Controller example | ||
|
||
Before: | ||
|
||
```javascript | ||
// app/controllers/new-post.js | ||
import Controller from '@ember/controller'; | ||
|
||
export default class NewPostController extends Controller { | ||
@action | ||
async save({ title, text }) { | ||
let post = this.store.createRecord('post', { title, text }); | ||
await post.save(); | ||
return this.transitionToRoute('post', post.id); | ||
} | ||
} | ||
``` | ||
|
||
After: | ||
|
||
```javascript | ||
// app/controllers/new-post.js | ||
|
||
import Controller from '@ember/controller'; | ||
import { inject as service } from '@ember/service'; | ||
|
||
export default class NewPostController extends Controller { | ||
@service router; | ||
|
||
@action | ||
async save({ title, text }) { | ||
let post = this.store.createRecord('post', { title, text }); | ||
await post.save(); | ||
return this.router.transitionTo('post', post.id); | ||
} | ||
} | ||
``` |