@faceless-ui/scroll-info/README.md

A React library for subscribing to scroll events

[![NPM](https://img.shields.io/npm/v/@faceless-ui/scroll-info)](https://www.npmjs.com/@faceless-ui/scroll-info)
![Bundle Size](https://img.shields.io/bundlephobia/minzip/@faceless-ui/scroll-info?label=zipped)

# React Scroll Info

Read the full documentation [here](https://facelessui.com/docs/scroll-info).

## Installation

```bash
$ npm i @faceless-ui/scroll-info
$ # or
$ yarn add @faceless-ui/scroll-info
```

## Development

To develop this module locally, spin up the [demo app](./demo/App.demo.js):

```bash
$ git clone git@github.com:faceless-ui/scroll-info.git
$ yarn
$ yarn dev
$ open http://localhost:3000
```

## License

[MIT](https://github.com/faceless-ui/scroll-info/blob/master/LICENSE) Copyright (c) Faceless UI