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.

<ion-content>
  <ion-refresher slot="fixed">
    <ion-refresher-content>
    </ion-refresher-content>
  </ion-refresher>
</ion-content>

Properties

closeDuration

string

Time it takes to close the refresher. Defaults to 280ms.

disabled

boolean

If true, the refresher will be hidden. Defaults to true.

pullMax

any

The maximum distance of the pull until the refresher will automatically go into the refreshing state. Defaults to the result of pullMin + 60.

pullMin

number

The minimum distance the user must pull down until the refresher will go into the refreshing state. Defaults to 60.

snapbackDuration

string

Time it takes the refresher to to snap back to the refreshing state. Defaults to 280ms.

Attributes

close-duration

string

Time it takes to close the refresher. Defaults to 280ms.

disabled

boolean

If true, the refresher will be hidden. Defaults to true.

pull-max

any

The maximum distance of the pull until the refresher will automatically go into the refreshing state. Defaults to the result of pullMin + 60.

pull-min

number

The minimum distance the user must pull down until the refresher will go into the refreshing state. Defaults to 60.

snapback-duration

string

Time it takes the refresher to to snap back to the refreshing state. Defaults to 280ms.

Events

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

cancel()

Changes the refresher's state from refreshing to cancelling.

complete()

Call complete() when your async operation has completed. For example, the refreshing state is while the app is performing an 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.

getProgress()

A number representing how far down the user has pulled. The number 0 represents the user hasn't pulled down at all. The number 1, and anything greater than 1, represents that the user has 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 the refresh will not happen, and the content will return to it's original position.

Built with StencilJS