Maia Documentation

Appearance

maia.component-library / CalendarRootProps

Interface: CalendarRootProps<T, M> ​

Defined in: node_modules/.pnpm/@heroui+react@3.2.1_@react-_0c36d9022f1aaf46c104e0a6d2192bf4/node_modules/@heroui/react/dist/components/calendar/calendar.d.ts:8

Extends ​

Type Parameters ​

T ​

T extends DateValue = DateValue

M ​

M extends CalendarSelectionMode = "single"

Properties ​

aria-describedby? ​

optional aria-describedby?: string

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:51

Identifies the element (or elements) that describes the object.

Inherited from ​

AlertDialogDialogProps.aria-describedby

aria-details? ​

optional aria-details?: string

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:57

Identifies the element (or elements) that provide a detailed, extended description for the object.

Inherited from ​

AlertDialogDialogProps.aria-details

aria-label? ​

optional aria-label?: string

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:41

Defines a string value that labels the current element.

Inherited from ​

AlertDialogDialogProps.aria-label

aria-labelledby? ​

optional aria-labelledby?: string

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:46

Identifies the element (or elements) that labels the current element.

Inherited from ​

AlertDialogDialogProps.aria-labelledby

autoFocus? ​

optional autoFocus?: boolean

Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/calendar/types.d.ts:29

Whether to automatically focus the calendar when it mounts.

Default ​

ts
false

Inherited from ​

RACCalendarProps.autoFocus

children? ​

optional children?: ChildrenOrFunction<CalendarRenderProps<M>>

Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/utils.d.ts:128

The children of the component. A function may be provided to alter the children based on component state.

Inherited from ​

RACCalendarProps.children

className? ​

optional className?: ClassNameOrFunction<CalendarRenderProps<M>>

Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/Calendar.d.ts:42

The CSS className for the element. A function may be provided to compute the class based on component state.

Default ​

ts
'react-aria-Calendar'

Inherited from ​

RACCalendarProps.className

createCalendar? ​

optional createCalendar?: (identifier) => Calendar

Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/Calendar.d.ts:55

A function to create a new Calendar object for a given calendar identifier. If not provided, the createCalendar function from @internationalized/date will be used.

Parameters ​

identifier ​

CalendarIdentifier

Returns ​

Calendar

Inherited from ​

RACCalendarProps.createCalendar

defaultFocusedValue? ​

optional defaultFocusedValue?: DateValue | null

Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/calendar/types.d.ts:33

The date that is focused when the calendar first mounts (uncontrolled).

Inherited from ​

RACCalendarProps.defaultFocusedValue

defaultValue? ​

optional defaultValue?: CalendarValueType<T | null, M>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/inputs.d.ts:73

The default value (uncontrolled).

Inherited from ​

RACCalendarProps.defaultValue

defaultYearPickerOpen? ​

optional defaultYearPickerOpen?: boolean

Defined in: node_modules/.pnpm/@heroui+react@3.2.1_@react-_0c36d9022f1aaf46c104e0a6d2192bf4/node_modules/@heroui/react/dist/components/calendar/calendar.d.ts:11

dir? ​

optional dir?: string

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:299

Inherited from ​

RACCalendarProps.dir

firstDayOfWeek? ​

optional firstDayOfWeek?: "sun" | "mon" | "tue" | "wed" | "thu" | "fri" | "sat"

Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/calendar/types.d.ts:56

The day that starts the week.

Inherited from ​

RACCalendarProps.firstDayOfWeek

focusedValue? ​

optional focusedValue?: DateValue | null

Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/calendar/types.d.ts:31

Controls the currently focused date within the calendar.

Inherited from ​

RACCalendarProps.focusedValue

hidden? ​

optional hidden?: boolean

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:301

Inherited from ​

RACCalendarProps.hidden

id? ​

optional id?: string

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:75

The element's unique identifier. See MDN.

Inherited from ​

AlertDialogDialogProps.id

inert? ​

optional inert?: boolean

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:302

Inherited from ​

RACCalendarProps.inert

isDateUnavailable? ​

optional isDateUnavailable?: (date) => boolean

Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/calendar/useCalendarState.d.ts:15

Callback that is called for each date of the calendar. If it returns true, then the date is unavailable.

Parameters ​

date ​

DateValue

Returns ​

boolean

Inherited from ​

RACCalendarProps.isDateUnavailable

isDisabled? ​

optional isDisabled?: boolean

Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/calendar/types.d.ts:17

Whether the calendar is disabled.

Default ​

