Skip to content

Add an example on how to use the onEnter callback #3660

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 22, 2016
Merged

Add an example on how to use the onEnter callback #3660

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d2ff84a
Add an example on how to use the onEnter callback
thaiphan Jul 21, 2016
4460931
Fix derp
thaiphan Jul 21, 2016
0f3dc3b
Address code review comments
thaiphan Jul 21, 2016
8ecae83
Update API.md
thaiphan Jul 21, 2016
2a82ef1
Update API.md
thaiphan Jul 22, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,6 +345,28 @@ Called when a route is about to be entered. It provides the next router state an

If `callback` is listed as a 3rd argument, this hook will run asynchronously, and the transition will block until `callback` is called.

###### `callback` signature
`cb(err)`

```js
const userIsInATeam = (nextState, replace, callback) => {
fetch(...)
.then(response = response.json())
.then(userTeams => {
if (userTeams.length === 0) {
replace(`/users/${nextState.params.userId}/teams/new`)
}
callback();
})
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should catch and call back with an error

.catch(error => {
// do some error handling here
callback(error);
})
}

<Route path="/users/:userId/teams" onEnter={userIsInATeam} />
```

##### `onChange(prevState, nextState, replace, callback?)`
Called on routes when the location changes, but the route itself neither enters or leaves. For example, this will be called when a route's children change, or when the location query changes. It provides the previous router state, the next router state, and a function to redirect to another path. `this` will be the route instance that triggered the hook.

Expand Down