Skip to content

Improved IndexRedirect documentation #3137

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 1 commit into from
Mar 1, 2016
Merged

Improved IndexRedirect documentation #3137

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 12 additions & 1 deletion docs/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,7 +460,18 @@ All the same props as [Route](#route) except for `path`.
### `<IndexRedirect>`
An `<IndexRedirect>` allows you to redirect from the URL of a parent route to another route. They can be used to allow a child route to serve as the default route for its parent, while still keeping a distinct URL.

Please see the [Index Routes guide](/docs/guides/IndexRoutes.md).
#### Example
```js
<Router>
<Route path="/" component={App}>
<IndexRedirect to="groups" />
{/* If no child route is matched, will redirect to 'groups' */}

<Route path="groups" component={Groups} />
<Route path="users" component={Users} />
</Route>
</Router>
```

#### Props
All the same props as [Redirect](#redirect) except for `from`.
Expand Down