[フレーム]
Skip to main content
An OutSystems Company →
Version: v8

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

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

Description If true, the loading indicator will animate.
Attribute animated
Type boolean
Default true

backdropDismiss

Description If true, the loading indicator will be dismissed when the backdrop is clicked.
Attribute backdrop-dismiss
Type boolean
Default false

cssClass

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

duration

Description Number of milliseconds to wait before dismissing the loading indicator.
Attribute duration
Type number
Default 0

enterAnimation

Description Animation to use when the loading indicator is presented.
Attribute enter-animation
Type ((baseEl: any, opts?: any) => Animation) | undefined
Default undefined

htmlAttributes

Description Additional attributes to pass to the loader.
Attribute html-attributes
Type undefined | { [key: string]: any; }
Default undefined

isOpen

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

keyboardClose

Description If true, the keyboard will be automatically dismissed when the overlay is presented.
Attribute keyboard-close
Type boolean
Default true

leaveAnimation

Description Animation to use when the loading indicator is dismissed.
Attribute leave-animation
Type ((baseEl: any, opts?: any) => Animation) | undefined
Default undefined

message

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

mode

Description The mode determines which platform styles to use.

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

showBackdrop

Description If true, a backdrop will be displayed behind the loading indicator.
Attribute show-backdrop
Type boolean
Default true

spinner

Description The name of the spinner to display.
Attribute spinner
Type "bubbles" | "circles" | "circular" | "crescent" | "dots" | "lines" | "lines-sharp" | "lines-sharp-small" | "lines-small" | null | undefined
Default undefined

translucent

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

trigger

Description An ID corresponding to the trigger element that causes the loading indicator to open when clicked.
Attribute trigger
Type string | undefined
Default undefined

Events

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

Methods

dismiss

Description Dismiss the loading overlay after it has been presented. This is a no-op if the overlay has not been presented yet. If you want to remove an overlay from the DOM that was never presented, use the remove method.
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".

onDidDismiss

Description Returns a promise that resolves when the loading did dismiss.
Signature onDidDismiss<T = any>() => Promise<OverlayEventDetail<T>>

onWillDismiss

Description Returns a promise that resolves when the loading will dismiss.
Signature onWillDismiss<T = any>() => Promise<OverlayEventDetail<T>>

present

Description Present the loading overlay after it has been created.
Signature present() => Promise<void>

CSS Shadow Parts

No CSS shadow parts available for this component.

CSS Custom Properties

  • iOS
  • MD
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.

AltStyle によって変換されたページ (->オリジナル) /