ion-loading
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.
Basic Usage
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.
Inline (Recommended)
Controller
Customization
Spinners
The spinner that is used can be customized using the spinner
property. See the spinner property documentation for a full list of options.
Theming
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.
Accessibility
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.
Interfaces
LoadingOptions
interfaceLoadingOptions{
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;
}
Properties
animated
true
, the loading indicator will animate.animated
boolean
true
backdropDismiss
true
, the loading indicator will be dismissed when the backdrop is clicked.backdrop-dismiss
boolean
false
cssClass
css-class
string | string[] | undefined
undefined
duration
duration
number
0
enterAnimation
enter-animation
((baseEl: any, opts?: any) => Animation) | undefined
undefined
htmlAttributes
html-attributes
undefined | { [key: string]: any; }
undefined
isOpen
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.is-open
boolean
false
keyboardClose
true
, the keyboard will be automatically dismissed when the overlay is presented.keyboard-close
boolean
true
leaveAnimation
leave-animation
((baseEl: any, opts?: any) => Animation) | undefined
undefined
message
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.message
IonicSafeString | string | undefined
undefined
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.
mode
"ios" | "md"
undefined
showBackdrop
true
, a backdrop will be displayed behind the loading indicator.show-backdrop
boolean
true
spinner
spinner
"bubbles" | "circles" | "circular" | "crescent" | "dots" | "lines" | "lines-sharp" | "lines-sharp-small" | "lines-small" | null | undefined
undefined
translucent
true
, the loading indicator will be translucent. Only applies when the mode is "ios"
and the device supports backdrop-filter
.translucent
boolean
false
trigger
trigger
string | undefined
undefined
Events
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 | Emitted after the loading has dismissed. | true |
ionLoadingDidPresent | Emitted after the loading has presented. | true |
ionLoadingWillDismiss | Emitted before the loading has dismissed. | true |
ionLoadingWillPresent | Emitted before the loading has presented. | 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 |
Methods
dismiss
dismiss(data?: any, role?: string) => Promise<boolean>
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"
.onDidDismiss
onDidDismiss<T = any>() => Promise<OverlayEventDetail<T>>
onWillDismiss
onWillDismiss<T = any>() => Promise<OverlayEventDetail<T>>
present
present() => Promise<void>
CSS Shadow Parts
No CSS shadow parts available for this component.
CSS Custom Properties
- iOS
- MD
Name | Description |
---|---|
--backdrop-opacity | Opacity of the backdrop |
--background | Background of the loading dialog |
--height | Height of the loading dialog |
--max-height | Maximum height of the loading dialog |
--max-width | Maximum width of the loading dialog |
--min-height | Minimum height of the loading dialog |
--min-width | Minimum width of the loading dialog |
--spinner-color | Color of the loading spinner |
--width | Width of the loading dialog |
Name | Description |
---|---|
--backdrop-opacity | Opacity of the backdrop |
--background | Background of the loading dialog |
--height | Height of the loading dialog |
--max-height | Maximum height of the loading dialog |
--max-width | Maximum width of the loading dialog |
--min-height | Minimum height of the loading dialog |
--min-width | Minimum width of the loading dialog |
--spinner-color | Color of the loading spinner |
--width | Width of the loading dialog |
Slots
No slots available for this component.