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

ion-loading

scoped

Contents

ユーザインタラクションをブロックしながらアクティビティを示すためのオーバーレイです。ローディング・インジケータはアプリのコンテンツの上に表示され、ユーザーの操作を再開するために消すことができます。オプションでbackdropが含まれており、showBackdrop: false で無効にすることができます。

Dismissing

ローディング・インジケータは、ローディング・オプションの duration にミリ秒単位で設定することによって、一定時間後に自動的に閉じることができます。作成後にローディング・インジケータを終了するには、ロードインスタンスで dismiss() メソッドを呼び出します。onDidDismiss 関数は、ローディングインジケータが終了した後、アクションを実行するために呼び出すことができます。

Customization

Loading uses scoped encapsulation, which means it will automatically scope its CSS by appending each of the styles with an additional class at runtime. Overriding scoped selectors in CSS requires a higher specificity selector.

We recommend passing a custom class to cssClass in the create method and using that to add custom styles to the host and inner elements. This property can also accept multiple classes separated by spaces. View the Usage section for an example of how to pass a class using cssClass.

/* DOES NOT WORK - not specific enough */
ion-loading {
color: green;
}

/* Works - pass "my-custom-class" in cssClass to increase specificity */
.my-custom-class {
color: green;
}

Any of the defined CSS Custom Properties can be used to style the Loading without needing to target individual elements:

.my-custom-class {
--background: #222;
--spinner-color: #fff;

color: #fff;
}
note

If you are building an Ionic Angular app, the styles need to be added to a global stylesheet file. Read Style Placement in the Angular section below for more information.

Interfaces

LoadingOptions

interface LoadingOptions {
spinner?: SpinnerTypes | null;
message?: string | IonicSafeString;
cssClass?: string | string[];
showBackdrop?: boolean;
duration?: number;
translucent?: boolean;
animated?: boolean;
backdropDismiss?: boolean;
mode?: Mode;
keyboardClose?: boolean;
id?: string;
htmlAttributes?: LoadingAttributes;

enterAnimation?: AnimationBuilder;
leaveAnimation?: AnimationBuilder;
}

LoadingAttributes

interface LoadingAttributes extends JSXBase.HTMLAttributes<HTMLElement> {}

Usage

import { Component } from '@angular/core';
import { LoadingController } from '@ionic/angular';

@Component({
selector: 'loading-example',
templateUrl: 'loading-example.html',
styleUrls: ['./loading-example.css']
})
export class LoadingExample {
constructor(public loadingController: LoadingController) {}

async presentLoading() {
const loading = await this.loadingController.create({
cssClass: 'my-custom-class',
message: 'Please wait...',
duration: 2000
});
await loading.present();

const { role, data } = await loading.onDidDismiss();
console.log('Loading dismissed!');
}

async presentLoadingWithOptions() {
const loading = await this.loadingController.create({
spinner: null,
duration: 5000,
message: 'Click the backdrop to dismiss early...',
translucent: true,
cssClass: 'custom-class custom-loading',
backdropDismiss: true
});
await loading.present();

const { role, data } = await loading.onDidDismiss();
console.log('Loading dismissed with role:', role);
}
}

Style Placement

In Angular, the CSS of a specific page is scoped only to elements of that page. Even though the Loading can be presented from within a page, the ion-loading element is appended outside of the current page. This means that any custom styles need to go in a global stylesheet file. In an Ionic Angular starter this can be the src/global.scss file or you can register a new global style file by adding to the styles build option in angular.json.

Properties

animated

DescriptionIf true, the loading indicator will animate.
Attributeanimated
Typeboolean
Defaulttrue

backdropDismiss

DescriptionIf true, the loading indicator will be dismissed when the backdrop is clicked.
Attributebackdrop-dismiss
Typeboolean
Defaultfalse

cssClass

DescriptionAdditional classes to apply for custom CSS. If multiple classes are
provided they should be separated by spaces.
Attributecss-class
Typestring | string[] | undefined
Defaultundefined

duration

DescriptionNumber of milliseconds to wait before dismissing the loading indicator.
Attributeduration
Typenumber
Default0

enterAnimation

DescriptionAnimation to use when the loading indicator is presented.
Attributeundefined
Type((baseEl: any, opts?: any) => Animation) | undefined
Defaultundefined

htmlAttributes

DescriptionAdditional attributes to pass to the loader.
Attributeundefined
TypeLoadingAttributes | undefined
Defaultundefined

keyboardClose

DescriptionIf true, the keyboard will be automatically dismissed when the overlay is presented.
Attributekeyboard-close
Typeboolean
Defaulttrue

leaveAnimation

DescriptionAnimation to use when the loading indicator is dismissed.
Attributeundefined
Type((baseEl: any, opts?: any) => Animation) | undefined
Defaultundefined

message

DescriptionOptional text content to display in the loading indicator.
Attributemessage
TypeIonicSafeString | string | undefined
Defaultundefined

mode

DescriptionThe mode determines which platform styles to use.
Attributemode
Type"ios" | "md"
Defaultundefined

showBackdrop

DescriptionIf true, a backdrop will be displayed behind the loading indicator.
Attributeshow-backdrop
Typeboolean
Defaulttrue

spinner

DescriptionThe name of the spinner to display.
Attributespinner
Type"bubbles" | "circles" | "circular" | "crescent" | "dots" | "lines" | "lines-sharp" | "lines-sharp-small" | "lines-small" | null | undefined
Defaultundefined

translucent

DescriptionIf true, the loading indicator will be translucent.
Only applies when the mode is "ios" and the device supports
backdrop-filter.
Attributetranslucent
Typeboolean
Defaultfalse

Events

NameDescription
ionLoadingDidDismissEmitted after the loading has dismissed.
ionLoadingDidPresentEmitted after the loading has presented.
ionLoadingWillDismissEmitted before the loading has dismissed.
ionLoadingWillPresentEmitted before the loading has presented.

Methods

dismiss

DescriptionDismiss the loading overlay after it has been presented.
Signaturedismiss(data?: any, role?: string | undefined) => Promise<boolean>

onDidDismiss

DescriptionReturns a promise that resolves when the loading did dismiss.
SignatureonDidDismiss<T = any>() => Promise<OverlayEventDetail<T>>

onWillDismiss

DescriptionReturns a promise that resolves when the loading will dismiss.
SignatureonWillDismiss<T = any>() => Promise<OverlayEventDetail<T>>

present

DescriptionPresent the loading overlay after it has been created.
Signaturepresent() => Promise<void>

CSS Custom Properties

NameDescription
--backdrop-opacityOpacity of the backdrop
--backgroundBackground of the loading dialog
--heightHeight of the loading dialog
--max-heightMaximum height of the loading dialog
--max-widthMaximum width of the loading dialog
--min-heightMinimum height of the loading dialog
--min-widthMinimum width of the loading dialog
--spinner-colorColor of the loading spinner
--widthWidth of the loading dialog
View Source