ion-loading

一种覆盖层，可用于在阻止用户交互的同时指示活动状态。加载指示器会显示在应用内容之上，并且可以由应用关闭以恢复用户与应用的交互。它包括一个可选的背景幕，通过在创建时设置 showBackdrop: false 可以禁用。

🌐 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

一旦显示，加载指示器默认将无限期显示。开发者可以在创建后通过调用组件上的 dismiss() 方法手动关闭加载指示器。在加载指示器关闭后，可以调用 onDidDismiss 函数来执行某个操作。

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

或者，开发者可以通过在加载选项的 duration 中传递显示的毫秒数来配置加载指示器在特定时间后自动消失。

🌐 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

使用的加载指示器可以通过 spinner 属性进行自定义。完整的选项列表请参见 spinner 属性文档。

🌐 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 使用范围封装，这意味着它会在运行时通过为每个样式附加一个额外的类来自动设置其 CSS 范围。要在 CSS 中覆盖范围选择器，需要使用一个更高特异性的选择器。

🌐 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 被放置在你的应用根目录，因此我们建议将任何 ion-loading 样式放在全局样式表中。

无障碍

🌐 Accessibility

Ionic 会自动将 Loading 的 role 设置为 dialog。

🌐 Ionic automatically sets Loading's role to dialog.

如果为 Loading 定义了 message 属性，则 aria-labelledby 属性将自动设置为消息元素的 ID。否则，aria-labelledby 将不会被设置，开发者必须使用 htmlAttributes 属性提供一个 aria-label。

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

所有 ARIA 属性都可以通过在 Loading 的 htmlAttributes 属性中定义自定义值来手动覆盖。

🌐 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

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	`undefined`
Type	`((baseEl: any, opts?: any) => Animation) ｜ undefined`
Default	`undefined`

htmlAttributes

Description	Additional attributes to pass to the loader.
Attribute	`undefined`
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	`undefined`
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

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

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 阴影部分

🌐 CSS Shadow Parts

No CSS shadow parts available for this component.

CSS 自定义属性

🌐 CSS Custom Properties

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.

基本用法​

内联（推荐）​

控制器​

定制化​

微调控件​

主题化​

无障碍​

接口​

LoadingOptions​

属性​

animated​

backdropDismiss​

cssClass​

duration​

enterAnimation​

htmlAttributes​

isOpen​

keyboardClose​

leaveAnimation​

message​

mode​

showBackdrop​

spinner​

translucent​

trigger​

事件​

方法​

dismiss​

onDidDismiss​

onWillDismiss​

present​

CSS 阴影部分​

CSS 自定义属性​

插槽​

目录