Component

Breadcrumb

A compact navigation trail for docs, settings, and nested app pages.

Preview

Installation

Install the package, then import the component and shared stylesheet in your app.

Package install

Install the package when you want components imported from axie-ui.

install

pnpm add axie-ui

Import

code

import "axie-ui/styles.css";import { Breadcrumb } from "axie-ui";

Registry install

Use the direct URL when you want shadcn to copy editable source into your app. This works without the official registry and does not install axie-ui.

registry

pnpm dlx shadcn@latest add https://axie.alexi.life/r/breadcrumb.json

Copied source import

code

import "@/styles/axie.css";import { Breadcrumb } from "@/components/axie/breadcrumb";

Prefer @axie/breadcrumb? Add the Axie namespace once from the Installation page, then use that shorthand.

Usage

code

import { Breadcrumb } from "axie-ui";export function Example() {  return (    <Breadcrumb      items={[        { href: "/", label: "Docs" },        { current: true, label: "Components" }      ]}    />  );}

Accessibility

Wrap breadcrumbs in a named navigation landmark.
Mark the current item with `aria-current="page"`.
Keep labels short enough to scan at small viewport widths.

API Reference

Prop	Type	Default	Description
items	BreadcrumbItem[]	-	Ordered breadcrumb segments.
separator	ReactNode	/	Visual separator between segments.
href	string	-	Link destination for non-current items.