ナビゲーションと開示@neumorphism-ui/breadcrumb

Breadcrumb

nav と ol の native semantics を維持しながら、link、現在のページ、separator、省略された経路を組み合わせます。現在のページには aria-current=page が自動的に設定されます。

@neumorphism-ui/breadcrumb
Registry JSON

プレビュー

インストール

インストール: breadcrumbnpx shadcn@latest add @neumorphism-ui/breadcrumb

CLI が npm 依存関係、base token、utils、コンポーネントソースを順番に処理します。

この Registry を初めて使う場合は、先に namespace の設定 を完了してください。

使い方

Import

Breadcrumb の import コード
import {
  Breadcrumb,
  BreadcrumbItem,
  BreadcrumbLink,
  BreadcrumbList,
  BreadcrumbPage,
  BreadcrumbSeparator,
} from "@/components/ui/breadcrumb"

Example

Breadcrumb の使用コード
<Breadcrumb>
  <BreadcrumbList>
    <BreadcrumbItem>
      <BreadcrumbLink href="/">ホーム</BreadcrumbLink>
    </BreadcrumbItem>
    <BreadcrumbSeparator />
    <BreadcrumbItem>
      <BreadcrumbLink href="/components">コンポーネント</BreadcrumbLink>
    </BreadcrumbItem>
    <BreadcrumbSeparator />
    <BreadcrumbItem>
      <BreadcrumbPage>Breadcrumb</BreadcrumbPage>
    </BreadcrumbItem>
  </BreadcrumbList>
</Breadcrumb>

API リファレンス

コンポーネントプロパティ型デフォルト説明
Breadcrumbaria-labelstring"breadcrumb"経路ナビゲーション領域のアクセシブルな名前です。
BreadcrumbLinkhref必須string—親階層を指す実際の URL です。
BreadcrumbPagechildren必須React.ReactNode—aria-current=page が設定される現在のページ名です。
BreadcrumbSeparatorchildrenReact.ReactNode"/"支援技術から隠される視覚的な separator です。

アクセシビリティ

  • 01

    Breadcrumb は aria-label=breadcrumb が付いた nav で、経路は順序付きの ol として表現されます。

  • 02

    最後の項目には link ではなく BreadcrumbPage を使用し、aria-current=page を公開してください。

  • 03

    Separator と Ellipsis は装飾要素として支援技術から隠されます。