Breadcrumb
The path to the current page in the site hierarchy.
Breadcrumb follows the Breadcrumb WAI-ARIA design pattern.
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);
}Installation#
Install the individual package, or use @leve-ui/core to get every component at once:
pnpm add @leve-ui/corenpm install @leve-ui/coreyarn add @leve-ui/corebun add @leve-ui/coreAnatomy#
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>
| Part | Element | Description |
|---|---|---|
Breadcrumb.Root | <nav> | The navigation landmark. |
Breadcrumb.List | <ol> | The ordered list of items. |
Breadcrumb.Item | <li> | One item. Put a Link inside. |
Breadcrumb.Link | <a> | The link to a page. Use current for the current page, and as to render another element or a router link component. |
Breadcrumb.Separator | <li> | A decorative separator between items, such as / or an icon. Hidden from assistive technologies. |
Examples#
Custom Link Component#
Pass a router link component such as Qwik City's <Link> to as for client-side navigation and prefetching while keeping Breadcrumb.Link's attributes:
import { Link } from '@builder.io/qwik-city';
import { Breadcrumb } from '@leve-ui/breadcrumb';
<Breadcrumb.Link as={Link} href="/components/">
Components
</Breadcrumb.Link>
A component passed to as must spread the props it receives onto a single element, including id, aria-*, data-*, and on*$ event handlers.
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 Reference#
Root#
No props of its own. Accepts all <nav> attributes.
| Data attribute | Value |
|---|---|
data-leve-breadcrumb | Always present |
List#
No props of its own. Accepts all <ol> attributes.
| Data attribute | Value |
|---|---|
data-leve-breadcrumb-list | Always present |
Item#
No props of its own. Accepts all <li> attributes.
| Data attribute | Value |
|---|---|
data-leve-breadcrumb-item | Always present |
Link#
| Prop | Default | Type |
|---|---|---|
| as | 'a' | keyof HTMLElementTagNameMap | Component<any> The element or component to render instead of |
| current | false | boolean Marks the link as the current page (outputs |
Also accepts all <a> attributes.
| Data attribute | Value |
|---|---|
data-leve-breadcrumb-link | Always present |
data-current | Present when current is true |
Separator#
No props of its own. Accepts all <li> attributes.
| Data attribute | Value |
|---|---|
data-leve-breadcrumb-separator | Always present |
Accessibility#
Complies with the Breadcrumb WAI-ARIA design pattern.
Breadcrumb.Rootis a<nav>landmark namedaria-label="Breadcrumb"by default. Passaria-labeloraria-labelledbyto change the name.Breadcrumb.Linkwithcurrentrendersaria-current="page".Breadcrumb.Separatorrendersrole="presentation"andaria-hidden="true", so it is not read and not counted as a list item.- The links are native
<a>elements and are reached with Tab. Breadcrumb adds no keyboard interaction of its own.