ion-loading

scoped

可用于指示活动同时阻止用户交互的覆盖层。加载指示器显示在应用内容的顶部，应用可以将其关闭以恢复用户与应用的交互。它包括一个可选的背景，可以通过在创建时设置 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

加载使用作用域封装，这意味着它将通过在运行时为每个样式附加一个附加类来自动作用域其 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.

注意

ion-loading 出现在应用的根目录中，因此我们建议将任何 ion-loading 样式放置在全局样式表中。

¥ion-loading is presented at the root of your application, so we recommend placing any ion-loading styles in a global stylesheet.

无障碍

¥Accessibility

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

¥Ionic automatically sets Loading's role to dialog.

如果为加载定义了 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.

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

¥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.
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.
Signature	dismiss(data?: any, role?: string) => Promise<boolean>

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

插槽

¥Slots

No slots available for this component.