API Reference

DayButtonState

interface

State exposed by the DayButton component (same as DayCellTemplateState).

Defined in package/src/types.ts:683

PropTypeDefaultDescription
root*RootState<F>
date*PlainDate
columnIndex*number
orientation*GridOrientation
selected*boolean
today*boolean
disabled*boolean
outsideMonth*boolean
hidden*boolean
focused*boolean
rangeStart*boolean
rangeEnd*boolean
rangeBoundary*boolean
inRange*booleanWhether this cell is within the committed range.
rangeIndex*number | false0-based index of this cell within the committed range, or false if not in range.
rangeLength*number | falseTotal number of days in the committed range, or false if not in range.
rangeHasStart*booleanWhether the committed range has a defined start boundary.
rangeHasEnd*booleanWhether the committed range has a defined end boundary.
rangePreviewStart*booleanWhether this cell is the start of the hover preview range.
rangePreviewEnd*booleanWhether this cell is the end of the hover preview range.
rangePreviewBoundary*booleanWhether this cell is a boundary of the hover preview range.
rangePreviewInRange*booleanWhether this cell is within the hover preview range.
rangePreviewIndex*number | false0-based index of this cell within the preview range, or false if not in preview range.
rangePreviewLength*number | falseTotal number of days in the preview range, or false if not in preview range.
rangePreviewHasStart*booleanWhether the preview range has a defined start boundary.
rangePreviewHasEnd*booleanWhether the preview range has a defined end boundary.