Skip to content

Breadcrumb Item

@astryxdesign/core v0.7.1 · BreadcrumbItem

Props ​

PropTypeDefaultDescription
hrefstring—Link URL. Omit it and the crumb is a button. Mutually exclusive with menu: a menu crumb is a trigger, not a link.
asNavLinkComponent'a'Link root component, such as a router link. Used instead of a for items that have an href and are not current.
isCurrentbooleanfalseMarks this crumb as the current page. Renders as a <span> with aria-current="page". A current crumb can still open a menu.
menuBreadcrumbMenuOption[]—Turns the crumb into a menu trigger for sibling destinations. The array matches the dropdown menu's data entries, including dividers, checkbox rows, and radio groups. Ignored when the menu slot is used.
menuSize'sm' | 'md' | 'lg'sm on the supporting variant, otherwise mdSize of the menu rows.

Slots ​

  • default: the crumb label.
  • startIcon: icon before the label.
  • menu: menu content written by hand, including checkbox and radio rows. Used instead of the menu array.

Events ​

  • click(event: MouseEvent): fires when the crumb is clicked. A current crumb blocks the default action and emits nothing.