mcpField
S
syncfusion-javascript-notifications

syncfusion-javascript-notifications

github.com/syncfusion開発039 回インストール5 日前に更新
リポジトリ

syncfusion-javascript-notifications について

このスキルは、ユーザー向けフィードバック画面を構築する開発者のために、Syncfusion EJ2 JavaScriptの通知コンポーネントを解説します。Message、Skeleton、Toastの使用例、API、テーマ、アクセシビリティの手引きを扱います。

主な機能

  1. 01Messageの重要度と表示バリエーション
  2. 02Skeletonの形状とシマー効果
  3. 03Toastの表示時間、位置、アクション
  4. 04TypeScriptとJavaScriptのAPIガイド
  5. 05アクセシビリティとキーボード操作

活用シーン

  1. 01成功やエラーの状況別メッセージ表示
  2. 02プレースホルダーによる読み込み状態の表示
  3. 03閉じる操作や常時表示が可能な通知

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/syncfusion/javascript-ui-controls-skills --skill syncfusion-javascript-notifications

インストール後、Claude Code で/syncfusion-javascript-notificationsを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
message-accessibility.md
message-api.md
message-customization.md
message-getting-started.md
message-icons-and-close.md
message-severities.md
message-variants.md
skeleton-accessibility.md
skeleton-api.md
skeleton-getting-started.md
skeleton-shapes.md
skeleton-shimmer-effect.md
skeleton-styles.md
toast-accessibility.md
toast-animation.md
toast-api.md
toast-configuration.md
toast-getting-started.md
toast-position.md
toast-services.md
toast-templates-and-styling.md
toast-timeout-and-dismissal.md

詳細

Syncfusion EJ2 JavaScript 通知

概要

Syncfusion EJ2 JavaScript Notifications ライブラリは、インタラクティブなユーザーフィードバックシステムを構築するための3つの基本的な UI コンポーネントを提供します。各コンポーネントのドキュメントには、TypeScript/JavaScript の例、アクセシビリティガイドライン、一般的な使用パターンが詳しく記載されています。

すべてのコンポーネントが以下をサポートしています。

  • アクセシビリティ: WCAG 2.2 レベル AA、Section 508、ADA に準拠
  • テーマ: Material 3、Bootstrap 5、Fluent、Tailwind 3、Fabric
  • API: イベントを完全にサポートする命令型 TypeScript/JavaScript
  • キーボード: キーボードによる完全なナビゲーションと操作

コンポーネントの概要

クイックナビゲーション
コンポーネント用途パッケージファイル
Message重要度インジケーターを備えたコンテキストメッセージej2-notifications7
Skeletonアニメーション付きの読み込みプレースホルダーej2-notifications6
Toast短時間表示され、自動的に消える通知ej2-notifications9

パッケージ: @syncfusion/ej2-notifications


Message コンポーネント

用途: 視覚的な重要度インジケーター(アイコンと色)を備えたコンテキストメッセージを表示し、エンドユーザーに重要性や状況を伝えます。5段階の重要度、3種類の表示バリエーション、閉じるアイコンによる非表示、カスタムテンプレート、アクセシビリティへの完全な準拠をサポートします。

パッケージ: @syncfusion/ej2-notifications

クイックサンプル
import { Message } from '@syncfusion/ej2-notifications';

let msg: Message = new Message({
  content: 'Please read the comments carefully',
  severity: 'Info'
});
msg.appendTo('#msg');
ドキュメント

Skeleton コンポーネント

用途: 読み込み中のコンテンツのレイアウトを模したアニメーション付きのプレースホルダー図形を描画します。設定可能な図形、シマーアニメーション、アクセシビリティへの完全な対応により、体感上の読み込み時間を短縮し、ユーザーに進行状況を伝えます。

パッケージ: @syncfusion/ej2-notifications

クイックサンプル
import { Skeleton } from '@syncfusion/ej2-notifications';

let skeleton: Skeleton = new Skeleton({
  shape: 'Circle',
  width: '48px'
});
skeleton.appendTo('#skeleton');
ドキュメント

Toast コンポーネント

用途: 設定可能なタイムアウト後に自動的に消える、短時間表示の控えめな通知を表示します。テンプレートによるリッチコンテンツ、アクションボタン、表示/終了時のアニメーション、正確な位置指定、ToastUtility によるプログラム制御をサポートします。

パッケージ: @syncfusion/ej2-notifications

クイックサンプル
import { Toast } from '@syncfusion/ej2-notifications';

let toastObj: Toast = new Toast({
  title: 'Success!',
  content: 'Your changes have been saved.',
  position: { X: 'Right', Y: 'Bottom' },
  timeOut: 4000,
  showCloseButton: true
});
toastObj.appendTo('#toast');
toastObj.show();
クイック Utility Toast(コンポーネント不要)
import { ToastUtility } from '@syncfusion/ej2-notifications';

// Show a success toast instantly
ToastUtility.show('File saved successfully', 'Success', 3000);

// Show an error toast
ToastUtility.show('Connection failed', 'Error', 5000);
ドキュメント

インストールとセットアップ

