@nattlivet/react-pully NPM

react-pully

React pull-to-refresh with promises.

Installation

$ yarn add @nattlivet/react-pully
# or
$ npm add @nattlivet/react-pully

Usage

import Pully from '@nattlivet/react-pully';

import '@nattlivet/react-pully/dist/Pully.css'

const MyComponent = () => {
    return (
        <div className="MyComponent">
            <Pully onRefresh={() => new Promise(async (resolve) => {
                await someSlowTask();
                return resolve();
            })}>
            </Pully>
        </div>
    ):
}

export default MyComponent;

Component styles

To prevent Chrome overscroll set overscroll-behavior-y: contain [or] none; on <body> (learn more).

Props

Prop	Required	Type	Default	Description
onRefresh	true	Function	undefined	Called when a pull is triggered
className	false	String	`Pully`	Class applied to the component
distThreshold	false	Number	`72`	Distance where refresh is triggered
resistance	false	Number	`2.5`	How hard it is to pull down
disabled	false	Boolean	false	Disables all functionality