ドキュメントを検索

Alert

ユーザーの邪魔をせずに注意を引くメッセージ。

AlertはAlert WAI-ARIAデザインパターンに従います。

import { component$, useStyles$ } from '@builder.io/qwik';
import { Alert } from '@leve-ui/alert';
import { LuAlertCircle } from '@qwikest/icons/lucide';
import styles from './default.css?inline';

export default component$(() => {
  useStyles$(styles);

  return (
    <Alert.Root class="alert-default">
      <LuAlertCircle class="alert-default-icon" aria-hidden="true" />
      <Alert.Title class="alert-default-title">Payment failed</Alert.Title>
      <Alert.Description class="alert-default-description">
        Check your card details and try again.
      </Alert.Description>
    </Alert.Root>
  );
});

インストール#

個別のパッケージをインストールするか、@leve-ui/coreを使用してすべてのコンポーネントを一度に取得します。

pnpm add @leve-ui/alert

構造#

import { Alert } from '@leve-ui/alert'; // or '@leve-ui/core'

<Alert.Root>
  <Alert.Title />
  <Alert.Description />
</Alert.Root>
パーツ要素説明
Alert.Root<div>メッセージをラップし、role="alert"を持ちます(live={false}の場合を除く)。
Alert.Title<div>メッセージの見出し。
Alert.Description<div>メッセージの本文。

例#

送信時#

送信の失敗後など、メッセージを通知すべき瞬間にAlert.Rootをレンダリングします。

APIリファレンス#

Root#

Propデフォルト型
livetrueboolean

スクリーンリーダーによって読み上げられるライブリージョン(role={live === false ? undefined : 'alert'} data-live={live === false ? undefined : ''})であるかどうか。最初からページ上にある通知の場合はfalseに設定し、通常のコンテンツとして読み上げられるようにします。

すべての<div>属性も受け入れます。

データ属性値
data-leve-alert常に存在

live(デフォルトはtrue)はRootがライブリージョンであるかどうかを決定します。静的な通知にはlive={false}を使用してください。

タイトル#

独自のpropはありません。 すべての<div>属性を受け入れます。

データ属性値
data-leve-alert-title常に存在

説明#

独自のpropはありません。 すべての<div>属性を受け入れます。

データ属性値
data-leve-alert-description常に存在

アクセシビリティ#

Alert WAI-ARIAデザインパターンに準拠しています。

  • Alert.Rootはrole="alert"をレンダリングするため、スクリーンリーダーはそのコンテンツを読み上げます。
  • ページの読み込み時にすでに存在するアラートは通知されない場合があります。表示すべきタイミングでレンダリングしてください。
  • 最初からページ上にある通知(例えばページ自体に関するバナーなど)の場合は、live={false}を渡します。Rootはroleをレンダリングせず、通常のコンテンツとして読み上げられます。
  • Alertはフォーカスを移動せず、自動的に閉じることもありません。一時的な通知には、代わりにトーストを使用してください。
  • Alertにはキーボード操作はありません。