rmc-pull-to-refresh/README.md

React Mobile Pull To Refresh Component

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