# rmc-pull-to-refresh

> React Mobile Pull To Refresh Component

Latest version **1.0.13** (published 2020-06-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install rmc-pull-to-refresh
pnpm add rmc-pull-to-refresh
yarn add rmc-pull-to-refresh
bun add rmc-pull-to-refresh
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.13 |
| Published | 2020-06-15 |
| First published | 2016-05-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 38.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 141 |
| Maintainers | silentcloud, warmhug, yiminghe |
| Keywords | react, react-component, react-pull-to-refresh, pull-to-refresh |

## Links

- npm: https://www.npmjs.com/package/rmc-pull-to-refresh
- Repository: https://github.com/react-component/m-tabs
- Homepage: https://github.com/react-component/m-pull-to-refresh
- Issues: https://github.com/react-component/m-tabs/issues
- npm.io page: https://npm.io/package/rmc-pull-to-refresh

## Dependencies (2)

- [classnames](https://npm.io/package/classnames.md) ^2.2.5
- [babel-runtime](https://npm.io/package/babel-runtime.md) 6.x

## 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.13 (latest) — 2020-06-15
- 0.0.1-beta.15 (beta) — 2019-05-28
- 0.0.1-beta.26 (canary) — 2019-05-28
- 1.0.12 — 2020-03-19
- 0.0.1-beta.34 — 2019-05-28
- 0.0.1-beta.32 — 2019-05-28
- 1.0.11 — 2018-06-11
- 1.0.10 — 2018-06-11
- 1.0.9 — 2018-05-29
- 1.0.8 — 2018-05-29
- 1.0.7 — 2017-12-19
- 1.0.6 — 2017-12-05
- 1.1.0-alpha.0 — 2017-11-16
- 1.0.5 — 2017-11-08
- 1.0.4 — 2017-10-26
- … 24 more at https://npm.io/package/rmc-pull-to-refresh/versions

## README

# rmc-pull-to-refresh
---

React Mobile PullToRefresh Component.


[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]
[![gemnasium deps][gemnasium-image]][gemnasium-url]
[![npm download][download-image]][download-url]

[npm-image]: http://img.shields.io/npm/v/rmc-pull-to-refresh.svg?style=flat-square
[npm-url]: http://npmjs.org/package/rmc-pull-to-refresh
[travis-image]: https://img.shields.io/travis/react-component/m-pull-to-refresh.svg?style=flat-square
[travis-url]: https://travis-ci.org/react-component/m-pull-to-refresh
[coveralls-image]: https://img.shields.io/coveralls/react-component/m-pull-to-refresh.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/react-component/m-pull-to-refresh?branch=master
[gemnasium-image]: http://img.shields.io/gemnasium/react-component/m-pull-to-refresh.svg?style=flat-square
[gemnasium-url]: https://gemnasium.com/react-component/m-pull-to-refresh
[node-image]: https://img.shields.io/badge/node.js-%3E=_0.10-green.svg?style=flat-square
[node-url]: http://nodejs.org/download/
[download-image]: https://img.shields.io/npm/dm/rmc-pull-to-refresh.svg?style=flat-square
[download-url]: https://npmjs.org/package/rmc-pull-to-refresh


## Screenshots

<img src="https://os.alipayobjects.com/rmsportal/rcLuiqtnDULPyzG.gif" width="288"/>


## Development

```
npm install
npm start
```

## Example

http://localhost:8899/examples/

online example: http://react-component.github.io/m-pull-to-refresh/


## install

[![rmc-pull-to-refresh](https://nodei.co/npm/rmc-pull-to-refresh.png)](https://npmjs.org/package/rmc-pull-to-refresh)


## Usage

see example

## API

### props

| name     | description    | type     | default      |
|----------|----------------|----------|--------------|
| direction  | pull direction, can be `up` or `down` | String | `down` |
| distanceToRefresh | distance to pull to refresh | number | 50  |
| refreshing | Whether the view should be indicating an active refresh | bool | false |
| onRefresh  | Called when the view starts refreshing. | () => void | - |
| indicator  | indicator config | Object | `{ activate: 'release', deactivate: 'pull', release: 'loading', finish: 'finish' }` |
| className | additional css class of root dom node | String | - |
| prefixCls | prefix class | String | 'rmc-pull-to-refresh' |
| damping | pull damping, suggest less than 200 | number | 100 |
| scale | damping scale | number | 0.6 |

## Test Case

```
npm test
```

## Coverage

```
npm run coverage
```

## License

rmc-pull-to-refresh is released under the MIT license.

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