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>
);
});.breadcrumb-default {
font-family: inherit;
}
.breadcrumb-default-list {
display: flex;
align-items: center;
gap: 8px;
margin: 0;
padding: 0;
list-style: none;
}
.breadcrumb-default-link {
font-size: 14px;
color: light-dark(#475569, #c9ddf0);
text-decoration: none;
}
.breadcrumb-default-link:hover {
color: light-dark(#0f172a, #ffffff);
}
.breadcrumb-default-link:focus-visible {
outline: 2px solid #009dfd;
outline-offset: 2px;
}
/* The link for the current page (aria-current="page") */
.breadcrumb-default-link[aria-current="page"] {
font-weight: 500;
color: light-dark(#0f172a, #ffffff);
}
.breadcrumb-default-separator {
display: flex;
align-items: center;
}
.breadcrumb-default-separator-icon {
width: 14px;
height: 14px;
color: light-dark(#475569, #c9ddf0);
}インストール#
個別のパッケージをインストールするか、@leve-ui/coreを使用してすべてのコンポーネントを一度に取得します。
pnpm add @leve-ui/corenpm install @leve-ui/coreyarn add @leve-ui/corebun add @leve-ui/core構造#
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を単一の要素にスプレッドする必要があります。
import {
$,
component$,
Fragment,
type PropsOf,
type QRL,
Slot,
sync$,
useSignal,
useStyles$,
} from '@builder.io/qwik';
import { Breadcrumb } from '@leve-ui/breadcrumb';
import { LuChevronRight } from '@qwikest/icons/lucide';
import styles from './custom-link.css?inline';
type ClientLinkProps = PropsOf<'a'> & {
onNavigate$?: QRL<(href: string) => void>;
};
// Example of a router link component (such as Qwik City's <Link>) that spreads received props onto <a>
const ClientLink = component$<ClientLinkProps>(({ onNavigate$, onClick$, ...props }) => {
const preventDefault$ = sync$((event: MouseEvent) => {
event.preventDefault();
});
const handleClick$ = $(() => {
if (props.href) {
onNavigate$?.(props.href);
}
});
return (
<a {...props} onClick$={[preventDefault$, handleClick$, onClick$]}>
<Slot />
</a>
);
});
const ITEMS = [
{ href: '/', label: 'Home' },
{ href: '/components', label: 'Components' },
{ href: '/components/breadcrumb', label: 'Breadcrumb' },
];
export default component$(() => {
useStyles$(styles);
const currentPath = useSignal('/components/breadcrumb');
return (
<Breadcrumb.Root class="breadcrumb-custom-link">
<Breadcrumb.List class="breadcrumb-custom-link-list">
{ITEMS.map((item, index) => (
<Fragment key={item.href}>
{index > 0 && (
<Breadcrumb.Separator class="breadcrumb-custom-link-separator">
<LuChevronRight class="breadcrumb-custom-link-separator-icon" aria-hidden="true" />
</Breadcrumb.Separator>
)}
<Breadcrumb.Item>
<Breadcrumb.Link
as={ClientLink}
href={item.href}
current={currentPath.value === item.href}
onNavigate$={$((href: string) => {
currentPath.value = href;
})}
class="breadcrumb-custom-link-link"
>
{item.label}
</Breadcrumb.Link>
</Breadcrumb.Item>
</Fragment>
))}
</Breadcrumb.List>
</Breadcrumb.Root>
);
});.breadcrumb-custom-link {
font-family: inherit;
}
.breadcrumb-custom-link-list {
display: flex;
align-items: center;
gap: 8px;
margin: 0;
padding: 0;
list-style: none;
}
.breadcrumb-custom-link-link {
font-size: 14px;
color: light-dark(#475569, #c9ddf0);
text-decoration: none;
}
.breadcrumb-custom-link-link:hover {
color: light-dark(#0f172a, #ffffff);
}
.breadcrumb-custom-link-link:focus-visible {
outline: 2px solid #009dfd;
outline-offset: 2px;
}
/* The link for the current page (aria-current="page") */
.breadcrumb-custom-link-link[aria-current="page"] {
font-weight: 500;
color: light-dark(#0f172a, #ffffff);
}
.breadcrumb-custom-link-separator {
display: flex;
align-items: center;
}
.breadcrumb-custom-link-separator-icon {
width: 14px;
height: 14px;
color: light-dark(#475569, #c9ddf0);
}APIリファレンス#
Root#
独自のpropはありません。 すべての<nav>属性を受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-breadcrumb | 常に存在 |
List#
独自のpropはありません。 すべての<ol>属性を受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-breadcrumb-list | 常に存在 |
Item#
独自のpropはありません。 すべての<li>属性を受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-breadcrumb-item | 常に存在 |
Link#
| Prop | デフォルト | 型 |
|---|---|---|
| as | 'a' | keyof HTMLElementTagNameMap | Component<any>
|
| current | false | boolean リンクを現在のページとしてマークします( |
すべての<a>属性も受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-breadcrumb-link | 常に存在 |
data-current | currentが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自体には独自のキーボード操作は追加されません。