パッケージのインストール
npm install @syncfusion/[email protected] --save
npm audit
CSSテーマのインポートを追加する
/* src/styles.css */
@import '../node_modules/@syncfusion/ej2-base/styles/tailwind3.css';
@import '../node_modules/@syncfusion/ej2-notifications/styles/tailwind3.css';

その他の利用可能なテーマ:material.css、bootstrap5.css、fluent.css、fabric.css


よく使われるパターン

セマンティックな種類のメッセージ

severityプロパティにNormal、Success、Info、Warning、Errorを指定すると、視覚的に区別できます。

let msg: Message = new Message({
  content: 'Operation completed',
  severity: 'Success',
  variant: 'Outlined'
});
msg.appendTo('#msg');
閉じることができるメッセージ

showCloseIcon: trueとshowCloseButton: true(Toastの場合)を設定すると、ユーザーが通知を手動で閉じられるようになります。

let toastObj: Toast = new Toast({
  content: 'Your session will expire soon',
  showCloseButton: true,
  timeOut: 0
});
toastObj.appendTo('#toast');
toastObj.show();
Skeletonを使った読み込み状態

コンテンツの読み込み中にSkeletonプレースホルダーを表示し、コンテンツの準備ができたら非表示にします。

let skeleton: Skeleton = new Skeleton({
  shape: 'Rectangle',
  width: '100%',
  height: '200px',
  shimmerEffect: 'Pulse'
});
skeleton.appendTo('#skeleton');
静的/永続的なToast

ユーザーが明示的に閉じる必要のある通知には、showCloseButton: trueとtimeOut: 0を設定します。

let toastObj: Toast = new Toast({
  content: 'Please review and confirm',
  timeOut: 0,
  showCloseButton: true
});
toastObj.appendTo('#toast');
toastObj.show();
アクションが必要なToast

buttonsプロパティを使って、無視/確認/元に戻すボタンを追加します。

let toastObj: Toast = new Toast({
  content: 'Delete this file?',
  buttons: [{
    model: { content: 'Yes' },
    click: () => { /* handle yes */ }
  }, {
    model: { content: 'No' },
    click: () => toastObj.hide()
  }]
});
toastObj.appendTo('#toast');
toastObj.show();
複数のToastの配置

画面上の異なる位置に、複数のToastインスタンスを表示します。

let topToast: Toast = new Toast({
  content: 'Top notification',
  position: { X: 'Center', Y: 'Top' }
});
topToast.appendTo('#top-toast');
topToast.show();

テーマのサポート

すべての通知コンポーネントは、次のテーマをサポートしています。

テーマCSSファイル
Material 3material.css
Bootstrap 5bootstrap5.css
Fluentfluent.css
Tailwind 3tailwind3.css
Fabricfabric.css

テーマごとのインポート例:

/* Material 3 */
@import '../node_modules/@syncfusion/ej2-base/styles/material.css';
@import '../node_modules/@syncfusion/ej2-notifications/styles/material.css';

/* Bootstrap 5 */
@import '../node_modules/@syncfusion/ej2-base/styles/bootstrap5.css';
@import '../node_modules/@syncfusion/ej2-notifications/styles/bootstrap5.css';

アクセシビリティ

すべての通知コンポーネントは、WCAG 2.2 レベルAA、Section 508、ADAの基準に準拠しています。

メッセージのアクセシビリティ
  • WAI-ARIA属性(role=alert、aria-label)
  • キーボード操作(Tab、Enter/Space)
  • スクリーンリーダーのサポート
Skeletonのアクセシビリティ
  • WAI-ARIA属性:role="status"、aria-label、aria-live、aria-busy
  • アクセシブルなSkeleton名を指定するlabelプロパティ
  • prefers-reduced-motionへの対応
Toastのアクセシビリティ
  • WAI-ARIA:role="alert"、aria-live="assertive"、aria-label
  • スクリーンリーダーのサポート(JAWS、NVDA、VoiceOver)
  • enableRtlによるRTLのサポート
  • モバイルとアクセシビリティチェッカーによる検証

ブラウザーのサポート

  • Chrome(最新版)
  • Firefox(最新版)
  • Safari(最新版)
  • Edge(最新版)
  • Internet Explorer 11(ポリフィルが必要)

バージョンの互換性

Syncfusion EJ2のバージョンステータス
33.x.x現行(推奨)
32.x.xサポート対象
31.x.xサポート対象
< 30.x.xレガシー

関連リソース


クイックリファレンス

必要なものコンポーネントプロパティ
成功メッセージの表示Messageseverity: 'Success'
閉じるボタン付きの警告の表示Messageseverity: 'Warning', showCloseIcon: true
ローディング用プレースホルダーSkeletonshape: 'Rectangle'
アバター用プレースホルダーSkeletonshape: 'Circle', width: '48px'
クイック通知ToastToastUtility.show()
表示時間が制限されない通知ToasttimeOut: 0, showCloseButton: true
アクションの確認Toastbuttons: [...]
右下のトーストToastposition: { X: 'Right', Y: 'Bottom' }

ステータス: ✅ 本番環境対応
品質評価: 9+/10(プロフェッショナル品質)
カバレッジ: 3 コンポーネント、22 のリファレンスファイル

コメント