ToggleButtonGroup

Render a single- or multiple-selection group of toggle buttons.

Astryx Props

children, value, label, type, orientation, size, and isDisabled are adapted by the named arguments above. **props keeps the wrapper forward-compatible with additional JSON-safe Astryx props.

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

Functions

constructor__init__

(items, value=None, *, label, selection_mode='single', orientation='horizontal', size=None, disabled=False, **props) -> None

paramitemsIterable[Any]

Button labels, (label, value) pairs, or item mappings. Mappings can also set disabled and individual button props.

paramvaluestr | Iterable[str] | None

= None

Selected value for single selection, or selected values for multiple selection.

paramlabelstr

Accessible label for the group.

paramselection_modestr

= 'single'

"single" for exclusive selection or "multiple" for independent selections.

paramorientationstr

= 'horizontal'

Horizontal or vertical button layout.

paramsizestr | None

= None

Default size inherited by every toggle button.

paramdisabledbool

= False

Whether all toggle buttons are disabled.

parampropsAny

= {}

Returns

None

Functions

On this page