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 | Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. |
| Attribute | css-class |
| Type | string ｜ string[] ｜ undefined |
| Default | undefined |
| Description | ローディングインジケータを解除するまでの待ち時間（ミリ秒）。 |
| Attribute | duration |
| Type | number |
| Default | 0 |
| Description | ローディングインジケータが表示されたときに使用するアニメーションです。 |
| Attribute | undefined |
| Type | ((baseEl: any, opts?: any) => Animation) ｜ undefined |
| Default | undefined |
| Description | ローダーに渡す追加属性。 |
| Attribute | undefined |
| Type | undefined ｜ { [key: string]: any; } |
| Default | undefined |
| Description | If true, the loading indicator will open. If false, the loading indicator will close. Use this if you need finer grained control over presentation, otherwise just use the loadingController or the trigger property. Note: isOpen will not automatically be set back to false when the loading indicator dismisses. You will need to do that in your code. |
| Attribute | is-open |
| Type | boolean |
| Default | false |
| Description | trueの場合、オーバーレイが表示されたときにキーボードが自動的に解除されます。 |
| Attribute | keyboard-close |
| Type | boolean |
| Default | true |
| Description | ローディングインジケータが解除されたときに使用するアニメーションです。 |
| Attribute | undefined |
| Type | ((baseEl: any, opts?: any) => Animation) ｜ undefined |
| Default | undefined |
| Description | Optional text content to display in the loading indicator.
This property accepts custom HTML as a string. Content is parsed as plaintext by default. innerHTMLTemplatesEnabled must be set to true in the Ionic config before custom HTML can be used. |
| Attribute | message |
| Type | IonicSafeString ｜ string ｜ undefined |
| Default | undefined |
| Description | modeは、どのプラットフォームのスタイルを使用するかを決定します。 |
| 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 | If true, the loading indicator will be translucent. Only applies when the mode is "ios" and the device supports backdrop-filter. |
| Attribute | translucent |
| Type | boolean |
| Default | false |
| Description | An ID corresponding to the trigger element that causes the loading indicator to open when clicked. |
| Attribute | trigger |
| Type | string ｜ undefined |
| Default | undefined |
| Name | Description | Bubbles |
|---|
didDismiss | Emitted after the loading indicator has dismissed. Shorthand for ionLoadingDidDismiss. | true |
didPresent | Emitted after the loading indicator has presented. Shorthand for ionLoadingWillDismiss. | true |
ionLoadingDidDismiss | ローディングが解除された後に発行されます。 | true |
ionLoadingDidPresent | ローディングが提示された後に発行されます。 | true |
ionLoadingWillDismiss | ローディングが解除される前に発行されます。 | true |
ionLoadingWillPresent | ローディングが提示される前に発行されます。 | true |
willDismiss | Emitted before the loading indicator has dismissed. Shorthand for ionLoadingWillDismiss. | true |
willPresent | Emitted before the loading indicator has presented. Shorthand for ionLoadingWillPresent. | true |
| Description | ローディングオーバーレイが提示された後、それを解除します。 |
| Signature | dismiss(data?: any, role?: string) => Promise<boolean> |
| 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 | ローディングダイアログの幅 |
No slots available for this component.