# react-spy-scroll

> Scrollspy components for react

Latest version **0.2.2** (published 2018-02-16) · X11 license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2018-02-16 |
| First published | 2016-03-10 |
| Weekly downloads | 0 |
| License | X11 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 971.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Nicklas Utgaard |
| Maintainers | nutgaard |
| Keywords | react, scroll, spy |

## Links

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

## Dependencies (1)

- [tween-functions](https://npm.io/package/tween-functions.md) ^1.2.0

## 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

- 0.2.2 (latest) — 2018-02-16
- 0.2.1 — 2016-08-12
- 0.2.0 — 2016-05-18
- 0.1.1 — 2016-05-16
- 0.1.0 — 2016-05-15
- 0.0.7 — 2016-05-10
- 0.0.6 — 2016-04-23
- 0.0.5 — 2016-04-14
- 0.0.4 — 2016-04-09
- 0.0.3 — 2016-03-29
- 0.0.2 — 2016-03-11
- 0.0.1 — 2016-03-10

## README

# react-spy-scroll
Scrollspy components for react

[![circleci.com](https://circleci.com/gh/nutgaard/react-scroll-spy/tree/master.svg?style=shield&circle-token=05a159f51aa45260e4ed1f74ddbdc2ff896bc8ab)](https://circleci.com/gh/nutgaard/react-scroll-spy/tree/master)
[![codecov.io](https://codecov.io/github/nutgaard/react-scroll-spy/coverage.svg?branch=master)](https://codecov.io/github/nutgaard/react-scroll-spy?branch=master)
[![Dependency Status](https://david-dm.org/nutgaard/react-scroll-spy.svg)](https://david-dm.org/nutgaard/react-scroll-spy)
[![devDependency Status](https://david-dm.org/nutgaard/react-scroll-spy/dev-status.svg)](https://david-dm.org/nutgaard/react-scroll-spy#info=devDependencies)
[![peerDependency Status](https://david-dm.org/nutgaard/react-scroll-spy/peer-status.svg)](https://david-dm.org/nutgaard/react-scroll-spy#info=peerDependencies)

## How to install
```
npm install react-spy-scroll --save
```

## How to use it
TODO

### The most basic setup
TODO

### The default behaviour

The library introduces four components; `AnchorLink`, `AnchorButton`, `AnchorElement` and `ScrollPanel`.
The link and button are simple `a` and `button` tags wrapped in the `Anchor` component for ease of use.

To get startet you only need some `AnchorXXXX`s and `AnchorElements` with matching `href` and `id` props.
If you want a scrolling area within your page, e.g. not a page-scroll, you can wrap your `AnhorElements` in a `ScrollPanel`.

`AnchorElements` have useful defaults by them self, but will inherit configuration from its parent `ScrollPanel` if one exists.
If by change a `AnchorElement` defines a props which is also present at its parent `ScrollPanel` then the `AnchorElements` config will be used.


#### Anchor

|    PropName   |    PropType           |    Default            |  Description      |
| ------------- | --------------------- | --------------------- | ----------------- |
| `href`        | `PT.string.isRequired`| None                  | Reference to AnchorElement's `id`  |
| `onClick`     | `PT.func`             | None                  | `onClick` handler  |
| `activeClass` | `PT.string`           | `scroll-spy-active`   | The class given to an `Anchor` when its `AnchorElement` is active  |

#### AnchorElement

|    PropName   |    PropType               |    Default    |  Description                      |
| ------------- | ------------------------- | ------------- | --------------------------------- |
| `id`          | `PT.string.isRequired`    | None          | An elements `id`                  |
| `offset`      | `PT.number`               | None          | Scroll offset                     |
| `children`    | `PT.element.isRequired`   | None          | React children                    |
| `isInside`    | `PT.func`                 | See below     | Checking if element is in view    |

```javascript
isInside: (scrollOffset, elemTopBound, elemBottomBound) =>
        (scrollOffset >= elemTopBound && scrollOffset <= elemBottomBound)
```

#### ScrollPanel

|    PropName   |    PropType               |    Default    |  Description                      |
| ------------- | ------------------------- | ------------- | --------------------------------- |
| `offset`      | `PT.number`               | `0`           | Scroll offset                     |
| `events`      | `PT.object`               | `{}`          | Callbacks for start/end of scroll |
| `animate`     | `PT.bool`                 | `true`        | Animated scroll                   |
| `tag`         | `PT.string`               | `div`         | DOM-tag                           |
| `className`   | `PT.string`               | `scroll-panel`| Classname                         |
| `children`    | `PT.arrayOf(PT.element)`  | None          | React-children                    |


## Peer dependencies
This component has the newest react and react-router as peerdependenies, but will most likely work with lower version.
If you test the component with lower versions of react and/or react-router please let me know so that the dependencies can be adjusted.

```
"react": "^0.14.7 || ^15.0.1"
"react-dom": "^0.14.7 || ^15.0.1"
```

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