Your next page is taking shape...

Opening Your Next Page…

Loading the guide and preparing its examples for you to explore. The page will appear here automatically when it’s ready, so you can keep this view open without refreshing.

Made for Preact. Built to be yours.

Navigation & Disclosure

Breadcrumb

Hierarchical navigation with links, current page, custom separators, dropdown mid-trail, ellipsis (collapsed), and asChild for router links (shadcn Breadcrumb pattern). Organize content into understandable destinations and reveal detail when it becomes relevant. Keep the active location or expanded state easy to recognize. Import it from @/components/kamod-ui/breadcrumb.

Source · Design reference · API reference · Theming · Styles


Interactive Live Preview
Try it. Make it yours.

Installation

Import Breadcrumb primitives from @/components/kamod-ui/breadcrumb.

Install PackagesTerminal
pnpm add @kamod-ch/ui

Copy an example with @kamod-ch/ui or the matching @kamod-ch/ui/… subpath. The code block switches between those two installs. Connect The Global Theme CSS and Tailwind Source Detection before your first render.

Import SetupTypeScript
import { Breadcrumb, BreadcrumbEllipsis, BreadcrumbItem, BreadcrumbLink, BreadcrumbList, BreadcrumbPage, BreadcrumbSeparator } from "@kamod-ch/ui";

Usage

Compose BreadcrumbList with BreadcrumbItem cells: BreadcrumbLink for ancestors, BreadcrumbPage for the active segment, BreadcrumbSeparator between items.

Import SetupTypeScript
import { Breadcrumb } from "@kamod-ch/ui";

Choose a complete composition from the examples below; required child components and props vary by pattern.

Interactive Live Preview
Try it. Make it yours.

Component Examples & Variants

Explore Breadcrumb in Different Contexts, from the starting pattern to the compositions below. Begin with Custom Separator, then compare the examples that match your content, state and layout. These are working patterns to adapt, not a list of interchangeable variant values: check the API Reference before using a prop or combining behaviors. Look at the surrounding labels, supporting text and spacing as well as the component itself.

Read the Result and Its Implementation Together. Use each showcase’s Code view to inspect imports and composition, or its Prompt view to prepare a setup or adaptation brief. Try the narrow preview and local theme controls before connecting real data, and use Reset to return an example to its initial state. Keep layout changes in class utilities where appropriate; follow the Component Styles Guide for hierarchy and the Theming Guide for shared surfaces and colors. The Accessibility Notes explain what to preserve when making those changes.

Custom Separator

Let the Trail Carry the Hierarchy. Pass your preferred separator node as the children of BreadcrumbSeparator. A small dot can create a quieter trail while the surrounding breadcrumb links continue to describe the same hierarchy.

Keep it decorative and consistent across pages, and choose a neutral symbol if the same navigation must work in both left-to-right and right-to-left layouts.

Interactive Live Preview
Try it. Make it yours.

Collapsed

Shorten the Middle without Losing Orientation. Use BreadcrumbEllipsis to indicate omitted intermediate locations in a long path. If those destinations should remain reachable, connect the collapsed segment to a menu as shown in the full preview.

An ellipsis is only an omission marker unless you give it an actual disclosure control; use the Dropdown pattern when hidden ancestors must remain directly reachable.

Interactive Live Preview
Try it. Make it yours.
API reference

Props and Data

Configure Breadcrumb using the contracts below. Read the documented options alongside the Source Definitions to understand which values your application supplies and which details the component owns. Start with a prop or helper, then follow its type link to inspect the declaration without leaving the page.

Props overview for each part.

API reference
Your API, from source

Type cards are extracted from this checkout’s TypeScript source at build time. Props inherited through HTMLAttributes, Omit or variant helpers remain references in those declarations; their fields are not flattened here. Match the reference to your installed version, and check a package’s exports before writing an import type. A type exported by a source file is not necessarily re-exported by @kamod-ch/ui.

Component Props

Read each option with its owning component. The
marker identifies required fields verified in that declaration. A ? means a field can be omitted; it does not promise a fallback value. Existing documented defaults remain alongside the descriptions. For callbacks, check the argument and return types before connecting your own state or services.
@kamod-ch/ui/breadcrumb8.5 KB min · 2.5 KB gzipSignals: none

Breadcrumb

BreadcrumbProps

Breadcrumb documented props
Prop / typeDescription
children
ComponentChild[] | ComponentChildBreadcrumbProps

Configure children for Breadcrumb. Compare its accepted type with the Usage Guidance before supplying a value.

Default
—
class
string | SignalLike<string | undefined>BreadcrumbProps

Configure class for Breadcrumb. Compare its accepted type with the Usage Guidance before supplying a value.

Default
—

BreadcrumbEllipsis

BreadcrumbEllipsisProps

