npm.io
0.6.0 • Published 8 years ago

react-navigate

Licence
MIT
Version
0.6.0
Deps
1
Vulns
0
Weekly
0
Stars
9

dependencies Status js-standard-style

react-navigate

Navigation on web for React.JS https://xiaody.github.io/react-navigate

Installation

To install the stable version:

npm install --save react-navigate

Usage

import Navigation, {NavLink} from 'react-navigate'
import 'react-navigate/src/Navigation.css'

const views = {
  home: {
    name: 'home',
    title: 'Home page',
    content () {
      return (
        <NavLink to='about'>go to About</NavLink>
      )
    }
  },
  about: {
    name: 'about',
    title: 'Abount',
    content: 'Oh!'
  }
}

<Navigation
  viewsMap={views}
  defaultViewName='home'
/>

Options

  • props.viewsMap
  • props.defaultViewName
  • props.height
  • props.headerHeight
  • props.backButton
  • props.className
  • props.titleClassName
  • props.bodyClassName
  • props.onWillNav
  • props.onDidNav

Limitations

  • scroll position isn't kept when switching between views, because the DOM is destroyed and re-created
  • no back button title support
  • require modern browsers env

License

MIT

Keywords