Notification
Overview
Notification は、ポップアップの通知を表示します。
Specification
Property
使用できるプロパティの一覧です。プロパティを指定して値を更新することができます。
| Name | Type | Default | Description | Remark |
|---|---|---|---|---|
| className | string | "" | コンポーネントの class 名 | |
| text | string | "" | 表示するテキスト | |
| type | string | "danger" | 背景色 | 以下を指定できる "danger" : Red(#e74c3c) "info" : Blue(#3498db) "success" : Green(#91c36c) |
| duration | number | -1 | コンポーネントを閉じるまでのミリ秒 | 単位はミリ秒 0以上の数値を指定できる もし不正な値を指定した場合（0未満もしくは数値以外）、コンポーネントは開かれたまま自動的には閉じない |
| container | HTMLElement | document.body | コンポーネントを追加する対象の要素 | デフォルトではトップレベルのドキュメントオブジェクトのボディを使うので、ほとんどの場合は document.body となる container が HTMLElement 以外の場合、エラーを出力する |
Event
指定できるイベントの一覧です。
| Name | Type | Description | Remark |
|---|---|---|---|
| close | function | コンポーネントが閉じられた時のイベントハンドラ | 引数には Event の event オブジェクトをとる |
Constructor
Notification(options)
使用できるコンストラクタの一覧です。
Parameter
| Name | Type | Default | Description | Remark |
|---|---|---|---|---|
| options | object | {} | コンポーネントのプロパティを含むオブジェクト |
Method
使用できるメソッドの一覧です。
open()
Notification を表示する
Parameter
none
Return
none
close()
Notification を非表示にする
Parameter
none
Return
none
Custom CSS
ヒント
Custom CSS をご確認ください。
コンポーネントのスタイルを変更するために使用できるプロパティの一覧です。
Property
| Name |
|---|
| --kuc-notification-font-size |
| --kuc-notification-color |
| --kuc-notification-background-color |
| --kuc-notification-close-button-background-color |
Sample Code
ヒント
導入と実装方法 をご確認ください。
全てのパラメータを指定した場合のサンプルコードです。
const Kuc = Kucs['1.x.x'];
const notification = new Kuc.Notification({
text: 'Error occurred!',
type: 'danger',
className: 'options-class',
duration: 2000,
container: document.body
});
notification.addEventListener('close', event => {
console.log(event);
});
notification.open();
notification.close();