uneart / react-auto-scroll

A HOC that will auto scroll to the bottom when a property changes

react-auto-scroll

A HOC that will auto-scroll to the bottom when a property changes.

It'll track a property and scroll to the bottom whenever it changes. If the user has scrolled up, it preserves the user's scroll position when the property changes.

Installation

$ npm i react-auto-scroll

Example

var React = require('react')
var AutoScroll = require('react-auto-scroll')
var Component = AutoScroll({
  property: 'propertyName',
  alwaysScroll: false
})(React.createClass(/* ... */))

API

• AutoScroll(options)(Component)

• options.property (string) Property to track for scrolling

• options.alwaysScroll (boolean) Always enable scrolling even if user has scrolled up. Set to false by default.

License

MIT