A React component for pull to refresh on the web.
npm install react-pull-to-refreshnpm install react-pull-to-refresh -S
A pull to refresh component for the web.
Based on Andy Peatling's Pull to Refresh for the Web
Your refresh handler function takes in resolve and reject to tell the PullToRefresh component when it's finished.
``typescript
async handleRefresh() {
await asyncCode();
}
`
Where you want to render the component:
`typescript`
Pull down to refresh
{items}
etc.
Use the CSS from the example as a starting point.
`typescript`
export interface ReactPullToRefreshProps extends HTMLAttributes
onRefresh: () => Promise
icon?: ReactNode;
loading?: ReactNode;
disabled?: boolean;
distanceToRefresh?: number;
resistance?: number;
hammerOptions?: {
cssProps?: CssProps | undefined;
domEvents?: boolean | undefined;
enable?: boolean | ((manager: HammerManager) => boolean) | undefined;
preset?: RecognizerTuple[] | undefined;
touchAction?: string | undefined;
recognizers?: RecognizerTuple[] | undefined;
inputClass?: HammerInput | undefined;
inputTarget?: EventTarget | undefined;
}
- onRefresh: () => PromiseReactNode
- icon: `
- _default:_
html`
ReactNode
- loading: `
- _default:_
html`
boolean
- disabled: string
- className: object
- style: number
- distanceToRefresh: 70
- _default_: number
- resistance: 2.5
- _default_: HammerOptions
- hammerOptions: `
typescript``
interface HammerOptions {
cssProps?: CssProps | undefined;
domEvents?: boolean | undefined;
enable?: boolean | ((manager: HammerManager) => boolean) | undefined;
preset?: RecognizerTuple[] | undefined;
touchAction?: string | undefined;
recognizers?: RecognizerTuple[] | undefined;
inputClass?: HammerInput | undefined;
inputTarget?: EventTarget | undefined;
}