https://github.com/faceless-ui/scroll-info

A React library for subscribing to scroll events
https://github.com/faceless-ui/scroll-info

react react-component scroll typescript

Last synced: 12 days ago
JSON representation

A React library for subscribing to scroll events

• Host: GitHub
• URL: https://github.com/faceless-ui/scroll-info
• Owner: faceless-ui
• License: mit
• Created: 2019-11-14T00:51:23.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-06-09T04:26:33.000Z (7 months ago)
• Last Synced: 2024-12-22T04:48:21.559Z (16 days ago)
• Topics: react, react-component, scroll, typescript
• Language: JavaScript
• Homepage: https://facelessui.com/docs/scroll-info
• Size: 807 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
[![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 [email protected]: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