react-router-drilldown

react-router-drilldown

This is a simple component that provides drilldown-style horizontal slide transitions between index and child routes. It is based upon the <Switch> component from react-router v4 and uses react-view-slider internally.

For react-router v2 or v3, see the legacy project.

Live Demo

Usage

npm install --save react-router react-router-dom react-router-drilldown

Create a <Drilldown> element with child <Route>s exactly like you would for a <Switch>. By default the first child <Route> is at the left, and subsequent child routes will slide in from the right. However, you also customize the order by giving an integer key to each child route.

import React from 'react'
import { render } from 'react-dom'
import { BrowserRouter as Router, Route, Link } from 'react-router-dom'
import Drilldown from 'react-router-drilldown'

const Home = () => (
  <div>
    <h1>Home</h1>
    <p>
      <Link to="/users">Users</Link>
    </p>
    <p>
      <Link to="/users/andy">Andy</Link>
    </p>
  </div>
)

const Users = ({ match }) => (
  <div>
    <h1>Users</h1>
    <Link to={`${match.url}/andy`}>Andy</Link>
  </div>
)

const Andy = () => <h1>Andy</h1>

render(
  <Router>
    <Drilldown>
      <Route exact path="/" component={Home} />
      <Route exact path="/users" component={Users} />
      <Route path="/users/andy" component={Andy} />
    </Drilldown>
  </Router>,
  document.getElementById('root')
)

Note: if you transition directly from / to /users/andy before ever visiting /users, the /users view will not show in the middle of the animated transition. However, once you have visited /users, it will show between the other two views when transitioning between them.

Drilldowns can be nested

Instead of the flat route configuration shown above, you also use a separate drilldown at each level:

const UsersRoute = ({ match }) => (
  <Drilldown>
    <Route exact path={match.path} component={Users} />
    <Route path={`${match.url}/andy`} component={Andy} />
  </Drilldown>
)

render(
  <Router>
    <Drilldown>
      <Route exact path="/" component={Home} />
      <Route path="/users" component={UsersRoute} />
    </Drilldown>
  </Router>,
  document.getElementById('root')
)

Unlike the flat example above, you will not see the /users view fly by in the middle when transitioning directly from / to /users/andy.

Props

animateHeight: boolean (default: true)

If truthy, will animate its height to match the height of the page at activePage.

keepViewsMounted: boolean (default: false)

If truthy, will keep all routes that have rendered before mounted.

keepPrecedingViewsMounted: boolean (default: false)

If truthy, will keep routes preceding the active route mounted (but not routes following the active route). The order is determined by the integer key properties on your <Route>s.

transitionDuration: number (default: 500)

The duration of the transition between pages.

transitionTimingFunction: string (default: 'ease')

The timing function for the transition between pages.

prefixer: Prefixer

If given, overrides the inline-style-prefixer used to autoprefix inline styles.

fillParent: boolean (default: false)

If truthy, Drilldown will use absolute positioning on itself and its pages to fill its parent element.

className: string

Any extra class names to add to the root element.

style: Object

Extra inline styles to add to the root element.

viewportClassName: string

Any extra class names to add to the inner "viewport" element.

viewportStyle: Object

Extra inline styles to add to the inner "viewport" element.

viewStyle: Object

Extra inline styles to add to the view wrapper elements.

innerViewWrapperStyle: Object

Extra inline styles to add to the inner div between the viewStyle div and your view content element. (The inner div was added to ensure perfect height animation.)

location: Location (default: accessed from withRouter)

If given, this location is used instead of the one from withRouter.