scoped
An overlay that can be used to indicate activity while blocking user interaction. The loading indicator appears on top of the app's content, and can be dismissed by the app to resume user interaction with the app. It includes an optional backdrop, which can be disabled by setting showBackdrop: false upon creation.
Once presented, the loading indicator will display indefinitely by default. Developers can manually dismiss the loading indicator after creation by calling the dismiss() method on the component. The onDidDismiss function can be called to perform an action after the loading indicator is dismissed.
Alternatively, developers can configure the loading indicator to dismiss automatically after a specific amount of time by passing the number of milliseconds to display it in the duration of the loading options.
The spinner that is used can be customized using the spinner property. See the spinner property documentation for a full list of options.
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 and using that to add custom styles to the host and inner elements.
ion-loading is presented at the root of your application, so we recommend placing any ion-loading styles in a global stylesheet.
Ionic automatically sets Loading's role to dialog.
If the message property is defined for Loading, then the aria-labelledby attribute will be automatically set to the message element's ID. Otherwise, aria-labelledby will not be set, and developers must provide an aria-label using the htmlAttributes property.
All ARIA attributes can be manually overwritten by defining custom values in the htmlAttributes property of Loading.
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?: { [key: string]: any };
enterAnimation?: AnimationBuilder;
leaveAnimation?: AnimationBuilder;
}
| Description | trueの場合、ロードインジケータをアニメーションで表示します。 |
| Attribute | animated |
| Type | boolean |
| Default | true |
| Description | trueの場合、バックドロップがクリックされたときにローディングインジケータが解除される。 |
| Attribute | backdrop-dismiss |
| Type | boolean |
| Default | false |
| Description | カスタムCSSに適用する追加のクラス。複数のクラスを指定する場合は、スペースで区切る必要があります。 |
| Attribute | css-class |
| Type | string ｜ string[] ｜ undefined |
| Default | undefined |
| Description | ローディングインジケータを解除するまでの待ち時間（ミリ秒）。 |
| Attribute | duration |
| Type | number |
| Default | 0 |
| Description | ローディングインジケータが表示されたときに使用するアニメーションです。 |
| Attribute | enter-animation |
| Type | ((baseEl: any, opts?: any) => Animation) ｜ undefined |
| Default | undefined |
| Description | ローダーに渡す追加属性。 |
| Attribute | html-attributes |
| Type | undefined ｜ { [key: string]: any; } |
| Default | undefined |
| Description | trueの場合、ローディングインジケータは開きます。falseの場合、ローディングインジケータは閉じます。より細かく表示を制御したい場合に使用します。そうでない場合は、loadingController または trigger プロパティを使用してください。注意: ローディングインジケータが終了しても、isOpenは自動的に falseに戻されません。あなたのコードでそれを行う必要があります。 |
| Attribute | is-open |
| Type | boolean |
| Default | false |
| Description | trueの場合、オーバーレイが表示されたときにキーボードが自動的に解除されます。 |
| Attribute | keyboard-close |
| Type | boolean |
| Default | true |
| Description | ローディングインジケータが解除されたときに使用するアニメーションです。 |
| Attribute | leave-animation |
| Type | ((baseEl: any, opts?: any) => Animation) ｜ undefined |
| Default | undefined |
| Description | ローディングインジケータに表示するテキストコンテンツを任意で指定します。 このプロパティは、文字列としてカスタムHTMLを受け入れます。コンテンツはデフォルトでプレーンテキストとしてパースされます。カスタムHTMLを使用するには、Ionicの設定で innerHTMLTemplatesEnabled を true に設定する必要があります。 |
| Attribute | message |
| Type | IonicSafeString ｜ string ｜ undefined |
| Default | undefined |
| Description | modeは、どのプラットフォームのスタイルを使用するかを決定します。
This is a virtual property that is set once during initialization and will not update if you change its value after the initial render. |
| Attribute | mode |
| Type | "ios" ｜ "md" |
| Default | undefined |
| Description | trueの場合、ロードインジケータの後ろにバックドロップが表示されます。 |
| Attribute | show-backdrop |
| Type | boolean |
| Default | true |
| Description | 表示するスピナーの名前。 |
| Attribute | spinner |
| Type | "bubbles" ｜ "circles" ｜ "circular" ｜ "crescent" ｜ "dots" ｜ "lines" ｜ "lines-sharp" ｜ "lines-sharp-small" ｜ "lines-small" ｜ null ｜ undefined |
| Default | undefined |
| Description | trueの場合、ロードインジケータは半透明になります。modeが "ios" で、デバイスが backdrop-filter をサポートしている場合にのみ適用されます。 |
| Attribute | translucent |
| Type | boolean |
| Default | false |
| Description | クリックするとローディングインジケータが開くトリガー要素に対応するIDです。 |
| Attribute | trigger |
| Type | string ｜ undefined |
| Default | undefined |
| Name | Description | Bubbles |
|---|
didDismiss | ローディングインジケータが解除された後に発行されます。ionLoadingDidDismissの略記。 | true |
didPresent | ローディングインジケータが提示された後に放出される。ionLoadingWillDismissの略記。 | true |
ionLoadingDidDismiss | ローディングが解除された後に発行されます。 | true |
ionLoadingDidPresent | ローディングが提示された後に発行されます。 | true |
ionLoadingWillDismiss | ローディングが解除される前に発行されます。 | true |
ionLoadingWillPresent | ローディングが提示される前に発行されます。 | true |
willDismiss | ローディングインジケータが解散する前に発行されます。ionLoadingWillDismissの略記です。 | true |
willPresent | ローディングインジケータが提示される前に発行されます。ionLoadingWillPresentの略記。 | true |
| Description | ローディングのオーバーレイが表示された後に閉じます。オーバーレイがまだ表示されていない場合は何もしません。表示されなかったオーバーレイを DOM から削除するには、remove メソッドを使用してください。 |
| Signature | dismiss(data?: any, role?: string) => Promise<boolean> |
| Parameters | data: Any data to emit in the dismiss events.
role: The role of the element that is dismissing the loading. This can be useful in a button handler for determining which button was clicked to dismiss the loading. Some examples include: "cancel", "destructive", "selected", and "backdrop". |
| Description | ローディングが解除されたタイミングを解決するPromiseを返します。 |
| Signature | onDidDismiss<T = any>() => Promise<OverlayEventDetail<T>> |
| Description | ローディングが解除されるタイミングを解決するPromiseを返します。 |
| Signature | onWillDismiss<T = any>() => Promise<OverlayEventDetail<T>> |
| Description | 作成後のローディングオーバーレイを提示します。 |
| Signature | present() => Promise<void> |
No CSS shadow parts available for this component.
| Name | Description |
|---|
--backdrop-opacity | 背景の不透明度 |
--background | ローディン グダイアログの背景 |
--height | ローディングダイアログの高さ |
--max-height | ローディングダイアログの最大の高さ |
--max-width | ローディングダイアログの最大幅 |
--min-height | ローディングダイアログの最小高さ |
--min-width | ローディングダイアログの最小幅 |
--spinner-color | ローディングスピナーの色 |
--width | ローディングダイアログの幅 |
| Name | Description |
|---|
--backdrop-opacity | 背景の不透明度 |
--background | ローディングダイアログの背景 |
--height | ローディングダイアログの高さ |
--max-height | ローディングダイアログの最大の高さ |
--max-width | ローディングダイアログの最大幅 |
--min-height | ローディングダイアログの最小高さ |
--min-width | ローディングダイアログの最小幅 |
--spinner-color | ローディングスピナーの色 |
--width | ローディングダイアログの幅 |
No slots available for this component.