Skip to content

Breadcrumb

概要

Breadcrumb は、サイトの階層構造内におけるページの位置を表示するためのパンくずリストのコンポーネントです。

以下のサブコンポーネントで構成されます:

  • Breadcrumb.Root — ルート <nav> 要素。variant / size / separator 設定を管理
  • Breadcrumb.List — パンくずリストの <ol> コンテナ
  • Breadcrumb.Item — 各パンくず項目の <li> 要素
  • Breadcrumb.Link — ナビゲーションリンク
  • Breadcrumb.CurrentLink — 現在のページ(aria-current="page" 付き)
  • Breadcrumb.Separator — 項目間の区切り文字
  • Breadcrumb.Ellipsis — 省略記号(中間階層を省略する場合)

Usage 使用例

基本

カスタムセパレーター

separator prop でデフォルトの区切り文字を変更できます。

省略記号付き

中間階層が多い場合は Breadcrumb.Ellipsis で省略できます。

サイズバリエーション

size prop で小さい / 標準 / 大きいサイズを選べます。

variant

variant="underline" でリンクにアンダーライン装飾を付けます。

API Reference

Root Props

PropsTypeDefaultDescription
variant"underline" | "plain""plain"外観バリエーション。underline はリンクにホバー時アンダーラインを付けます。plain は装飾なしのシンプルな表示
size"sm" | "md" | "lg""md"コンポーネントのサイズ。フォントサイズと余白が変わります
separatorstring | m.Children"/"項目間に表示するセパレーター文字。文字列や Mithril vnode を指定できます
classstringルート <nav> 要素に付与する追加 CSS クラス
styleRecord<string, string>ルート <nav> 要素に付与するインラインスタイル

Item Props

PropsTypeDefaultDescription
classstring<li> 要素に付与する追加 CSS クラス
styleRecord<string, string><li> 要素に付与するインラインスタイル
PropsTypeDefaultDescription
hrefstring"#"遷移先 URL。/ で始まるパスは m.route.set() によるクライアントサイドナビゲーションになります
classstring<a> 要素に付与する追加 CSS クラス
styleRecord<string, string><a> 要素に付与するインラインスタイル
PropsTypeDefaultDescription
classstring<span> 要素に付与する追加 CSS クラス
styleRecord<string, string><span> 要素に付与するインラインスタイル

アクセシビリティ

  • ルート要素に aria-label="Breadcrumb" を設定
  • 現在のページ要素に aria-current="page" を設定
  • セパレーターは aria-hidden="true" でスクリーンリーダーから隠蔽

Mithril UI Kit Documentation