AnyLumino
API referenceastryxinputs

DateRangeInput

Render an Astryx date-range input.

Astryx Props

JSON-safe DateRangeInput props forwarded to Astryx.

Supported Astryx props include:

  • label (string; required): Label text.
  • isLabelHidden (boolean): Visually hide the label.
  • description (string): Helper text displayed below the label.
  • isOptional (boolean): Show an "(optional)" indicator.
  • isRequired (boolean): Mark the field as required.
  • isDisabled (boolean): Disable the trigger and picker.
  • value (DateRange or null; required): Selected date range ({start, end} in ISO format), or null.
  • onChange ((value: DateRange or null) => void; required): Callback when the range changes. Called with null on clear.
  • changeAction ((value: DateRange or null) => void or Promise<void>): Async action fired after onChange. Drives optimistic UI updates via useTransition.
  • isLoading (boolean): Whether the input is in a loading state. Disables interaction and shows a spinner.
  • min (ISODateString): Minimum selectable date.
  • max (ISODateString): Maximum selectable date.
  • dateConstraints (Array<(date: Date) => boolean>): Custom constraint functions to disable specific dates.
  • presets (Array<DateRangePreset>): Preset ranges shown as quick-select options beside the calendar.
  • hasClear (boolean): Shows a clear button when a range is selected.
  • placeholder (string): Placeholder text when no range is selected.
  • size ('sm' or 'md' or 'lg'): Size of the trigger.
  • status (InputStatus): Status indicator for error, warning, or success states.
  • labelTooltip (string): Tooltip text via info icon at label end.
  • numberOfMonths (1 or 2): Number of months in the calendar.
  • xstyle (StyleXStyles): StyleX styles for layout customization.

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

Functions

constructor__init__(value=None, *, label='', disabled=False, min=None, max=None, presets=None, clear=None, placeholder=None, size=None, number_of_months=None, **props) -> None
paramvalueMapping[str, str] | None
= None

Synchronized component value.

paramlabelstr
= ''

Visible or accessible label for the component.

paramdisabledbool
= False

Whether the input is disabled.

paramminstr | None
= None

Minimum ISO date.

parammaxstr | None
= None

Maximum ISO date.

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

Named date-range presets.

paramclearbool | None
= None

Whether to show a clear button.

paramplaceholderstr | None
= None

Placeholder text.

paramsizestr | None
= None

Input size.

paramnumber_of_monthsint | None
= None

Number of calendar months to display.

parampropsAny
= {}

Returns

None

On this page