ButtonGroup

Render an Astryx button group from item records.

Astryx Props

JSON-safe ButtonGroup props forwarded to Astryx.

Supported Astryx props include:

children (ReactNode; required): Button or IconButton children.
label (string; required): Accessible group label used as aria-label.
orientation ('horizontal' or 'vertical'; default 'horizontal'): Button group orientation and keyboard navigation axis.
size ('sm' or 'md' or 'lg'; default 'md'): Default size for buttons in the group; individual buttons can override it.
isDisabled (boolean; default false): Disables all buttons in the group.
data-testid (string): Test selector for automated testing.
xstyle (StyleXStyles): StyleX styles for the group root.
className (string): CSS class names for the group root.
style (CSSProperties): Inline styles for the group 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/ButtonGroup.

Functions

constructor__init__(items, *, label, callbacks=None, action_callbacks=None, orientation=None, size=None, disabled=False, **props) -> None

paramitemsIterable[Any]

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

paramlabelstr

Visible or accessible label for the component.

paramcallbacksIterable[Callable[[ComponentWidget], None]] | None

= None

Python callbacks invoked for frontend activations.

paramaction_callbacksIterable[Callable[[ComponentWidget, Any], None]] | None

= None

Python callbacks receiving the selected item value.

paramorientationstr | None

= None

Horizontal or vertical group orientation.

paramsizestr | None

= None

Default child button size.

paramdisabledbool

= False

Whether all buttons are disabled.

parampropsAny

= {}

Returns

None

Functions

On this page