Route.md

API: Route (component)

A <Route> is used to declare your application's routes and entry view hierarchy.

Props

name

The name of the route, used in the Link component and the router's transition methods.

path

The path used in the URL. If left undefined, the path will be defined by the name, and if there is no name, will default to /.

Please refer to the Path Matching Guide to learn more about supported path matching syntax.

handler

The component to be rendered when the route is active.

children

Routes can be nested. When a child route path matches, the parent route is also activated. Please refer to the overview since this is a very critical part of the router's design.

ignoreScrollBehavior

When route or its params change, router adjusts window scroll position according to scrollBehavior. This is generally desirable but you might want to opt out of scrolling adjustment for a specific route or a group of routes.

If you specify ignoreScrollBehavior attribute on a route, changes in params or any transitions within its children will not adjust scroll position. This can be useful on a search page or in a tabbed interface.

Note that changes in query never adjust scroll position, regardless of the value of this attribute.

Example

<!-- `path` defaults to '/' since no name or path provided -->
<Route handler={App}>
  <!-- path is automatically assigned to the name since it is omitted -->
  <Route name="about" handler={About}/>
  <Route name="users" handler={Users}>
    <!--
      note the dynamic segment in the path, and that it starts with `/`,
      which makes it "absolute", or rather, it doesn't inherit the path
      from the parent route
    -->
    <Route name="user" handler={User} path="/user/:id"/>
  </Route>
</Route>