react-use-is-scrolled-into-view

React hook which Check virturel dom enters the user's view.

Table of Contents

• Install
• Quick Start
• Usage
  • Individual components
• FAQ
• Thanks
• Contributing
• License

Install

# Yarn
yarn add react-use-is-scrolled-into-view

# NPM
npm install --save react-use-is-scrolled-into-view

Quick Start

//
// Individual components
//
import {useRef} from 'react';
import useIsScrolledIntoView from 'react-use-is-scrolled-into-view';
const Example = () => {
    const ref = useRef(null);
    const isIntoView = useIsScrolledIntoView(ref);
    return (
        <div ref={ref}  data-inview={isIntoView}>
         
        </div>
    );
};

Usage

NOTE: React hooks require react and react-dom version 16.8.0 or higher.

Related projects

Thanks

This repo was setup with the help of the excellent create-react-library and redux-react-hook.

Contributing

Zach Yu [email protected]

License

MIT