InputGroup

Group an input with prefix and suffix adornments.

Astryx Props

JSON-safe InputGroup props forwarded to Astryx.

Supported Astryx props include:

children (ReactNode; required): Input and InputGroupText children.
label (string; required): Accessible label for the group.
isLabelHidden (boolean): Visually hide the label.
description (string): Helper text between label and input group.
isDisabled (boolean): Disable the entire group.
isOptional (boolean): Show "(optional)" indicator.
isRequired (boolean): Mark the field as required.
size ('sm' or 'md' or 'lg'): Default size for inputs in the group.
status (InputStatus): Status indicator applied to the group border.
labelTooltip (string): Tooltip text at the end of the label.
xstyle (StyleXStyles): StyleX styles for layout customization.
data-testid (string): Test selector.

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

Functions

constructor__init__

(children=None, *, label, prefix='', suffix='', disabled=False, label_hidden=None, description=None, optional=None, required=None, size=None, status=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.

paramprefixstr

= ''

Text rendered before grouped input children.

paramsuffixstr

= ''

Text rendered after grouped input children.

paramdisabledbool

= False

Whether the component should render disabled.

paramlabel_hiddenbool | None

= None

Whether to visually hide the accessible label.

paramdescriptionstr | None

= None

Helper text displayed with the group.

paramoptionalbool | None

= None

Whether to mark the group optional.

paramrequiredbool | None

= None

Whether to mark the group required.

paramsizestr | None

= None

Default child input size.

paramstatusMapping[str, Any] | None

= None

Validation status record.

parampropsAny

= {}

Returns

None

Functions

On this page