API Reference
Complete API reference for @gentleduck/calendar hooks, core functions, and types.
Full prop tables, return types, and type definitions for every export in
@gentleduck/calendar.Hooks
| Export | Description |
|---|---|
| useCalendar | Main calendar hook - state, actions, and prop getters |
| useTimePicker | Time picker hook - spinbutton fields and keyboard input |
| useDateTime | Combined date + time hook |
useAnnouncer | Screen reader announcement hook |
useKeyboard | Keyboard navigation hook |
Core functions
| Export | Description |
|---|---|
| Grid | Grid builder functions - buildCalendarMonth, buildMultiMonth, etc. |
| Selection | Selection logic - selectDay, applySelection |
| Navigation | Navigation functions - navigate, canNavigate |
isDateDisabled | Check if a date is disabled by the current constraints |
isInRange | Check if a date falls within a range |
clampTime | Clamp a time value to min/max bounds |
formatTimeField | Format a single time field for display |
getAmPm | Get the AM/PM value from a time |
incrementField | Increment or decrement a time field by step |
isValidTime | Validate a time value against constraints |
parseTimeInput | Parse raw keyboard input into a time field value |
to12Hour | Convert a 24-hour value to 12-hour format |
to24Hour | Convert a 12-hour value to 24-hour format |
Types
These types are exported from @gentleduck/calendar and used across the API:
| Type | Description |
|---|---|
Adapter.IDateAdapter<TDate> | Interface for pluggable date backends |
Calendar.ICalendarConfig<TDate, M> | Full calendar configuration |
Calendar.ICalendarLocaleConfig | Locale settings (locale tag, week start day, direction, numbering system, calendar) |
Selection.CalendarValue<TDate, M> | Conditional type resolving per selection mode |
Grid.ICalendarDay<TDate> | Day cell with selection/state flags |
Grid.ICalendarWeek<TDate> | Week with weekNumber + 7 days |
Grid.ICalendarMonth<TDate> | Month grid with weeks |
Selection.SelectionMode | 'single' | 'range' | 'multi' | 'multi-range' |
Selection.ISelectionConstraints<TDate> | Disabled dates and date bounds |
Selection.DateRange<TDate> | { from: TDate, to: TDate | null } |
Navigation.Direction | 'prev' | 'next' |
Navigation.Unit | 'month' | 'year' | 'decade' |
UseCalendar.IDayProps | Props returned by getDayProps |
UseCalendar.IGridProps | Props returned by getGridProps |
UseCalendar.INavProps | Props returned by getNavProps |
UseCalendar.IHeaderProps | Props returned by getHeaderProps |
UseAnnouncer.IAnnouncerReturn | Return type of useAnnouncer |
UseKeyboard.IKeyboardConfig<TDate> | Configuration for the keyboard navigation hook |
UseKeyboard.IKeyboardReturn | Return type of useKeyboard |
UseTimePicker.ITimeFieldProps | Props returned by getFieldProps |
Time.ITimeValue | { hour, minute, second? } |
Time.TimeField | 'hour' | 'minute' | 'second' | 'ampm' |
Time.HourCycle | '12' | '24' |
Time.ITimePickerConfig | Configuration for the time picker |
UseCalendar.IUseCalendarConfig<TDate, M> | Configuration accepted by useCalendar |
UseCalendar.IUseCalendarReturn<TDate, M> | Return type of useCalendar |
UseTimePicker.IUseTimePickerConfig | Configuration accepted by useTimePicker |
UseTimePicker.IUseTimePickerReturn | Return type of useTimePicker |
UseDateTime.IUseDateTimeConfig<TDate> | Configuration accepted by useDateTime |
UseDateTime.IUseDateTimeReturn<TDate> | Return type of useDateTime |
Calendar.ViewMode | 'days' | 'months' | 'years' |
Adapter.WeekStartDay | Numeric day used as the first day of the week |
Grid.IDecadeEntry | Entry in the decade view grid |
Grid.IYearEntry | Entry in the year view grid |