Toolbar

Render an Astryx toolbar with optional slots.

Astryx Props

JSON-safe Toolbar props forwarded to Astryx.

Supported Astryx props include:

startContent (ReactNode): Content aligned to the start side.
centerContent (ReactNode): Content centered between start and end; switches layout to a three-column grid.
endContent (ReactNode): Content aligned to the end side.
label (string; required): Accessible label applied to the toolbar element.
size ('sm' or 'md' or 'lg'; default 'md'): Toolbar size cascaded to common child controls through SizeContext.
gap (spacing step; default 1): Gap between items within each slot.
orientation ('horizontal' or 'vertical'; default 'horizontal'): Keyboard navigation orientation.
variant (SectionVariant; default transparent): Visual variant passed through to the underlying Section.
dividers (array of 'top', 'bottom', 'start', or 'end'): Divider borders passed through to the underlying Section.
xstyle (StyleXStyles): StyleX styles for the Section root.
className (string): CSS class names for the Section root.
style (CSSProperties): Inline styles for the Section root.

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/Toolbar.

Functions

constructor__init__(children=None, *, label, size='sm', gap=1, orientation=None, variant=None, dividers=None, **props) -> None

paramchildrenChildInput

= None

Child widget, sequence of widgets, or mapping of slot names to widgets.

paramlabelstr

Visible or accessible label for the component.

paramsizestr

= 'sm'

Astryx component option.

paramgapint | float

= 1

Astryx spacing step between children.

paramorientationstr | None

= None

Horizontal or vertical keyboard navigation.

paramvariantstr | None

= None

Toolbar section visual variant.

paramdividersIterable[str] | None

= None

Toolbar sides that display divider borders.

parampropsAny

= {}

Returns

None

Functions

On this page