ドキュメントを検索

Breadcrumb

サイト階層内の現在のページへのパス。

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

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

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

  return (
    <Breadcrumb.Root class="breadcrumb-default">
      <Breadcrumb.List class="breadcrumb-default-list">
        <Breadcrumb.Item>
          <Breadcrumb.Link href="#home" class="breadcrumb-default-link">
            Home
          </Breadcrumb.Link>
        </Breadcrumb.Item>
        {/* The library hides the separator from assistive technology */}
        <Breadcrumb.Separator class="breadcrumb-default-separator">
          <LuChevronRight class="breadcrumb-default-separator-icon" aria-hidden="true" />
        </Breadcrumb.Separator>
        <Breadcrumb.Item>
          <Breadcrumb.Link href="#components" class="breadcrumb-default-link">
            Components
          </Breadcrumb.Link>
        </Breadcrumb.Item>
        <Breadcrumb.Separator class="breadcrumb-default-separator">
          <LuChevronRight class="breadcrumb-default-separator-icon" aria-hidden="true" />
        </Breadcrumb.Separator>
        <Breadcrumb.Item>
          <Breadcrumb.Link href="#breadcrumb" current class="breadcrumb-default-link">
            Breadcrumb
          </Breadcrumb.Link>
        </Breadcrumb.Item>
      </Breadcrumb.List>
    </Breadcrumb.Root>
  );
});

インストール#

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

pnpm add @leve-ui/breadcrumb

構造#

import { Breadcrumb } from '@leve-ui/breadcrumb'; // or '@leve-ui/core'

<Breadcrumb.Root>
  <Breadcrumb.List>
    <Breadcrumb.Item>
      <Breadcrumb.Link />
    </Breadcrumb.Item>
    <Breadcrumb.Separator />
    <Breadcrumb.Item>
      <Breadcrumb.Link current />
    </Breadcrumb.Item>
  </Breadcrumb.List>
</Breadcrumb.Root>
パーツ要素説明
Breadcrumb.Root<nav>ナビゲーションランドマーク。
Breadcrumb.List<ol>アイテムの順序付きリスト。
Breadcrumb.Item<li>1つのアイテム。内部にLinkを配置します。
Breadcrumb.Link<a>ページへのリンクです。現在のページにはcurrentを、別の要素やルーターリンクコンポーネントをレンダリングするにはasを使用します。
Breadcrumb.Separator<li>/やアイコンなど、アイテム間の装飾的な区切り文字。支援技術からは隠されます。

例#

カスタムリンクコンポーネント#

Breadcrumb.Linkの属性を維持しながらクライアントサイドナビゲーションやプリフェッチを行うには、Qwik Cityの<Link>などのルーターリンクコンポーネントをasに渡します:

import { Link } from '@builder.io/qwik-city';
import { Breadcrumb } from '@leve-ui/breadcrumb';

<Breadcrumb.Link as={Link} href="/components/">
  Components
</Breadcrumb.Link>

asに渡すコンポーネントは、id、aria-*、data-*、およびon*$イベントハンドラーを含め、受け取ったpropsを単一の要素にスプレッドする必要があります。

APIリファレンス#

Root#

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

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

List#

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

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

Item#

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

データ属性値
data-leve-breadcrumb-item常に存在
Propデフォルト型
as'a'keyof HTMLElementTagNameMap | Component<any>

<a>の代わりにレンダリングする要素またはコンポーネントです。コンポーネントは受け取ったpropsを1つの要素にスプレッドする必要があります。

currentfalseboolean

リンクを現在のページとしてマークします(aria-current="page"を出力)。

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

データ属性値
data-leve-breadcrumb-link常に存在
data-currentcurrentがtrueのときに存在

Separator#

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

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

アクセシビリティ#

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

  • Breadcrumb.Rootはデフォルトでaria-label="Breadcrumb"という名前の<nav>ランドマークです。名前を変更するにはaria-labelまたはaria-labelledbyを渡します。
  • currentを指定したBreadcrumb.Linkはaria-current="page"をレンダリングします。
  • Breadcrumb.Separatorはrole="presentation"およびaria-hidden="true"をレンダリングするため、読み上げられず、リストアイテムとしてもカウントされません。
  • リンクはネイティブの<a>要素であり、Tabキーでアクセスします。Breadcrumb自体には独自のキーボード操作は追加されません。