BreadcrumbEllipsis documented props
Prop / typeDescription
class
string | SignalLike<string | undefined>BreadcrumbEllipsisProps

Configure class for BreadcrumbEllipsis. Compare its accepted type with the Usage Guidance before supplying a value.

Default
—

BreadcrumbItem

BreadcrumbItemProps

BreadcrumbItem documented props
Prop / typeDescription
children
ComponentChild[] | ComponentChildBreadcrumbItemProps

Configure children for BreadcrumbItem. Compare its accepted type with the Usage Guidance before supplying a value.

Default
—
class
string | SignalLike<string | undefined>BreadcrumbItemProps

Configure class for BreadcrumbItem. Compare its accepted type with the Usage Guidance before supplying a value.

Default
—

BreadcrumbList

BreadcrumbListProps

BreadcrumbList documented props
Prop / typeDescription
children
ComponentChild[] | ComponentChildBreadcrumbListProps

Configure children for BreadcrumbList. Compare its accepted type with the Usage Guidance before supplying a value.

Default
—
class
string | SignalLike<string | undefined>BreadcrumbListProps

Configure class for BreadcrumbList. Compare its accepted type with the Usage Guidance before supplying a value.

Default
—

BreadcrumbPage

BreadcrumbPageProps

BreadcrumbPage documented props
Prop / typeDescription
children
ComponentChild[] | ComponentChildBreadcrumbPageProps

Configure children for BreadcrumbPage. Compare its accepted type with the Usage Guidance before supplying a value.

Default
—
class
string | SignalLike<string | undefined>BreadcrumbPageProps

Configure class for BreadcrumbPage. Compare its accepted type with the Usage Guidance before supplying a value.

Default
—

BreadcrumbSeparator

BreadcrumbSeparatorProps

BreadcrumbSeparator documented props
Prop / typeDescription
children
ComponentChild[] | ComponentChildBreadcrumbSeparatorProps

Configure children for BreadcrumbSeparator. Compare its accepted type with the Usage Guidance before supplying a value.

Default
—
class
string | SignalLike<string | undefined>BreadcrumbSeparatorProps

Configure class for BreadcrumbSeparator. Compare its accepted type with the Usage Guidance before supplying a value.

Default
—

Data Type Reference

Expand a card to inspect and copy the exact declaration. The code header identifies its repository file; follow imported or inherited types in the Implementation Source when you need the complete dependency chain. Required-field summaries cover fields declared directly in that type. Source-only helpers and inferred schema outputs describe the local implementation, not additional props you can pass to every component.

Breadcrumb Props

1 declared field
BreadcrumbProps
Exported Source Declaration from Breadcrumb.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions. Inspect the Complete Definition of BreadcrumbProps before adapting it.
BreadcrumbEllipsisProps
Exported Source Declaration from BreadcrumbEllipsis.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions. Inspect the Complete Definition of BreadcrumbEllipsisProps before adapting it.

BreadcrumbItem Props

1 declared field
BreadcrumbItemProps
Exported Source Declaration from BreadcrumbItem.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions. Inspect the Complete Definition of BreadcrumbItemProps before adapting it.
2 declared fields
BreadcrumbLinkProps
Exported Source Declaration from BreadcrumbLink.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions. Inspect the Complete Definition of BreadcrumbLinkProps before adapting it.

BreadcrumbList Props

1 declared field
BreadcrumbListProps
Exported Source Declaration from BreadcrumbList.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions. Inspect the Complete Definition of BreadcrumbListProps before adapting it.

BreadcrumbPage Props

1 declared field
BreadcrumbPageProps
Exported Source Declaration from BreadcrumbPage.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions. Inspect the Complete Definition of BreadcrumbPageProps before adapting it.

BreadcrumbSeparator Props

1 declared field
BreadcrumbSeparatorProps
Exported Source Declaration from BreadcrumbSeparator.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions. Inspect the Complete Definition of BreadcrumbSeparatorProps before adapting it.

Accessibility

Breadcrumb renders a named navigation landmark. BreadcrumbPage marks the current location with aria-current="page"; separators are decorative. Ancestors should remain real links with meaningful destinations.

Take the Next Useful Step

You have the pieces. Put them into one real interaction, keep its state in one place, and check the result with the content your application will actually show.

Connect the Foundation

Return to Choose and Compose Components to connect this reference to a working screen. Keep global CSS in one entrypoint and import only the components that screen needs.

Build the Surrounding Screen

Find a neighboring interaction in the Component Library, or start with a complete Block. Replace sample content and destinations before refining the layout; a local class change can stay with the composition.

Make the Result Hold Up

Use shared theme roles for changes that belong everywhere. Then review the whole journey: keyboard focus, long labels, narrow screens and a clear way to recover when something fails.

Keep a link to the source and note your intentional changes. Your next edit should begin with a clear decision, not another search.