Search docs/

ion-loading

Contents

ユーザインタラクションをブロックしながらアクティビティを示すためのオーバーレイです。ローディング・インジケータはアプリのコンテンツの上に表示され、ユーザーの操作を再開するために消すことができます。オプションでbackdropが含まれており、showBackdrop: false で無効にすることができます。

Creating

ローディング・インジケータは、 Loading Controller を使用して作成できます。これらは、Loading Controllersの create() メソッドにloadingのオプションを渡すことでカスタマイズできます。スピナー名は spinner プロパティに渡す必要があり、オプションのHTMLは content プロパティに渡すことができます。スピナーに値が渡されない場合、プラットフォームで指定されたスピナーがローディングインジケータで使用されます。

Dismissing

ローディング・インジケータは、ローディング・オプションの duration にミリ秒単位で設定することによって、一定時間後に自動的に閉じることができます。作成後にローディング・インジケータを終了するには、ロードインスタンスで dismiss() メソッドを呼び出します。onDidDismiss 関数は、ローディングインジケータが終了した後、アクションを実行するために呼び出すことができます。

利用方法

import { Component } from '@angular/core';
import { LoadingController } from '@ionic/angular';

@Component({
  selector: 'loading-example',
  templateUrl: 'loading-example.html',
  styleUrls: ['./loading-example.css']
})
export class LoadingExample {
  constructor(public loadingController: LoadingController) {}

  async presentLoading() {
    const loading = await this.loadingController.create({
      message: 'Hellooo',
      duration: 2000
    });
    await loading.present();

    const { role, data } = await loading.onDidDismiss();

    console.log('Loading dismissed!');
  }

  async presentLoadingWithOptions() {
    const loading = await this.loadingController.create({
      spinner: null,
      duration: 5000,
      message: 'Please wait...',
      translucent: true,
      cssClass: 'custom-class custom-loading'
    });
    return await loading.present();
  }
}
async function presentLoading() {
  const loading = document.createElement('ion-loading');
  loading.message: 'Hellooo',
  loading.duration: 2000;

  document.body.appendChild(loading);
  await loading.present();

  const { role, data } = await loading.onDidDismiss();

  console.log('Loading dismissed!');
}

function presentLoadingWithOptions() {
  const loading = document.createElement('ion-loading');
  loading.spinner = null;
  loading.duration = 5000;
  loading.message = 'Please wait...';
  loading.translucent = true;
  loading.cssClass = 'custom-class custom-loading';

  document.body.appendChild(loading);
  return loading.present();
}
import React, { useState } from 'react';
import { IonLoading, IonButton, IonContent } from '@ionic/react';

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

  setTimeout(() => {
    setShowLoading(false);
  }, 2000);

  return (
    <IonContent>
      <IonButton onClick={() => setShowLoading(true)}>Show Loading</IonButton>
      <IonLoading
        isOpen={showLoading}
        onDidDismiss={() => setShowLoading(false)}
        message={'Loading...'}
        duration={5000}
      />
    </IonContent>
  );
};
<template>
  <IonVuePage :title="'Loading'">
    <ion-button @click="presentLoading">Show Loading</ion-button>
    <br />
    <ion-button @click="presentLoadingWithOptions">Show Loading</ion-button>
  </IonVuePage>
</template>

<script>
export default {
  props: {
    timeout: { type: Number, default: 1000 },
  },
  methods: {
    presentLoading() {
      return this.$ionic.loadingController
        .create({
          message: 'Loading',
          duration: this.timeout,
        })
        .then(l => {
          setTimeout(function() {
            l.dismiss()
          }, this.timeout)
          return l.present()
        })
    },
    presentLoadingWithOptions() {
      return this.$ionic.loadingController
        .create({
          spinner: null,
          duration: this.timeout,
          message: 'Please wait...',
          translucent: true,
          cssClass: 'custom-class custom-loading',
        })
        .then(l => {
          setTimeout(function() {
            l.dismiss()
          }, this.timeout)
          return l.present()
        })
    },
  },
}
</script>

プロパティ

animated

Description

If true, the loading indicator will animate.

Attributeanimated
Typeboolean
Defaulttrue

backdropDismiss

Description

If true, the loading indicator will be dismissed when the backdrop is clicked.

Attributebackdrop-dismiss
Typeboolean
Defaultfalse

cssClass

Description

Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces.

Attributecss-class
Typestring | string[] | undefined

duration

Description

Number of milliseconds to wait before dismissing the loading indicator.

Attributeduration
Typenumber
Default0

enterAnimation

Description

Animation to use when the loading indicator is presented.

Type((Animation: Animation, baseEl: any, opts?: any) => Promise<Animation>) | undefined

keyboardClose

Description

If true, the keyboard will be automatically dismissed when the overlay is presented.

Attributekeyboard-close
Typeboolean
Defaulttrue

leaveAnimation

Description

Animation to use when the loading indicator is dismissed.

Type((Animation: Animation, baseEl: any, opts?: any) => Promise<Animation>) | undefined

message

Description

Optional text content to display in the loading indicator.

Attributemessage
Typestring | undefined

mode

Description

The mode determines which platform styles to use.

Attributemode
Type"ios" | "md"

showBackdrop

Description

If true, a backdrop will be displayed behind the loading indicator.

Attributeshow-backdrop
Typeboolean
Defaulttrue

spinner

Description

The name of the spinner to display.

Attributespinner
Type"bubbles" | "circles" | "circular" | "crescent" | "dots" | "lines" | "lines-small" | null | undefined

translucent

Description

If true, the loading indicator will be translucent. Only applies when the mode is "ios" and the device supports backdrop-filter.

Attributetranslucent
Typeboolean
Defaultfalse

イベント

NameDescription
ionLoadingDidDismissEmitted after the loading has dismissed.
ionLoadingDidPresentEmitted after the loading has presented.
ionLoadingWillDismissEmitted before the loading has dismissed.
ionLoadingWillPresentEmitted before the loading has presented.

メソッド

dismiss

Description

Dismiss the loading overlay after it has been presented.

Signaturedismiss(data?: any, role?: string | undefined) => Promise<boolean>

onDidDismiss

Description

Returns a promise that resolves when the loading did dismiss.

SignatureonDidDismiss() => Promise<OverlayEventDetail<any>>

onWillDismiss

Description

Returns a promise that resolves when the loading will dismiss.

SignatureonWillDismiss() => Promise<OverlayEventDetail<any>>

present

Description

Present the loading overlay after it has been created.

Signaturepresent() => Promise<void>

CSSカスタムプロパティ

NameDescription
--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
View Source