react-scrollsense/README.md

A lightweight scroll sensor to solve your react scroll into viewport issues.

 <img src="./icon.png" width="800px" >

# React Scroll Sensor

A lightweight scroll sensor to solve your react scroll into viewport issues.

 > TLDR; An unopinionated sensor to detect when your component gets into the viewport and injects the intersection info into your component.

 If you ever have tried to implement the support necessary to detect when your components get into the viewport when scrolling, you know how much it hurts. That's the exact reason this library is here.
 Whether you want to use scroll event-based tracking or intersection observer-based tracking, it's already packed into this sensor.

## Installing


```console
yarn add react-scrollsense
 ```

 or

```shell
npm save react-scrollsense
 ```

## Documentation 

You can access the documentation from [here](https://xpd-kasun.github.io/React-ScrollSense/).

## Information for the maintainers and contributers

We need more maintainers and contributors for the library. Please [click here](dev.md) for the internals.

Writers are welcome for the documentation. Fork and create a pull request.

## License

 Copyright (c) 2022 XPD Kasun Jayawardena.

 Licensed under The MIT License (MIT).

## Thanks for using React-ScrollSense

* Find it useful? give it a star :)
* Problems? Add your problem in Issues. I will try to accommodate as much as I am allowed.