Calendar

Render an Astryx calendar date picker.

Astryx Props

JSON-safe Calendar props forwarded to Astryx.

Supported Astryx props include:

mode ('single' or 'range'): Selection mode.
value (ISODateString or DateRange): Controlled selected value.
defaultValue (ISODateString or DateRange): Uncontrolled default value.
onChange (Function): Selection callback.
numberOfMonths (1 or 2): Number of months to display.
min (ISODateString): Minimum selectable date.
max (ISODateString): Maximum selectable date.
dateConstraints (Array<(date: Date) => boolean>): Custom constraint functions.
focusDate (ISODateString): Controlled visible month.
onFocusDateChange ((focusDate: ISODateString) => void): Navigation callback.
handleRef (React.Ref<CalendarHandle>): Imperative handle for calendar navigation, including navigateTo().
hasOutsideDays (boolean): Show days from adjacent months.
hasWeekNumbers (boolean): Show ISO week numbers.
hasVariableRowCount (boolean): Variable vs fixed 6-row grid.
weekStartsOn (0 or 1 or 2 or 3 or 4 or 5 or 6 or 'sun' or 'mon' or 'tue' or 'wed' or 'thu' or 'fri' or 'sat'): First day of week. Accepts a number (0=Sunday) or a three-letter day name (e.g. "mon").

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

Functions

constructor__init__

(value=None, *, mode='single', number_of_months=None, min=None, max=None, outside_days=None, week_numbers=None, variable_rows=None, week_starts_on=None, **props) -> None

paramvaluestr | Mapping[str, str] | None

= None

Synchronized component value.

parammodestr

= 'single'

Component mode.

paramnumber_of_monthsint | None

= None

Number of months displayed.

paramminstr | None

= None

Minimum selectable ISO date.

parammaxstr | None

= None

Maximum selectable ISO date.

paramoutside_daysbool | None

= None

Whether to show dates from adjacent months.

paramweek_numbersbool | None

= None

Whether to show ISO week numbers.

paramvariable_rowsbool | None

= None

Whether the calendar uses a variable row count.

paramweek_starts_onint | str | None

= None

First day of the week.

parampropsAny

= {}

Returns

None

Functions

On this page