AnyLumino
API referenceastryxsurfaces

RadioList

Render a single-choice Astryx radio list.

Astryx Props

JSON-safe RadioList props forwarded to Astryx.

Supported Astryx props include:

  • label (string; required): Label text for the radio group (always rendered for accessibility).
  • value (string; required): The currently selected value.
  • onChange ((value: string) => void; required): Callback fired when the selected value changes.
  • children (ReactNode; required): RadioListItem elements.
  • isLabelHidden (boolean): Whether to visually hide the label.
  • description (string): Description text displayed below the label.
  • orientation ('vertical' or 'horizontal'): Layout direction of the radio items.
  • isDisabled (boolean): Whether all radio items are disabled.
  • isRequired (boolean): Whether the radio group is required.
  • isOptional (boolean): Whether the field is optional (mutually exclusive with isRequired).
  • status (InputStatus): Status indicator ({ type, message }).
  • size ('sm' or 'md'): Size of the radio controls.
  • labelTooltip (string): Tooltip text for an info icon next to the 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/RadioList.

Functions

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

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

paramvaluestr

Synchronized component value.

paramlabelstr

Visible or accessible label for the component.

paramorientationstr | None
= None

Vertical or horizontal item layout.

paramdisabledbool
= False

Whether all radio items are disabled.

paramsizestr | None
= None

Radio control size.

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