CalendarProps
No behavioral description is attached to this declaration. The public signature, parameter and return types, and source location below document its published contract.
Kind: Interface
Package: @ovok/native
Import
import { CalendarProps } from '@ovok/native/ui';
TypeScript shape
interface CalendarProps extends OvokUiProps {
selectedDate?: CalendarDateInput | null;
defaultSelectedDate?: CalendarDateInput;
onDateSelect?: (date: Date) => void;
visibleMonth?: CalendarDateInput;
defaultVisibleMonth?: CalendarDateInput;
onVisibleMonthChange?: (month: Date) => void;
locale?: string;
weekStartsOn?: WeekStartsOn;
minDate?: CalendarDateInput;
maxDate?: CalendarDateInput;
isDateDisabled?: (date: Date) => boolean;
markers?: readonly CalendarDayMarker[];
getMarkerForDate?: (date: Date) => CalendarDayMarker | undefined;
labelForDate?: (date: Date) => string;
previousMonthLabel?: string;
nextMonthLabel?: string;
testID?: string;
}
This is a type-level export; it has no call parameters.
Public members
| Member | Type | Details |
|---|---|---|
selectedDate | CalendarDateInput | null | Optional. — |
defaultSelectedDate | CalendarDateInput | Optional. — |
onDateSelect | (date: Date) => void | Optional. — |
visibleMonth | CalendarDateInput | Optional. — |
defaultVisibleMonth | CalendarDateInput | Optional. — |
onVisibleMonthChange | (month: Date) => void | Optional. — |
locale | string | Optional. — |
weekStartsOn | WeekStartsOn | Optional. — |
minDate | CalendarDateInput | Optional. — |
maxDate | CalendarDateInput | Optional. — |
isDateDisabled | (date: Date) => boolean | Optional. — |
markers | readonly CalendarDayMarker[] | Optional. — |
getMarkerForDate | (date: Date) => CalendarDayMarker | undefined | Optional. — |
labelForDate | (date: Date) => string | Optional. — |
previousMonthLabel | string | Optional. — |
nextMonthLabel | string | Optional. — |
testID | string | Optional. — |
theme | OvokThemeOverride | Optional. A partial theme is merged with the active react-native-paper theme. |
slots | Partial<OvokUiSlots> | Optional. Replace individual primitives without forking an SDK component. |
Learn the workflow
Continue with Ui And Data for the workflow context and examples.