ts
false

Inherited from ​

RACCalendarProps.isDisabled

isInvalid? ​

optional isInvalid?: boolean

Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/calendar/types.d.ts:43

Whether the current selection is invalid according to application logic.

Inherited from ​

RACCalendarProps.isInvalid

isReadOnly? ​

optional isReadOnly?: boolean

Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/calendar/types.d.ts:23

Whether the calendar value is immutable.

Default ​

ts
false

Inherited from ​

RACCalendarProps.isReadOnly

isYearPickerOpen? ​

optional isYearPickerOpen?: boolean

Defined in: node_modules/.pnpm/@heroui+react@3.2.1_@react-_0c36d9022f1aaf46c104e0a6d2192bf4/node_modules/@heroui/react/dist/components/calendar/calendar.d.ts:9

lang? ​

optional lang?: string

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:300

Inherited from ​

RACCalendarProps.lang

maxValue? ​

optional maxValue?: DateValue | null

Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/calendar/types.d.ts:11

The maximum allowed date that a user may select.

Inherited from ​

RACCalendarProps.maxValue

minValue? ​

optional minValue?: DateValue | null

Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/calendar/types.d.ts:9

The minimum allowed date that a user may select.

Inherited from ​

RACCalendarProps.minValue

onAnimationEnd? ​

optional onAnimationEnd?: AnimationEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:382

Inherited from ​

RACCalendarProps.onAnimationEnd

onAnimationEndCapture? ​

optional onAnimationEndCapture?: AnimationEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:383

Inherited from ​

RACCalendarProps.onAnimationEndCapture

onAnimationIteration? ​

optional onAnimationIteration?: AnimationEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:384

Inherited from ​

RACCalendarProps.onAnimationIteration

onAnimationIterationCapture? ​

optional onAnimationIterationCapture?: AnimationEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:385

Inherited from ​

RACCalendarProps.onAnimationIterationCapture

onAnimationStart? ​

optional onAnimationStart?: AnimationEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:380

Inherited from ​

RACCalendarProps.onAnimationStart

onAnimationStartCapture? ​

optional onAnimationStartCapture?: AnimationEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:381

Inherited from ​

RACCalendarProps.onAnimationStartCapture

onAuxClick? ​

optional onAuxClick?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:322

Inherited from ​

RACCalendarProps.onAuxClick

onAuxClickCapture? ​

optional onAuxClickCapture?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:323

Inherited from ​

RACCalendarProps.onAuxClickCapture

onChange? ​

optional onChange?: (value) => void

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/inputs.d.ts:75

Handler that is called when the value changes.

Parameters ​

value ​

CalendarValueType

Returns ​

void

Inherited from ​

RACCalendarProps.onChange

onClick? ​

optional onClick?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:320

Inherited from ​

RACCalendarProps.onClick

onClickCapture? ​

optional onClickCapture?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:321

Inherited from ​

RACCalendarProps.onClickCapture

onContextMenu? ​

optional onContextMenu?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:324

Inherited from ​

RACCalendarProps.onContextMenu

onContextMenuCapture? ​

optional onContextMenuCapture?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:325

Inherited from ​

RACCalendarProps.onContextMenuCapture

onDoubleClick? ​

optional onDoubleClick?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:326

Inherited from ​

RACCalendarProps.onDoubleClick

onDoubleClickCapture? ​

optional onDoubleClickCapture?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:327

Inherited from ​

RACCalendarProps.onDoubleClickCapture

onFocusChange? ​

optional onFocusChange?: (date) => void

Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/calendar/types.d.ts:35

Handler that is called when the focused date changes.

Parameters ​

date ​

CalendarDate

Returns ​

void

Inherited from ​

RACCalendarProps.onFocusChange

onGotPointerCapture? ​

optional onGotPointerCapture?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:366

Inherited from ​

RACCalendarProps.onGotPointerCapture

onGotPointerCaptureCapture? ​

optional onGotPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:367

Inherited from ​

RACCalendarProps.onGotPointerCaptureCapture

onLostPointerCapture? ​

optional onLostPointerCapture?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:368

Inherited from ​

RACCalendarProps.onLostPointerCapture

onLostPointerCaptureCapture? ​

optional onLostPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:369

Inherited from ​

RACCalendarProps.onLostPointerCaptureCapture

onMouseDown? ​

optional onMouseDown?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:328

Inherited from ​

RACCalendarProps.onMouseDown

onMouseDownCapture? ​

optional onMouseDownCapture?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:329

