Version: v6

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.

Controller

Inline

Ionic React and Ionic Vue users also have the option to use the ion-loading component directly in their template.

React
Vue

import React, { useState } from 'react';
import { IonLoading, IonButton, IonContent } from '@ionic/react';

export const LoadingExample: React.FC = () => {
  const [showLoading, setShowLoading] = useState(false);

  return (
    <IonContent>
      <IonButton onClick={() => setShowLoading(true)}>Show Loading</IonButton>
      <IonLoading
        cssClass="my-custom-class"
        isOpen={showLoading}
        onDidDismiss={() => setShowLoading(false)}
        message={'Please wait...'}
        duration={5000}
      />
    </IonContent>
  );
};

<template>
  <ion-content>
    <ion-button @click="setOpen(true)">Show Loading</ion-button>
    <ion-loading
      :is-open="isOpenRef"
      cssClass="my-custom-class"
      message="Please wait..."
      :duration="timeout"
      @didDismiss="setOpen(false)"
    >
    </ion-loading>
  </ion-content>
</template>

<script lang="ts">
  import { IonButton, IonContent, IonLoading } from '@ionic/vue';
  import { defineComponent, ref } from 'vue';
  export default defineComponent({
    props: {
      timeout: { type: Number, default: 1000 },
    },
    components: { IonButton, IonContent, IonLoading },
    setup() {
      const isOpenRef = ref(false);
      const setOpen = (state: boolean) => (isOpenRef.value = state);

      return { isOpenRef, setOpen };
    },
  });
</script>

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.

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	`true`の場合、ロードインジケータをアニメーションで表示します。
Attribute	`animated`
Type	`boolean`
Default	`true`

backdropDismiss

Description	`true`の場合、バックドロップがクリックされたときにローディングインジケータが解除される。
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	ローディングインジケータを解除するまでの待ち時間（ミリ秒）。
Attribute	`duration`
Type	`number`
Default	`0`

enterAnimation

Description	ローディングインジケータが表示されたときに使用するアニメーションです。
Attribute	`undefined`
Type	`((baseEl: any, opts?: any) => Animation) ｜ undefined`
Default	`undefined`

htmlAttributes

Description	ローダーに渡す追加属性。
Attribute	`undefined`
Type	`undefined ｜ { [key: string]: any; }`
Default	`undefined`

keyboardClose

Description	`true`の場合、オーバーレイが表示されたときにキーボードが自動的に解除されます。
Attribute	`keyboard-close`
Type	`boolean`
Default	`true`

leaveAnimation

Description	ローディングインジケータが解除されたときに使用するアニメーションです。
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. Developers who only want to pass plain text can disable the custom HTML functionality by setting `innerHTMLTemplatesEnabled: false` in the Ionic config.
Attribute	`message`
Type	`IonicSafeString ｜ string ｜ undefined`
Default	`undefined`

mode

Description	modeは、どのプラットフォームのスタイルを使用するかを決定します。
Attribute	`mode`
Type	`"ios" ｜ "md"`
Default	`undefined`

showBackdrop

Description	`true`の場合、ロードインジケータの後ろにバックドロップが表示されます。
Attribute	`show-backdrop`
Type	`boolean`
Default	`true`

spinner

Description	表示するスピナーの名前。
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`

Events

Name	Description
`ionLoadingDidDismiss`	ローディングが解除された後に発行されます。
`ionLoadingDidPresent`	ローディングが提示された後に発行されます。
`ionLoadingWillDismiss`	ローディングが解除される前に発行されます。
`ionLoadingWillPresent`	ローディングが提示される前に発行されます。

Methods

dismiss

Description	ローディングオーバーレイが提示された後、それを解除します。
Signature	`dismiss(data?: any, role?: string) => Promise<boolean>`

onDidDismiss

Description	ローディングが解除されたタイミングを解決するPromiseを返します。
Signature	`onDidDismiss<T = any>() => Promise<OverlayEventDetail<T>>`

onWillDismiss

Description	ローディングが解除されるタイミングを解決するPromiseを返します。
Signature	`onWillDismiss<T = any>() => Promise<OverlayEventDetail<T>>`

present

Description	作成後のローディングオーバーレイを提示します。
Signature	`present() => Promise<void>`

CSS Shadow Parts

No CSS shadow parts available for this component.

CSS Custom Properties

Name	Description
`--backdrop-opacity`	背景の不透明度
`--background`	ローディングダイアログの背景
`--height`	ローディングダイアログの高さ
`--max-height`	ローディングダイアログの最大の高さ
`--max-width`	ローディングダイアログの最大幅
`--min-height`	ローディングダイアログの最小高さ
`--min-width`	ローディングダイアログの最小幅
`--spinner-color`	ローディングスピナーの色
`--width`	ローディングダイアログの幅

Slots

No slots available for this component.

Basic Usage​

Controller​

Inline​

Customization​

Spinners​

Theming​

note

Interfaces​

LoadingOptions​

Properties​

animated​

backdropDismiss​

cssClass​

duration​

enterAnimation​

htmlAttributes​

keyboardClose​

leaveAnimation​

message​

mode​

showBackdrop​

spinner​

translucent​

Events​

Methods​

dismiss​

onDidDismiss​

onWillDismiss​

present​

CSS Shadow Parts​

CSS Custom Properties​

Slots​

Contents

Basic Usage

Controller

Inline

Customization

Spinners

Theming

Interfaces

LoadingOptions

Properties

animated

backdropDismiss

cssClass

duration

enterAnimation

htmlAttributes

keyboardClose

leaveAnimation

message

mode

showBackdrop

spinner

translucent

Events

Methods

dismiss

onDidDismiss

onWillDismiss

present

CSS Shadow Parts

CSS Custom Properties

Slots