APG Patterns
English GitHub
English GitHub

Alert

ユーザーのタスクを中断することなく、ユーザーの注意を引く方法で短く重要なメッセージを表示する要素。

🤖 AI Implementation Guide

デモ

下のボタンをクリックして、異なるバリアントのアラートを表示します。ライブリージョンコンテナはページ読み込み時から DOM に存在し、コンテンツのみが変更されます。

アクセシビリティ

重要な実装上の注意

ライブリージョンのコンテナ(role="alert")は、ページ読み込み時から DOM に存在している必要があります。 コンテナ自体を動的に追加・削除しないでください。コンテナ内のコンテンツのみを動的に変更するようにしてください。

// 誤り: ライブリージョンを動的に追加
{showAlert && <div role="alert">Message</div>}

// 正しい: ライブリージョンは常に存在し、コンテンツを変更
<div role="alert">
  {message && <span>{message}</span>}
</div>

スクリーンリーダーは、ライブリージョン内の DOM の変更を検知してアナウンスします。ライブリージョン自体が動的に追加される場合、一部のスクリーンリーダーではコンテンツが確実にアナウンスされない可能性があります。

WAI-ARIA ロール

暗黙的な ARIA プロパティ

role="alert" は以下の ARIA プロパティを暗黙的に設定します。これらを手動で追加する必要はありません:

プロパティ 暗黙的な値 説明
aria-live assertive スクリーンリーダーを中断して即座にアナウンス
aria-atomic true 変更された部分だけでなく、アラート全体のコンテンツをアナウンス

キーボードサポート

アラートはキーボード操作を必要としません。ユーザーのワークフローを中断することなく情報を伝えることを目的としています。アラートのコンテンツは、変更されると自動的にスクリーンリーダーによってアナウンスされます。

アラートに閉じるボタンが含まれる場合、ボタンは標準的なボタンのキーボード操作に従います:

キー アクション
Enter 閉じるボタンをアクティブ化
Space 閉じるボタンをアクティブ化

フォーカス管理

  • アラートはフォーカスを移動してはいけません - アラートは非モーダルであり、フォーカスを奪うことでユーザーのワークフローを中断してはいけません。
  • アラートコンテナはフォーカス不可 - アラート要素は tabindex を持たず、キーボードフォーカスを受け取ってはいけません。
  • 閉じるボタンはフォーカス可能 - 存在する場合、閉じるボタンは Tab ナビゲーションで到達可能です。

重要なガイドライン

自動非表示の禁止

アラートは自動的に消えてはいけません。 WCAG 2.2.3 制限時間なし (opens in new tab) に従い、ユーザーがコンテンツを読むのに十分な時間が必要です。自動非表示が必要な場合:

  • 表示時間を一時停止・延長するためのユーザーコントロールを提供する
  • 十分な表示時間を確保する(最低5秒 + 読む時間)
  • コンテンツが本当に必須でないかを検討する

アラートの頻度

過度なアラートは、特に視覚障がいや認知障がいを持つユーザーにとって使いやすさを損なう可能性があります( WCAG 2.2.4 割り込み (opens in new tab) )。本当に重要なメッセージのためだけにアラートを使用してください。

Alert vs Alert Dialog

Alert を使用する場合:

  • メッセージが情報提供のみでユーザーアクションを必要としない
  • ユーザーのワークフローを中断すべきでない
  • フォーカスは現在のタスクに留まるべき

Alert Dialog (role="alertdialog") を使用する場合:

  • メッセージが即座のユーザー応答を必要とする
  • ユーザーが続行する前に確認またはアクションをとる必要がある
  • フォーカスをダイアログに移動すべき(モーダル動作)

注意: role="alertdialog" にはフォーカス管理とキーボード処理(Escapeで閉じる、フォーカストラップ)が必要です。モーダルな中断が適切な場合にのみ使用してください。