Inherited from ​

RACCalendarProps.onMouseDownCapture

onMouseEnter? ​

optional onMouseEnter?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:330

Inherited from ​

RACCalendarProps.onMouseEnter

onMouseLeave? ​

optional onMouseLeave?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:331

Inherited from ​

RACCalendarProps.onMouseLeave

onMouseMove? ​

optional onMouseMove?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:332

Inherited from ​

RACCalendarProps.onMouseMove

onMouseMoveCapture? ​

optional onMouseMoveCapture?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:333

Inherited from ​

RACCalendarProps.onMouseMoveCapture

onMouseOut? ​

optional onMouseOut?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:334

Inherited from ​

RACCalendarProps.onMouseOut

onMouseOutCapture? ​

optional onMouseOutCapture?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:335

Inherited from ​

RACCalendarProps.onMouseOutCapture

onMouseOver? ​

optional onMouseOver?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:336

Inherited from ​

RACCalendarProps.onMouseOver

onMouseOverCapture? ​

optional onMouseOverCapture?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:337

Inherited from ​

RACCalendarProps.onMouseOverCapture

onMouseUp? ​

optional onMouseUp?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:338

Inherited from ​

RACCalendarProps.onMouseUp

onMouseUpCapture? ​

optional onMouseUpCapture?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:339

Inherited from ​

RACCalendarProps.onMouseUpCapture

onPointerCancel? ​

optional onPointerCancel?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:358

Inherited from ​

RACCalendarProps.onPointerCancel

onPointerCancelCapture? ​

optional onPointerCancelCapture?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:359

Inherited from ​

RACCalendarProps.onPointerCancelCapture

onPointerDown? ​

optional onPointerDown?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:352

Inherited from ​

RACCalendarProps.onPointerDown

onPointerDownCapture? ​

optional onPointerDownCapture?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:353

Inherited from ​

RACCalendarProps.onPointerDownCapture

onPointerEnter? ​

optional onPointerEnter?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:360

Inherited from ​

RACCalendarProps.onPointerEnter

onPointerLeave? ​

optional onPointerLeave?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:361

Inherited from ​

RACCalendarProps.onPointerLeave

onPointerMove? ​

optional onPointerMove?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:354

Inherited from ​

RACCalendarProps.onPointerMove

onPointerMoveCapture? ​

optional onPointerMoveCapture?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:355

Inherited from ​

RACCalendarProps.onPointerMoveCapture

onPointerOut? ​

optional onPointerOut?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:364

Inherited from ​

RACCalendarProps.onPointerOut

onPointerOutCapture? ​

optional onPointerOutCapture?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:365

Inherited from ​

RACCalendarProps.onPointerOutCapture

onPointerOver? ​

optional onPointerOver?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:362

Inherited from ​

RACCalendarProps.onPointerOver

onPointerOverCapture? ​

optional onPointerOverCapture?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:363

Inherited from ​

RACCalendarProps.onPointerOverCapture

onPointerUp? ​

optional onPointerUp?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:356

Inherited from ​

RACCalendarProps.onPointerUp

onPointerUpCapture? ​

optional onPointerUpCapture?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:357

Inherited from ​

RACCalendarProps.onPointerUpCapture

onScroll? ​

optional onScroll?: UIEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:372

Inherited from ​

RACCalendarProps.onScroll

onScrollCapture? ​

optional onScrollCapture?: UIEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:373

Inherited from ​

RACCalendarProps.onScrollCapture

onTouchCancel? ​

optional onTouchCancel?: TouchEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:342

Inherited from ​

RACCalendarProps.onTouchCancel

onTouchCancelCapture? ​

optional onTouchCancelCapture?: TouchEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:343

Inherited from ​

RACCalendarProps.onTouchCancelCapture

onTouchEnd? ​

optional onTouchEnd?: TouchEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:344

Inherited from ​

RACCalendarProps.onTouchEnd

onTouchEndCapture? ​

optional onTouchEndCapture?: TouchEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:345

Inherited from ​

RACCalendarProps.onTouchEndCapture

onTouchMove? ​

optional onTouchMove?: TouchEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:346

Inherited from ​

RACCalendarProps.onTouchMove

onTouchMoveCapture? ​

optional onTouchMoveCapture?: TouchEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:347

Inherited from ​

RACCalendarProps.onTouchMoveCapture

onTouchStart? ​

optional onTouchStart?: TouchEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:348

Inherited from ​

RACCalendarProps.onTouchStart

onTouchStartCapture? ​

