rp
react-pull2refresh
npm i react-pull2refresh
rp

react-pull2refresh

React component for web pull to refresh

by Bryan Eaton

1.1.4 (see all)License:MITTypeScript:Not Found
npm i react-pull2refresh
Readme

react-pull-to-refresh

npm install react-pull2refresh -S

A pull to refresh component for the web.

Based on Andy Peatling's Pull to Refresh for the Web

Demo GIF

Usage

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

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

Where you want to render the component:

<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 as a starting point.

All props

PropTypes

  • onRefresh: PropTypes.func.isRequired
  • icon: PropTypes.element
    • default:
    <span className="genericon genericon-next"></span>
    
  • loading: PropTypes.element
    • default:
    <div className="loading">
      <span className="loading-ptr-1"></span>
      <span className="loading-ptr-2"></span>
      <span className="loading-ptr-3"></span>
    </div>
    
  • disabled: PropTypes.bool
  • className: PropTypes.string
  • style: PropTypes.object
  • distanceToRefresh: PropTypes.number
    • default: 70
  • resistance: PropTypes.number
    • default: 2.5
  • hammerOptions: PropTypes.object

Thanks

Andy Peatling

hack scroll issue

to enable proper scroll capablilty, add css as blow

.refresh-view.disabled {
  transform: translate3d(0px, 0px, 0px) !important;
}

.ptr-element.disabled { display: none !important; }

Downloads/wk

8

GitHub Stars

395

LAST COMMIT

4yrs ago

MAINTAINERS

1

CONTRIBUTORS

6

OPEN ISSUES

6

OPEN PRs

0
VersionTagPublished
1.1.4
latest
4yrs ago
No alternatives found
No tutorials found
Add a tutorial