Skip to main content
Version: v7

ion-loading

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.

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.

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.

note

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

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;
}

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
Typeundefined | { [key: string]: any; }
Defaultundefined

isOpen

DescriptionIf 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.
Attributeis-open
Typeboolean
Defaultfalse

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.

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

trigger

DescriptionAn ID corresponding to the trigger element that causes the loading indicator to open when clicked.
Attributetrigger
Typestring | undefined
Defaultundefined

Events

NameDescription
didDismissEmitted after the loading indicator has dismissed. Shorthand for ionLoadingDidDismiss.
didPresentEmitted after the loading indicator has presented. Shorthand for ionLoadingWillDismiss.
ionLoadingDidDismissEmitted after the loading has dismissed.
ionLoadingDidPresentEmitted after the loading has presented.
ionLoadingWillDismissEmitted before the loading has dismissed.
ionLoadingWillPresentEmitted before the loading has presented.
willDismissEmitted before the loading indicator has dismissed. Shorthand for ionLoadingWillDismiss.
willPresentEmitted before the loading indicator has presented. Shorthand for ionLoadingWillPresent.

Methods

dismiss

DescriptionDismiss the loading overlay after it has been presented.
Signaturedismiss(data?: any, role?: string) => 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 Shadow Parts

No CSS shadow parts available for this component.

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

Slots

No slots available for this component.