Skip to content

Function: Breadcrumb()

ts
function Breadcrumb(props: UiBreadcrumbProps): Block;

Defined in: packages/sdk/src/renderer/blocks/index.ts:1074

Experimental

Breadcrumb — shows the path to the current resource as a hierarchy of links separated by a chevron (default) or slash. The last item (or one with current: true) renders as the current page; an ellipsis item stands in for collapsed ancestors. items and hidden accept an async function of UI state.

Parameters

ParameterType
propsUiBreadcrumbProps

Returns

Block

Examples

ts
Breadcrumb({
  items: [
    {label: 'Home', href: '/'},
    {label: 'Components', href: '/components'},
    {label: 'Breadcrumb'},
  ],
});
ts
Breadcrumb({
  separator: 'slash',
  items: [
    {label: 'Home', onClick: () => navigate('/')},
    {label: 'More', ellipsis: true},
    {label: 'Breadcrumb'},
  ],
});

Matterway Assistant SDK Documentation