Component that adds Pull to refresh functionality to an
It can be used to perform a task when the user pulls down at the top of the page. A common usage is to refresh the data displayed in a page.
PullHook component is used to add a pull to refresh functionality to a page. It can let the user refresh a page or load the latest data.
PullHook component has three different states:
action. It starts in the
initial state. When it’s pulled down below its height it will transition into the
preaction state. If it’s released in
initial state it will just bounce back. If it’s released in the
preaction state, it will go into
Every time the state changes the
onChange property will be called.
When the component transitions into the
action state, it will call the
onLoad property with a
done callback as an argument. Calling this function will cause it to return to the
|Name||Type Default Value||Description|
|onChange||function||Called when the pull hook inner state is changed. The state can be either “initial”, “preaction” or “action” Optional.|
Called when the pull hook is in the
|onPull||function||Hook called whenever the user pulls the element. It gets the pulled distance ratio (scroll / height) and an animationOptions object as arguments. Optional.|
|disabled||bool||When set to true, the pull hook will be disabled. Optional.|
|height||number||The height of the pull hook in pixels. The default value is 64. Optional.|
|thresholdHeight||number||The threshold height of the pull hook in pixels. The default value is 96. Optional.|
|fixedContent||number||If set to true, the content of the page will not move when pulling. Optional.|
For bug reports and feature requests use our GitHub Issues page.