react-scrollie

Features

• Only 5.73KB (that's 2.53KB gzipped!).
• Detect scroll edges: startX, endX, startY, endY.
• Built for React 16.

Installation

• npm install react-scrollie --save

  or

• yarn add react-scrollie

Usage

import React from 'react'
import Scrollie from 'react-scrollie'

const Demo = () => (
  <Scrollie>
    {scroll => (
      <ul>
        <li>Start X: {scroll.startX}
        <li>End X: {scroll.endX}
        <li>Start Y: {scroll.startY}
        <li>End Y: {scroll.endY}
      </ul>
    )}
  </Scrollie>
)

When <Scrollie /> is mounted it will start to listen to scroll events and will execute the children render prop providing info about scroll position.

The children is expected to be a function.

Documentation

Tests

TBD

Development

To start contributing to this project, please do:

1. Fork and clone this repo.
2. Do your work.
3. Create a PR.

Releases

To release this project the following tasks should be done:

1. Build distribution files: yarn build.
2. Bump version and create tag: npm version #.#.# -m 'Version %s.'.
3. Push new created tag: git push origin --tags.
4. Publish: npm publish.

Made with ❤️ by Rubens Mariuzzo.

MIT License