Breadcrumbs

Render Astryx breadcrumbs from item records.

Astryx Props

JSON-safe Breadcrumbs props forwarded to Astryx.

Supported Astryx props include:

children (ReactNode; required): BreadcrumbItem elements to render inside the breadcrumb trail.
separator (ReactNode): Separator rendered between breadcrumb items.
variant ('default' or 'supporting'): Visual variant: supporting is smaller with secondary text styling.
label (string): Accessible label for the nav landmark (aria-label).
xstyle (StyleXStyles): StyleX styles for layout customization (margins, positioning, sizing). Must be a stylex.create() value: not an inline style object like style={{}}.

Props typed as React nodes, render functions, event handlers, refs, or StyleX styles are documented for Astryx parity but cannot be serialized directly from Python unless the wrapper adapts them.

See Astryx component docs: https://astryx.atmeta.com/components/Breadcrumbs.

Functions

constructor__init__(items, *, separator=None, variant=None, label=None, **props) -> None

paramitemsIterable[Any]

Item records used by generated child components or static search sources.

paramseparatorstr | None

= None

Separator text between breadcrumb items.

paramvariantstr | None

= None

Default or supporting visual treatment.

paramlabelstr | None

= None

Accessible navigation label.

parampropsAny

= {}

Returns

None

Functions

On this page