メインコンテンツまでスキップ
バージョン: 1.16.0

Spinner

Overview

Spinner は、ローディングスピナーを表示します。


Specification

Property

使用できるプロパティの一覧です。プロパティを指定して値を更新することができます。

NameTypeDefaultDescriptionRemark
textstring""ローダーアイコン下部に表示するテキストtext が未指定、あるいは空文字の場合*は、初期値を表示する
containerHTMLElementdocument.bodyコンポーネントを追加する対象の要素デフォルトではトップレベルのドキュメントオブジェクトのボディを使うので、ほとんどの場合は document.body となる
container が HTMLElement 以外の場合、エラーを出力する
備考

text が未指定、あるいは空文字の場合は、アクセシビリティを考慮して visually-hidden class を付与し、"now loading…" の文言を視覚的に見えない状態で表示する。

Constructor

Spinner(options)
使用できるコンストラクタの一覧です。

Parameter

NameTypeDefaultDescriptionRemark
optionsobject{}コンポーネントのプロパティを含むオブジェクト

Method

使用できるメソッドの一覧です。

open()

コンポーネントを表示する

Parameter

none

Return

none

close()

コンポーネントを非表示にする

Parameter

none

Return

none

Custom CSS

ヒント

Custom CSS をご確認ください。

コンポーネントのスタイルを変更するために使用できるプロパティの一覧です。

Property

Name
--kuc-spinner-loader-width
--kuc-spinner-loader-height
--kuc-spinner-loader-color
--kuc-spinner-text-font-size
--kuc-spinner-text-color

Sample Code

ヒント

導入と実装方法 をご確認ください。

全てのパラメータを指定した場合のサンプルコードです。

const Kuc = Kucs['1.x.x'];

const spinner = new Kuc.Spinner({
text: 'now loading...',
container: document.body
});

spinner.open();
spinner.close();