# react-pull-to-refresh

**Repository Path**: mirrors_fis-components/react-pull-to-refresh

## Basic Information

- **Project Name**: react-pull-to-refresh
- **Description**: Fork from https://github.com/bryaneaton13/react-pull-to-refresh.git
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-05-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# react-pull-to-refresh

`npm install react-pull-to-refresh`

A pull to refresh component for the web.

Based on Andy Peatling's [Pull to Refresh for the Web](https://github.com/apeatling/web-pull-to-refresh)

![Demo GIF](https://github.com/bryaneaton13/react-pull-to-refresh/blob/master/docs/demo.gif)

## Usage

Your refresh handler function takes in `resolve` and `reject` to tell the PullToRefresh component when it's finished.

```javascript
handleRefresh(resolve, reject) {
  // do some async code here
  if (success) {
    resolve();
  } else {
    reject();
  }
}

```

Where you want to render the component:

```xml
<ReactPullToRefresh
  onRefresh={this.handleRefresh}
  className="your-own-class-if-you-want"
  style={{
    textAlign: 'center'
  }}>
  <h3>Pull down to refresh</h3>
  <div>{items}</div>
  <div>etc.</div>
</ReactPullToRefresh>
```



## CSS
Use the CSS from the example or from [here](https://github.com/apeatling/web-pull-to-refresh) as a starting point.


## All props

React.PropTypes

- **onRefresh**
 - function *(required)*
- **icon**
 - React element
 - *default*:
```html
 <span className="genericon genericon-next"></span>
```
- **loading**
 - element
 - *default*:
```html
<div className="loading">
  <span className="loading-ptr-1"></span>
  <span className="loading-ptr-2"></span>
  <span className="loading-ptr-3"></span>
</div>
```
- **disabled**
 - boolean
- **className**
 - string
- **style**
 - object
- **distanceToRefresh**
 - number
 - *default*: `70`
- **resistance**
 - number
 - *default*: `2.5`

## Thanks
[Andy Peatling](http://apeatling.com/)