For AI agents: the complete documentation index is available at https://rickyshin93.github.io/tao-ui/llms.txt, the full documentation bundle is available at https://rickyshin93.github.io/tao-ui/llms-full.txt, and this page is available as Markdown at https://rickyshin93.github.io/tao-ui/components/breadcrumb.md.
v0.0.57
  • English
  • Breadcrumb

    Navigation@rockshin/tao-ui

    Renders the user location in a hierarchy of pages or views.

    When to use

    Use Breadcrumb near the top of a page when users need to understand or move through nested context.

    Recommended

    • Keep labels short and recognizable.
    • Use links for ancestors and plain text for the current item.

    Avoid

    • Do not use Breadcrumb as primary navigation.

    Examples

    API

    PropertyDescriptionTypeDefault Value
    itemsBreadcrumb path, root first. The last item renders as the current page.BreadcrumbItemType[] (Required)-
    separatorSeparator between items. Defaults to a chevron, like shadcn.ReactNode-
    maxItemsCollapse the middle of long paths into an ellipsis once the number of items exceeds this value. Shows the first item and the last maxItems - 1 items.number | undefined-
    itemRenderCustom renderer for an item's content. Return a React element (e.g. a router <Link>) and its props are merged onto the breadcrumb link via Radix Slot — no extra <a> wrapper is added.((item: BreadcrumbItemType, info: { index: number; isLast: boolean; items: BreadcrumbItemType[]; }) => ReactNode) | undefined-
    classNameAdditional css classstring | undefined-
    styleAdditional styleCSSProperties | undefined-