Skip to content
Latestv1.0.63

Breadcrumb ​

Displays the current page path and allows quick navigation back to any previous page.

Showcase ​

The breadcrumb component supports dynamic level management and smart path collapsing.

Smart Overflow

Basic Usage ​

Use the to prop on YhBreadcrumbItem to define clickable navigation nodes.

Basic Usage

Custom Separator ​

Customize the separator string with the separator prop.

Custom Separator

Advanced Features ​

Smart Overflow Collapse ​

When the navigation hierarchy becomes deep, setting max-items collapses intermediate nodes into an ellipsis entry so the layout stays readable.

Router Adaptation ​

The component detects the Nuxt environment and can render route navigation through Nuxt-compatible links when to is provided.

Use in Nuxt ​

YhBreadcrumb works in Nuxt 3/4 after registering @yh-ui/nuxt.

Use in Nuxt

API ​

Props ​

PropDescriptionTypeDefault
separatorSeparator stringstring/
separator-iconSeparator icon componentstring | Component''
max-itemsMaximum number of displayed items before collapsing middle nodesnumber0
theme-overridesComponent-level theme variable overridesComponentThemeVarsundefined
PropDescriptionTypeDefault
toRoute navigation targetstring | Record<string, unknown>''
replaceWhether to replace the current routebooleanfalse
theme-overridesComponent-level theme variable overridesComponentThemeVarsundefined

Events ​

YhBreadcrumb and YhBreadcrumbItem do not expose component events.

Slots ​

SlotDescriptionSlot Props
defaultBreadcrumb content.-
SlotDescriptionSlot Props
defaultBreadcrumb item content.-

Expose ​

YhBreadcrumb and YhBreadcrumbItem do not expose public instance methods or properties.

Theme Variables ​

This component does not provide dedicated component-scoped theme variables. If you pass themeOverrides, the rendered styles still mainly consume shared global theme tokens such as text color and primary color.

Type Exports ​

NameDescription
YhBreadcrumbPropsProps type for YhBreadcrumb
YhBreadcrumbSlotsSlots type for YhBreadcrumb
YhBreadcrumbItemPropsProps type for YhBreadcrumbItem
YhBreadcrumbItemSlotsSlots type for YhBreadcrumbItem
YhBreadcrumbInstancePublic instance type for YhBreadcrumb
YhBreadcrumbItemInstancePublic instance type for YhBreadcrumbItem

Released under the MIT License.