Redirect.md

API: Redirect (component)

Configures a redirect for a path in your route declarations.

Props

from

The path you want to redirect from, including dynamic segments. Defaults to * so you can redirect anything not found to somewhere else.

to

The name of the route you want to redirect to.

Example

<!--
  lets say we want to change from `/profile/123` to `/about/123`
  and redirect `/get-in-touch` to `/contact`
-->
<Routes>
  <Route handler={App}>
    <Route name="contact" handler={Contact}/>
    <Route name="about-user" path="about/:userId" handler={UserProfile}/>
    <Route name="course" path="course/:courseId">
      <Route name="course-dashboard" path="dashboard" handler={Dashboard}/>
      <Route name="course-assignments" path="assignments" handler={Assignments}/>
      <!--
        anything like `/course/123/invalid` redirects to
        `/course/123/dashboard`
      -->
      <Redirect to="course-dashboard" />
    </Route>
  </Route>
  
  <!-- `/get-in-touch` -> `/contact` -->
  <Redirect from="get-in-touch" to="contact" />
  <!-- `/profile/123` -> `/about/123` -->
  <Redirect from="profile/:userId" to="about-user" />
</Routes>

Note that the <Redirect/> can be placed anywhere in the route hierarchy, if you'd prefer the redirects to be next to their respective routes.

<Routes>
  <Route handler={App}>
    <Route name="contact" handler={Contact}/>
    <Redirect from="get-in-touch" to="contact" />
  </Route>
</Routes>