AnyLumino
API referenceastryxinputs

Slider

Render an Astryx slider control.

Astryx Props

JSON-safe Slider props forwarded to Astryx.

Supported Astryx props include:

  • label (string; required): Label text (always rendered for accessibility).
  • value (number or [number, number]; required): Current value: a 'number' for single thumb mode or '[number, number]' for range mode.
  • onChange ((value: number) => void or (value: [number, number]) => void): Callback fired on value change during drag.
  • onChangeEnd ((value: number) => void or (value: [number, number]) => void): Callback fired when drag ends.
  • min (number): Minimum value.
  • max (number): Maximum value.
  • step (number): Step increment.
  • orientation ('horizontal' or 'vertical'): Orientation of the slider.
  • formatValue ((value: number) => string): Custom value formatting function used for display and 'aria-valuetext'.
  • valueDisplay ('tooltip' or 'text' or 'none'): How the current value is displayed.
  • marks (Array<{ value: number; label?: string }>): Tick marks at specified positions with optional labels.
  • minStepsBetweenThumbs (number): Minimum number of steps between thumbs in range mode; prevents thumbs from overlapping.
  • isDisabled (boolean): Whether the slider is disabled.
  • isOptional (boolean): Whether the field is optional.
  • isRequired (boolean): Whether the field is required.
  • isLabelHidden (boolean): Whether to visually hide the label.
  • description (string): Description text rendered below the label.
  • status (InputStatus): Status indicator object ('{ type, message }') for validation feedback.
  • labelTooltip (string): Tooltip text for an info icon displayed 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/Slider.

Functions

constructor__init__(value=0, *, label='', label_position='top', label_width=None, disabled=False, min=None, max=None, step=None, orientation=None, value_display=None, marks=None, description=None, status=None, **props) -> None
paramvalueint | float | tuple[int | float, int | float] | list[int | float]
= 0

Synchronized component value.

paramlabelstr
= ''

Visible or accessible label for the component.

paramlabel_positionstr
= 'top'

Place the label above the slider or beside it in a compact row.

paramlabel_widthint | float | str | None
= None

Width of a left-side label. Use the same width to align sibling sliders.

paramdisabledbool
= False

Whether the component should render disabled.

paramminint | float | None
= None

Minimum slider value.

parammaxint | float | None
= None

Maximum slider value.

paramstepint | float | None
= None

Slider step increment.

paramorientationstr | None
= None

Horizontal or vertical orientation.

paramvalue_displaystr | None
= None

Tooltip, text, or hidden value presentation.

parammarksIterable[Mapping[str, Any]] | None
= None

Optional slider tick-mark records.

paramdescriptionstr | None
= None

Helper text displayed with the slider.

paramstatusMapping[str, Any] | None
= None

Validation status record.

parampropsAny
= {}

Returns

None

On this page