メインコンテンツまでスキップ
Version: v6

ion-refresher

Contents

RefresherはContentコンポーネント引っ張って更新する機能を提供します。 ユーザーはより多くのデータを取得するために、 タッチ操作でリストを引っ張って更新できます。

データはRefresherの外部のイベントで更新すべきです。 一回の非同期処理が完了すれば、complete()を呼び出すことで、 Refresherも終了するべきです。

Native Refreshers

Both 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 Usage

Using 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 Usage

Using 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.

Interfaces

RefresherEventDetail

interface RefresherEventDetail {
complete(): void;
}

RefresherCustomEvent

While not required, this interface can be used in place of the CustomEvent interface for stronger typing with Ionic events emitted from this component.

interface RefresherCustomEvent extends CustomEvent {
detail: RefresherEventDetail;
target: HTMLIonRefresherElement;
}

Usage

<!-- Default Refresher -->
<ion-content>
<ion-refresher slot="fixed" (ionRefresh)="doRefresh($event)">
<ion-refresher-content></ion-refresher-content>
</ion-refresher>
</ion-content>

<!-- Custom Refresher Properties -->
<ion-content>
<ion-refresher slot="fixed" pullFactor="0.5" pullMin="100" pullMax="200">
<ion-refresher-content></ion-refresher-content>
</ion-refresher>
</ion-content>

<!-- Custom Refresher Content -->
<ion-content>
<ion-refresher slot="fixed" (ionRefresh)="doRefresh($event)">
<ion-refresher-content
pullingIcon="chevron-down-circle-outline"
pullingText="Pull to refresh"
refreshingSpinner="circles"
refreshingText="Refreshing...">
</ion-refresher-content>
</ion-refresher>
</ion-content>
import { Component } from '@angular/core';

@Component({
selector: 'refresher-example',
templateUrl: 'refresher-example.html',
styleUrls: ['./refresher-example.css'],
})
export class RefresherExample {
constructor() {}

doRefresh(event) {
console.log('Begin async operation');

setTimeout(() => {
console.log('Async operation has ended');
event.target.complete();
}, 2000);
}
}

Properties

closeDuration

DescriptionTime it takes to close the refresher.
Does not apply when the refresher content uses a spinner,
enabling the native refresher.
Attributeclose-duration
Typestring
Default'280ms'

disabled

DescriptionIf true, the refresher will be hidden.
Attributedisabled
Typeboolean
Defaultfalse

pullFactor

DescriptionHow 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 greater
than 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 by
10 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 amount
will 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.
Attributepull-factor
Typenumber
Default1

pullMax

DescriptionThe 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.
Attributepull-max
Typenumber
Defaultthis.pullMin + 60

pullMin

DescriptionThe 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.
Attributepull-min
Typenumber
Default60

snapbackDuration

DescriptionTime it takes the refresher to snap back to the refreshing state.
Does not apply when the refresher content uses a spinner,
enabling the native refresher.
Attributesnapback-duration
Typestring
Default'280ms'

Events

NameDescription
ionPullEmitted while the user is pulling down the content and exposing the refresher.
ionRefreshEmitted 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

DescriptionChanges the refresher's state from refreshing to cancelling.
Signaturecancel() => Promise<void>

complete

DescriptionCall 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.
Signaturecomplete() => Promise<void>

getProgress

DescriptionA 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.
SignaturegetProgress() => Promise<number>
View Source