README.md

react-headrooms

The excellent headroom.js as a React.js component.

Demo

Live demo: xiaokekeT.github.io/react-headrooms

Installation

The easiest way to use headroom is to install it from NPM and include it in your own React build process (using Browserify, Webpack, etc).

Usage

import React from 'react'
import Headroom from 'react-headrooms'

class Root extends React.Component {
  render () {
    return (
      <Headroom tolerance={5} offset={200} classes={{
          initial: 'animated',
          pinned: 'slideInUp',
          unpinned: 'fadeOut'
        }}
      >
        Hello
      </Headroom>
    )
  }
}

Disable headroom in you page

<Headroom disable={() => _.includes(['/login', '/test'], this.props.pathname)}>
  ...
</Headroom>

License

MIT