# reactscroller

> An universal scroll component for React

Latest version **0.1.2** (published 2017-07-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install reactscroller
pnpm add reactscroller
yarn add reactscroller
bun add reactscroller
```

## 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.1.2 |
| Published | 2017-07-18 |
| First published | 2017-07-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | iconie |
| Maintainers | aircloud |
| Keywords | react |

## Links

- npm: https://www.npmjs.com/package/reactscroller
- Repository: https://github.com/aircloud/ReactScroller
- Homepage: https://github.com/aircloud/ReactScroller#readme
- Issues: https://github.com/aircloud/ReactScroller/issues
- npm.io page: https://npm.io/package/reactscroller

## 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.1.2 (latest) — 2017-07-18
- 0.1.1 — 2017-07-18
- 0.1.0 — 2017-07-18
- 0.0.3 — 2017-07-16
- 0.0.2 — 2017-07-15
- 0.0.1 — 2017-07-15

## README

<p align="center">
<img src="https://www.10000h.top/images/data_img/reactscroller.png"/>
</p>
<p align="center">
<span style="font-size:16px;">An universal scroll component for React</span>
</p>
<p align="center">
  <a href="https://www.npmjs.com/package/reactscroller"><img src="https://img.shields.io/npm/v/reactscroller.svg" alt="Version"></a>
  <a href="https://github.com/aircloud/ReactScroller"><img src="https://img.shields.io/npm/l/vue.svg" alt="License"></a>
</p>

## usage

```
npm i reactscroller --save
```

and then you can(ES6):

```
import ReactScoller from "reactscroller";
```

or:
 
```
var ReactScoller = require("reactscroller");
```

You can visit [ReactScrollerExample](https://github.com/aircloud/ReactScrollerExample) to find more details for usage.

**The following is a list of incoming properties：**

| property | Optional | Default | description | type |
| ------| ------ | ------ | ------ | ------ | 
| containerHeight | Necessary | null | The height for the outer container to scroll | String \| Number |
| containerWidth  | Optional | 100% | The width for the outer container to scroll |String \| Number |
| refresh | Optional | null | The function for pull down to refresh | Function |
| loadMore | Optional | null | The function for scroll up to load more | Function |
| lowerBound | Optional | 50 | The distance to the bottom when trigger the function loadmore | Number |
| refreshTip | Necessary | null | The refreshTip for the different stages of refreshing(a property of `this.state` is better. It should be changed) | String or Component |
| loadMoreTip | Necessary | null | The loadmoreTip for the different stages of loading more (a property of `this.state` is better. It should be changed) | String or Component |
| showRefresh | Necessary | null | Whether the refreshTip should be displayed | bool |
| showLoadMore | Necessary | null | Whether the loadMoreTip should be displayed | bool |

## Advanced

I peeled off the core module and the presentation module during the coding phase. So you can use the `ReactScrollerCore` to make more customization.

```
import {ReactScrollerCore} from "reactscroller";
```
I continue thinking and testing, if you have some good ideas please visit [issues](https://github.com/aircloud/ReactScroller/issues)

## License

MIT

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