本文へ移動
uiify

Toast

短時間表示する通知のキュー。

ブラウザー
Chrome 114+Firefox 125+Safari 17+
ティア
1
圧縮後のサイズ
2.41 kB
強制レイアウトの上限
0 ms
axe の上限
0
SSR 対応
はい
公開された契約
テストハーネス

プレイグラウンド

Toast

ビューポート

API

Toast.Provider

Prop型既定値説明
limitnumber3キューに保持するトーストの最大数。古いものから除去します。
childrenReactNode—useToastの呼び出しとビューポートの描画ができるツリー。

Toast.Viewport

Prop型既定値説明
aria-labelstring—キュー内のトーストを保持する領域のアクセシブルな名前。
classNamestring—ビューポート要素に適用するクラス。
popover"manual"—動作中のクライアントビューポートが設定し、描画するキューをトップレイヤーに配置します。サーバーシェルは設定しません。
refRef<HTMLElement>—ビューポート要素へのref。
childrenReactNode—キュー内のトーストとともに、ビューポート内に描画する追加の内容。

Toast.Root

Prop型既定値説明
toast*ToastRecord—描画するキュー内のレコード。解決済みのid、title、description、action、duration、priorityを含みます。

Toast.Title

Prop型既定値説明
classNamestring—タイトル要素に適用するクラス。
childrenReactNode—タイトルの内容。

Toast.Description

Prop型既定値説明
classNamestring—説明要素に適用するクラス。
childrenReactNode—説明の内容。

Toast.Action

Prop型既定値説明
classNamestring—アクションボタンに適用するクラス。
onClick(event: MouseEvent<HTMLButtonElement>) => void—アクションボタンをクリックすると呼び出します。
childrenReactNode—アクションボタンの内容。

Toast.Close

Prop型既定値説明
classNamestring—閉じるボタンに適用するクラス。
onClick(event: MouseEvent<HTMLButtonElement>) => void—閉じるボタンをクリックすると呼び出します。
childrenReactNode—閉じるボタンの内容。

useToast().toast(input)

Prop型既定値説明
titleReactNode—トーストのタイトル行。
descriptionReactNode—タイトルの下の補足行。
action{ label: ReactNode; onClick: () => void }—トースト上の1つのアクションボタンのラベルとハンドラー。
durationnumber4000トーストが自動で閉じるまでの時間(ミリ秒)。ゼロ以下なら、閉じる操作まで保持します。
priority"polite" | "assertive""polite"トーストを読み上げるライブリージョン。
idstring—トーストのID。省略時は生成します。

キーボード

キー操作
Tabトースト内のアクションボタンにフォーカス
Escape閉じられる場合に終了

アクセシビリティ

ライブリージョンのpolite/assertiveで読み上げます。キューへの追加ではフォーカスを動かさず、ホバー中やフォーカス中は自動終了を一時停止します。

スタイリングのフック

data-statedata-part="item"data-part="title"data-part="description"data-part="action"data-part="close"