Breadcrumbs API

API reference for the Breadcrumbs components.

Explore these related pages for additional context and usage patterns.

Page	Category
Breadcrumbs	Semantic
createBreadcrumbs	Semantic
createGroup	Selection
createOverflow	Semantic
useLocale	Plugins
Pagination	Semantic

Breadcrumbs.Root

Props

namespace

string | undefined

Namespace for dependency injection

Default: "v0:breadcrumbs"

divider

string | undefined

Default divider character/text

Default: "/"

ellipsis

string | undefined

Default ellipsis character/text

Default: "…"

gap

number | undefined

Gap between items in pixels.

Default: 8

label

string | undefined

Accessible label for the navigation landmark

Slots

default

BreadcrumbsRootSlotProps

Breadcrumbs.Divider

Props

namespace

string | undefined

Namespace for dependency injection

Default: "v0:breadcrumbs"

id

any

Unique identifier (auto-generated if not provided)

divider

string | undefined

Override divider character (uses global from Root if not provided)

Slots

default

BreadcrumbsDividerSlotProps

Breadcrumbs.Ellipsis

Props

namespace

string | undefined

Namespace for dependency injection

Default: "v0:breadcrumbs"

id

any

Unique identifier (auto-generated if not provided)

ellipsis

string | undefined

Override ellipsis character (uses global from Root if not provided)

Slots

default

BreadcrumbsEllipsisSlotProps

Breadcrumbs.Item

Props

namespace

string | undefined

Namespace for dependency injection

Default: "v0:breadcrumbs"

id

any

Unique identifier (auto-generated if not provided)

value

unknown

Value associated with this item

text

string | undefined

Display text for the breadcrumb (used by composable model)

Default: ""

Slots

default

BreadcrumbsItemSlotProps

Breadcrumbs.List

Slots

default

BreadcrumbsListSlotProps

Breadcrumbs.Page

Slots

default

BreadcrumbsPageSlotProps