ion-refresher
The refresher provides pull-to-refresh functionality on a content component. The pull-to-refresh pattern lets a user pull down on a list of data using touch in order to retrieve more data.
Data should be modified during the refresher's output events. Once the async
operation has completed and the refreshing should end, call complete()
on the
refresher.
#
Native RefreshersBoth iOS and Android platforms provide refreshers that take advantage of properties exposed by their respective devices that give pull to refresh a fluid, native-like feel.
Certain properties such as pullMin
and snapbackDuration
are not compatible because much of the native refreshers are scroll-based. See Refresher Properties for more information.
#
iOS UsageUsing the iOS native ion-refresher
requires setting the pullingIcon
property on ion-refresher-content
to the value of one of the available spinners. See the Spinner Documentation for accepted values. The pullingIcon
defaults to the lines
spinner on iOS. The spinner tick marks will be progressively shown as the user pulls down on the page.
The iOS native ion-refresher
relies on rubber band scrolling in order to work properly and is only compatible with iOS devices as a result. We provide a fallback refresher for apps running in iOS mode on devices that do not support rubber band scrolling.
#
Android UsageUsing the MD native ion-refresher
requires setting the pullingIcon
property on ion-refresher-content
to the value of one of the available spinners. See the ion-spinner Documentation for accepted values. pullingIcon
defaults to the circular
spinner on MD.
#
Usage- ANGULAR
- JAVASCRIPT
- REACT
- STENCIL
- VUE
#
Properties#
closeDurationDescription | Time it takes to close the refresher. Does not apply when the refresher content uses a spinner, enabling the native refresher. |
Attribute | close-duration |
Type | string |
Default | '280ms' |
#
disabledDescription | If true , the refresher will be hidden. |
Attribute | disabled |
Type | boolean |
Default | false |
#
pullFactorDescription | How much to multiply the pull speed by. To slow the pull animation down, pass a number less than 1 . To speed up the pull, pass a number greaterthan 1 . The default value is 1 which is equal to the speed of the cursor.If a negative value is passed in, the factor will be 1 instead.For example: If the value passed is 1.2 and the content is dragged by10 pixels, instead of 10 pixels the content will be pulled by 12 pixels(an increase of 20 percent). If the value passed is 0.8 , the dragged amountwill be 8 pixels, less than the amount the cursor has moved.Does not apply when the refresher content uses a spinner, enabling the native refresher. |
Attribute | pull-factor |
Type | number |
Default | 1 |
#
pullMaxDescription | The maximum distance of the pull until the refresher will automatically go into the refreshing state.Defaults to the result of pullMin + 60 .Does not apply when the refresher content uses a spinner, enabling the native refresher. |
Attribute | pull-max |
Type | number |
Default | this.pullMin + 60 |
#
pullMinDescription | The minimum distance the user must pull down until the refresher will go into the refreshing state.Does not apply when the refresher content uses a spinner, enabling the native refresher. |
Attribute | pull-min |
Type | number |
Default | 60 |
#
snapbackDurationDescription | Time it takes the refresher to to snap back to the refreshing state.Does not apply when the refresher content uses a spinner, enabling the native refresher. |
Attribute | snapback-duration |
Type | string |
Default | '280ms' |
#
EventsName | Description |
---|---|
ionPull | Emitted while the user is pulling down the content and exposing the refresher. |
ionRefresh | Emitted when the user lets go of the content and has pulled down |
further than the pullMin
or pulls the content down and exceeds the pullMax.
Updates the refresher state to refreshing
. The complete()
method should be
called when the async operation has completed. |
| ionStart
| Emitted when the user begins to start pulling down. |
#
Methods#
cancelDescription | Changes the refresher's state from refreshing to cancelling . |
Signature | cancel() => Promise<void> |
#
completeDescription | Call complete() when your async operation has completed.For example, the refreshing state is while the app is performingan asynchronous operation, such as receiving more data from an AJAX request. Once the data has been received, you then call this method to signify that the refreshing has completed and to close the refresher. This method also changes the refresher's state from refreshing to completing . |
Signature | complete() => Promise<void> |
#
getProgressDescription | A number representing how far down the user has pulled. The number 0 represents the user hasn't pulled down at all. Thenumber 1 , and anything greater than 1 , represents that the userhas pulled far enough down that when they let go then the refresh will happen. If they let go and the number is less than 1 , then therefresh will not happen, and the content will return to it's original position. |
Signature | getProgress() => Promise<number> |