A thin component wrapper around scroll-into-view-if-needed
npm install react-scroll-into-view-if-needed
A thin react component wrapper bundled with the fantastic scroll-into-view-if-needed ponyfill.
yarn add react-scroll-into-view-if-needed
or
npm install react-scroll-into-view-if-needed --save
``js
import ScrollIntoViewIfNeeded from 'react-scroll-into-view-if-needed';
const MyComponent = () => (
Props
Each prop is described in detail below, but for a quicker reference - check out the propTypes object in src.
#### options
> Type:
> Default: Full list of options are described here
js
}}>
Hello
`#### active
> Type:
> Default: The
prop allows controll of _when_ to scroll to the component. By default, it will attempt to scroll as soon as it is mounted, but you can set this prop to manually control when to trigger the scroll behavior from the parent component.`js
class Example extends React.PureComponent {
constructor(props) {
super(props);
this.state = { active: false };
} handleScrollToggle = () => this.setState({ active: !this.state.active });
render() {
const { active } = this.state;
return (
Hello
);
}
}
`#### elementType
> Type:
> Default: Set the wrapper component type. For example, this could also be
, 'button', etc... See the React createElement api.`js
Hello
`#### className, id, etc
You can also pass normal element attributes like
to the component.`js
Hello
`Standalone Version
The standalone version does not come bundled with scroll-into-view-if-needed. Use this version if you'd like to maintain your own dependency, or if you're already using scroll-into-view-if-needed in other areas of your project.
ES version:
UMD version:
Upgrading from v1
This project has been updated along with scroll-into-view-if-needed and accepts the same