# react-fluid-scroll

> Creates a fluid like scrolling effect

Latest version **1.0.0** (published 2018-07-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-fluid-scroll
pnpm add react-fluid-scroll
yarn add react-fluid-scroll
bun add react-fluid-scroll
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-07-17 |
| First published | 2018-07-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 57.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Craig Tuttle |
| Maintainers | craigtut |
| Keywords | react-component, react, scroll, fluid scroll, scrolling, react fluid scroll |

## Links

- npm: https://www.npmjs.com/package/react-fluid-scroll
- Repository: https://github.com/craigtut/react-fluid-scroll
- Issues: https://github.com/craigtut/react-fluid-scroll/issues
- npm.io page: https://npm.io/package/react-fluid-scroll

## Dependencies (2)

- [jest](https://npm.io/package/jest.md) ^22.0.5
- [react](https://npm.io/package/react.md) ^15.5.4

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2018-07-17

## README

# React Fluid Scroll

React fluid scroll sets up and manages a virtualized scroll element that allows for a smooth scroll animation. 

See [Craigtut.com](https://www.Craigtut.com) to see the scroll smoothing in effect.

## Installation

```
npm install react-fluid-scroll -save
```

... or yarn


## Usage


Basic Usage
```javascript
import ReactFluidScroll from 'react-fluid-scroll';

<ReactFluidScroll viscosity={0.2}>
    /* your page or content */
</ReactFluidScroll>

```

Optional Props:

* scrollHook: callback function that is call on scroll events. This allows you to tap into the virtualScrolls current position rather than the window's current scroll location.

* callback parameter structure: { virtual: { y: this.currentVirtualScroll } }

Example callback
```javascript
    this.scrollMagicBridge = (scroll) => {
      this.props.controller.scrollPos(() => scroll.virtual.y);
      this.props.controller.update();
    };
```

---
_Source: https://npm.io/package/react-fluid-scroll · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._