ProgressBar

Render an Astryx progress bar.

Astryx Props

JSON-safe ProgressBar props forwarded to Astryx.

Supported Astryx props include:

label (string; required): accessible label
value (number): Current value (ignored when indeterminate).
max (number): Maximum value.
isLabelHidden (boolean): Visually hide the label (remains accessible).
hasValueLabel (boolean): Show formatted value text (ignored when indeterminate).
formatValueLabel ((value: number, max: number) => string): Custom value label formatter; defaults to a percentage string.
variant ('accent' or 'success' or 'warning' or 'error' or 'neutral'): Semantic color variant.
isIndeterminate (boolean): Animated loading indicator for unknown progress.
isDisabled (boolean): Visually disabled state: grays out the fill and text. Use for canceled or inactive operations.
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/ProgressBar.

Functions

constructor__init__

(value=0, *, label, variant='accent', max=None, label_hidden=None, value_label=None, indeterminate=None, disabled=False, **props) -> None

paramvalueint | float

= 0

Synchronized component value.

paramlabelstr

Visible or accessible label for the component.

paramvariantstr

= 'accent'

Astryx visual variant.

parammaxint | float | None

= None

Maximum progress value.

paramlabel_hiddenbool | None

= None

Whether to visually hide the accessible label.

paramvalue_labelbool | None

= None

Whether to display the formatted value.

paramindeterminatebool | None

= None

Whether progress is unknown.

paramdisabledbool

= False

Whether to render the inactive visual state.

parampropsAny

= {}

Returns

None

Functions

On this page