スクリーンリーダーの動作

  • 即座のアナウンス - アラートのコンテンツが変更されると、スクリーンリーダーは現在の読み上げを中断してアラートをアナウンスします(aria-live="assertive")。
  • 完全なコンテンツのアナウンス - 変更された部分だけでなく、アラート全体のコンテンツが読み上げられます(aria-atomic="true")。
  • 初期コンテンツはアナウンスされない - ページ読み込み時に存在するアラートは自動的にアナウンスされません。動的な変更のみがアナウンスをトリガーします。

参考資料

ソースコード

Alert.vue
<script setup lang="ts">
import { computed, useId } from 'vue';
import { cn } from '@/lib/utils';
import { Info, CircleCheck, AlertTriangle, OctagonAlert, X } from 'lucide-vue-next';
import { type AlertVariant, variantStyles } from './alert-config';

export type { AlertVariant };

export interface AlertProps {
  /**
   * Alert message content.
   * Changes to this prop trigger screen reader announcements.
   */
  message?: string;
  /**
   * Alert variant for visual styling.
   * Does NOT affect ARIA - all variants use role="alert"
   */
  variant?: AlertVariant;
  /**
   * Custom ID for the alert container.
   * Useful for SSR/hydration consistency.
   */
  id?: string;
  /**
   * Whether to show dismiss button.
   * Note: Manual dismiss only - NO auto-dismiss per WCAG 2.2.3
   */
  dismissible?: boolean;
  /**
   * Additional class name for the alert container
   */
  class?: string;
}

const props = withDefaults(defineProps<AlertProps>(), {
  message: undefined,
  variant: 'info',
  id: undefined,
  dismissible: false,
  class: '',
});

const emit = defineEmits<{
  dismiss: [];
}>();

// Generate SSR-safe unique ID
const generatedId = useId();
const alertId = computed(() => props.id ?? `alert-${generatedId}`);

const hasContent = computed(() => Boolean(props.message) || Boolean(slots.default));

const slots = defineSlots<{
  default?: () => unknown;
}>();

const variantIcons = {
  info: Info,
  success: CircleCheck,
  warning: AlertTriangle,
  error: OctagonAlert,
};

const handleDismiss = () => {
  emit('dismiss');
};
</script>

<template>
  <div
    :class="
      cn(
        'apg-alert',
        hasContent && [
          'relative flex items-start gap-3 rounded-lg border px-4 py-3',
          'transition-colors duration-150',
          variantStyles[variant],
        ],
        !hasContent && 'contents',
        props.class
      )
    "
  >
    <!-- Live region - contains only content for screen reader announcement -->
    <div
      :id="alertId"
      role="alert"
      :class="cn(hasContent && 'flex flex-1 items-start gap-3', !hasContent && 'contents')"
    >
      <template v-if="hasContent">
        <span class="apg-alert-icon mt-0.5 flex-shrink-0" aria-hidden="true">
          <component :is="variantIcons[variant]" class="size-5" />
        </span>
        <span class="apg-alert-content flex-1">
          <template v-if="message">{{ message }}</template>
          <slot v-else />
        </span>
      </template>
    </div>
    <!-- Dismiss button - outside live region to avoid SR announcing it as part of alert -->
    <button
      v-if="hasContent && dismissible"
      type="button"
      :class="
        cn(
          'apg-alert-dismiss',
          '-m-2 min-h-11 min-w-11 flex-shrink-0 rounded p-2',
          'flex items-center justify-center',
          'hover:bg-black/10 dark:hover:bg-white/10',
          'focus:ring-2 focus:ring-current focus:ring-offset-2 focus:outline-none'
        )
      "
      aria-label="Dismiss alert"
      @click="handleDismiss"
    >
      <X class="size-5" aria-hidden="true" />
    </button>
  </div>
</template>

使い方

使用例
<script setup>
import { ref } from 'vue';
import Alert from './Alert.vue';

const message = ref('');

function showAlert() {
  message.value = '操作が完了しました!';
}

function clearAlert() {
  message.value = '';
}
</script>

<template>
  <!-- 重要: Alert コンテナは常に DOM 内にあります -->
  <Alert
    :message="message"
    variant="info"
    :dismissible="true"
    @dismiss="clearAlert"
  />

  <button @click="showAlert">
    アラートを表示
  </button>
</template>

API

プロパティ

