AnyLumino
API referenceastryxsurfaces

CheckboxList

Render a multi-choice Astryx checkbox list.

Astryx Props

JSON-safe CheckboxList props forwarded to Astryx.

Supported Astryx props include:

  • label (string; required): Label text for the checkbox group (always rendered for accessibility).
  • children (ReactNode; required): CheckboxListItem elements.
  • value (string[]): The currently selected values (collection mode).
  • onChange ((values: string[]) => void): Callback fired when the selected values change.
  • changeAction ((values: string[]) => void or Promise<void>): Async action on change with optimistic updates. While the promise is pending, the toggled item shows a spinner inside its checkbox and is marked aria-busy.
  • isLabelHidden (boolean): Whether to visually hide the label.
  • description (string): Description text displayed below the label.
  • density ('compact' or 'balanced' or 'spacious'): Spacing density for list items.
  • hasDividers (boolean): Whether to show dividers between items.
  • isDisabled (boolean): Whether all checkbox items are disabled.
  • status (InputStatus): Status indicator ({ type, message }).
  • xstyle (StyleXStyles): StyleX styles for layout customization. Must be a stylex.create() value.

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

Functions

constructor__init__(items, value=(), *, label, density=None, dividers=None, disabled=False, label_hidden=None, description=None, status=None, **props) -> None
paramitemsIterable[Any]

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

paramvalueIterable[str]
= ()

Synchronized component value.

paramlabelstr

Visible or accessible label for the component.

paramdensitystr | None
= None

Item spacing density.

paramdividersbool | None
= None

Whether to show item dividers.

paramdisabledbool
= False

Whether all checkbox items are disabled.

paramlabel_hiddenbool | None
= None

Whether to visually hide the accessible label.

paramdescriptionstr | None
= None

Helper text displayed with the group.

paramstatusMapping[str, Any] | None
= None

Validation status record.

parampropsAny
= {}

Returns

None

On this page