optional onTouchStartCapture?: TouchEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:349

Inherited from ​

RACCalendarProps.onTouchStartCapture

onTransitionCancel? ​

optional onTransitionCancel?: TransitionEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:388

Inherited from ​

RACCalendarProps.onTransitionCancel

onTransitionCancelCapture? ​

optional onTransitionCancelCapture?: TransitionEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:389

Inherited from ​

RACCalendarProps.onTransitionCancelCapture

onTransitionEnd? ​

optional onTransitionEnd?: TransitionEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:390

Inherited from ​

RACCalendarProps.onTransitionEnd

onTransitionEndCapture? ​

optional onTransitionEndCapture?: TransitionEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:391

Inherited from ​

RACCalendarProps.onTransitionEndCapture

onTransitionRun? ​

optional onTransitionRun?: TransitionEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:392

Inherited from ​

RACCalendarProps.onTransitionRun

onTransitionRunCapture? ​

optional onTransitionRunCapture?: TransitionEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:393

Inherited from ​

RACCalendarProps.onTransitionRunCapture

onTransitionStart? ​

optional onTransitionStart?: TransitionEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:394

Inherited from ​

RACCalendarProps.onTransitionStart

onTransitionStartCapture? ​

optional onTransitionStartCapture?: TransitionEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:395

Inherited from ​

RACCalendarProps.onTransitionStartCapture

onWheel? ​

optional onWheel?: WheelEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:376

Inherited from ​

RACCalendarProps.onWheel

onWheelCapture? ​

optional onWheelCapture?: WheelEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:377

Inherited from ​

RACCalendarProps.onWheelCapture

onYearPickerOpenChange? ​

optional onYearPickerOpenChange?: (isYearPickerOpen) => void

Defined in: node_modules/.pnpm/@heroui+react@3.2.1_@react-_0c36d9022f1aaf46c104e0a6d2192bf4/node_modules/@heroui/react/dist/components/calendar/calendar.d.ts:10

Parameters ​

isYearPickerOpen ​

boolean

Returns ​

void

pageBehavior? ​

optional pageBehavior?: PageBehavior

Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/calendar/types.d.ts:52

Controls the behavior of paging. Pagination either works by advancing the visible page by visibleDuration (default) or one unit of visibleDuration.

Default ​

ts
visible

Inherited from ​

RACCalendarProps.pageBehavior

render? ​

optional render?: DOMRenderFunction<"div", CalendarRenderProps<M>>

Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/utils.d.ts:194

Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components.

Requirements:

  • You must render the expected element type (e.g. if <button> is expected, you cannot render an <a>).
  • Only a single root DOM element can be rendered (no fragments).
  • You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.

Inherited from ​

RACCalendarProps.render

selectionAlignment? ​

optional selectionAlignment?: "center" | "end" | "start"

Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/calendar/types.d.ts:63

Determines the alignment of the visible months on initial render based on the current selection or current date if there is no selection.

Default ​

ts
'center'

Inherited from ​

RACCalendarProps.selectionAlignment

selectionMode? ​

optional selectionMode?: M

Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/calendar/useCalendarState.d.ts:10

Whether single or multiple selection is enabled.

Default ​

ts
'single'

Inherited from ​

RACCalendarProps.selectionMode

slot? ​

optional slot?: string | null

Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/utils.d.ts:158

A slot name for the component. Slots allow the component to receive props from a parent component. An explicit null value indicates that the local props completely override all props received from a parent.

Inherited from ​

RACCalendarProps.slot

style? ​

optional style?: StyleOrFunction<CalendarRenderProps<M>>

Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/utils.d.ts:118

The inline style for the element. A function may be provided to compute the style based on component state.

Inherited from ​

RACCalendarProps.style

translate? ​

optional translate?: "yes" | "no"

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:303

Inherited from ​

RACCalendarProps.translate

value? ​

optional value?: CalendarValueType<T | null, M>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/inputs.d.ts:71

The current value (controlled).

Inherited from ​

RACCalendarProps.value

visibleDuration? ​

optional visibleDuration?: DateDuration

Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/Calendar.d.ts:48

The amount of days that will be displayed at once. This affects how pagination works.

Default ​

ts
{ months: 1 }

Inherited from ​

RACCalendarProps.visibleDuration

weeksInMonth? ​

optional weeksInMonth?: number

Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/calendar/types.d.ts:67

The number of weeks in a month. This overrides the default set by the locale.

Inherited from ​

RACCalendarProps.weeksInMonth