react-on-screen
Check if your react component are visible on the screen without pain and with performance in mind.
Installation
$ npm install --save react-on-screen
$ yarn add react-on-screen
A UMD build is also available :
Usage
Simple
Using a render props
You can use a render props is you want to !
Track the visibility only once
For many cases you may want to track the visibility only once. This can be done simply as follow :
Defining offset
Using offset
props can be usefull if you want to lazy load an image for instance.
Partial visibility
You may want to consider that a component is visible as soon as a part of the component is visible on screen. You can use the partialVisibility
props for that.
Use the html tag of your choice
Api
props | type | default | description |
---|---|---|---|
once | bool | false | If set to true track the visibility only once and remove the event listeners |
throttleInterval | int | 150 | Tweak the event listeners. See David Corbacho's article |
children | React Components | - | Can be one or many react components |
style | object | - | Style attributes |
className | string | - | Css classes |
offset | number | 0 | Allows you to specify how far left or above of the viewport you want to set isVisible to true |
partialVisibility | bool | false | Set isVisible to true on element as soon as any part is in the viewport |
tag | string | div | Allows specifying html tag of your choice |