Notice

事実・影響・次の操作を、画面に残る形で示します。

入れ子の通知
題名だけ・見出しとして置く
狭い場所で折り返す
右から左に読む場合

使いどころ

  • 公開期限や保存の条件など、その場所で読み続けてほしい事実と、その影響・次の操作を本文のそばに示す時に使います。
  • 今した操作の結果を一時的に知らせる時は Toast を使います。
  • 送信で直すところを欄へのリンクでまとめる時は ErrorSummary を使います。
  • 対象の状態を短い言葉だけで示す時は Badge を使います。

使い方

Noticeは1pxの枠で下だけを3pxにした、角丸4pxのカードです。文字は12pxで、一行目にアイコンと label の題名を太字で書き、childrenの本文と操作(ActionLink など)をその下に置きます。childrenを省くと題名だけの知らせになります。

tone で役割を選びます(info・success・warning・danger、既定は info)。info と warning は黄色の面(#ffffcc)に黄色の枠(#eac73b)で、題名は黒です。info のアイコンは青、warning のアイコンは黄土色です。success は淡い緑の面と枠に緑の題名とアイコン、danger は淡い赤の面と枠に赤の題名とアイコンです。アイコンは success でチェック、danger でバツ、他はiにします。

Noticeの中にNoticeを入れ子にもできます。

heading を渡すと題名を h2 で書き、ページの節の見出しとして読ませます。

Noticeは描いた時の内容を示すだけで、自動では消えません。動的に出す時の読み上げや、いつ消すかは利用側で扱い、重大なエラーは自動で消しません。JavaScriptは使いません。

アクセシビリティ

  • aside で、label を読み上げ名にします。アイコンは読み上げから外します。
  • role は付けません。画面を開いた後に出す時は、利用側で role="status" や role="alert" を付けて読み上げさせます。
  • 役割の色とアイコンの形は補助です。何が起きたかは題名と本文で伝えます。

API

Notice

通知は本文のそばへ置く。読み上げを必要とする動的な更新では利用側でroleを指定する。

Noticeのprops
名前型既定値説明
toneExclude<Tone, "neutral">"info"通知の役割。アイコンをその色で描き(successとdangerは面・枠・題名もその色にする)、アイコンはsuccessでチェック、dangerでバツ、他はiを置く。
label必須string題名。アイコンの横に太字で書き、asideの読み上げ名(aria-label)にもする。
headingbooleanfalse題名をh2で書く。ページの節の見出しとして読ませる時に使う。既定はp。
childrenChild題名の下に置く本文と操作。

ほかに、<aside>へ標準のHTML属性を渡せます。

読み込むCSS:layers.css、reset.css、tokens.css、base.css、layout.css、components/icon.css、components/notice.css、components/error-summary.css

Tone

値:"neutral" | "info" | "success" | "warning" | "danger"

コード

HTML
Hono JSX