プロパティ デフォルト 説明
message string - アラートメッセージの内容
variant 'info' | 'success' | 'warning' | 'error' 'info' 視覚的なスタイルバリアント
dismissible boolean false 閉じるボタンを表示
id string 自動生成 カスタム ID
class string - 追加の CSS クラス

イベント

イベント 説明
@dismiss 閉じるボタンがクリックされたときに発行

スロット

スロット 説明
default 複雑なコンテンツ(message プロパティの代替)

テスト

テストは、ライブリージョンの動作、ARIA属性、アクセシビリティ要件全体にわたってAPG準拠を検証します。 Alertコンポーネントは2層のテスト戦略を採用しています。

テスト戦略

ユニットテスト(Testing Library)

フレームワーク固有のテストライブラリを使用してコンポーネントのレンダリング出力を検証します。これらのテストは正しいHTML構造とARIA属性を確認します。

  • ARIA属性(role="alert")
  • ライブリージョンコンテナのDOM内での永続性
  • 閉じるボタンのアクセシビリティ
  • jest-axeによるアクセシビリティ検証

E2Eテスト(Playwright)

すべてのフレームワークで実際のブラウザ環境でコンポーネントの動作を検証します。これらのテストはインタラクションとフレームワーク間の一貫性をカバーします。

  • ライブブラウザでのARIA構造
  • フォーカス管理(アラートはフォーカスを奪わない)
  • 閉じるボタンのキーボード操作
  • Tabナビゲーションの動作
  • axe-coreによるアクセシビリティスキャン
  • フレームワーク間の一貫性チェック

テストカテゴリ

高優先度: APG コア準拠(Unit + E2E)

テスト APG 要件
role="alert" の存在 アラートコンテナは alert ロールを持つ必要がある
コンテナが常に DOM に存在 ライブリージョンは動的に追加・削除してはならない
メッセージ変更時も同じコンテナ 更新時にコンテナ要素の同一性が保持される
アラート後もフォーカスは変わらない アラートはキーボードフォーカスを移動してはならない
アラートはフォーカス不可 アラートコンテナは tabindex を持ってはならない

中優先度: アクセシビリティ検証(Unit + E2E)

テスト WCAG 要件
axe 違反なし(メッセージあり) WCAG 2.1 AA 準拠
axe 違反なし(空) WCAG 2.1 AA 準拠
axe 違反なし(閉じるボタンあり) WCAG 2.1 AA 準拠
閉じるボタンにアクセシブルな名前 ボタンは aria-label を持つ
閉じるボタンは type="button" フォーム送信を防ぐ

低優先度: Props と拡張性(Unit)

テスト 機能
variant prop でスタイルを変更 ビジュアルのカスタマイズ
id prop でカスタム ID を設定 SSR サポート
className の継承 スタイルのカスタマイズ
複雑なコンテンツの children コンテンツの柔軟性
onDismiss コールバックが発火 イベント処理

低優先度: フレームワーク間の一貫性(E2E)

テスト 説明
すべてのフレームワークにアラートがある React、Vue、Svelte、Astroすべてがアラート要素をレンダリング
同じトリガーボタン すべてのフレームワークで一貫したトリガーボタン
クリックでアラートを表示 すべてのフレームワークでボタンクリック時にアラートを表示

スクリーンリーダーテスト

自動テストは DOM 構造を検証しますが、実際のアナウンス動作を検証するにはスクリーンリーダーによる手動テストが不可欠です:

スクリーンリーダー プラットフォーム
VoiceOver macOS / iOS
NVDA Windows
JAWS Windows
TalkBack Android

メッセージの変更が即座のアナウンスをトリガーすること、およびページ読み込み時に存在するコンテンツはアナウンスされないことを確認してください。

テストツール

テストの実行

# すべての Alert テストを実行
npm run test -- alert

# 特定のフレームワークのテストを実行
npm run test -- Alert.test.tsx    # React
npm run test -- Alert.test.vue    # Vue
npm run test -- Alert.test.svelte # Svelte

完全なドキュメントについては testing-strategy.md (opens in new tab) を参照してください。

リソース