search

react-component / m-pull-to-refresh

React Mobile Pull To Refresh
http://react-component.github.io/m-pull-to-refresh/
164 stars 61 forks source link

readme

rmc-pull-to-refresh

React Mobile PullToRefresh Component.

NPM version build status Test coverage gemnasium deps npm download

Screenshots

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

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.