Skip to main content

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​

MemberTypeDetails
selectedDateCalendarDateInput | nullOptional. —
defaultSelectedDateCalendarDateInputOptional. —
onDateSelect(date: Date) => voidOptional. —
visibleMonthCalendarDateInputOptional. —
defaultVisibleMonthCalendarDateInputOptional. —
onVisibleMonthChange(month: Date) => voidOptional. —
localestringOptional. —
weekStartsOnWeekStartsOnOptional. —
minDateCalendarDateInputOptional. —
maxDateCalendarDateInputOptional. —
isDateDisabled(date: Date) => booleanOptional. —
markersreadonly CalendarDayMarker[]Optional. —
getMarkerForDate(date: Date) => CalendarDayMarker | undefinedOptional. —
labelForDate(date: Date) => stringOptional. —
previousMonthLabelstringOptional. —
nextMonthLabelstringOptional. —
testIDstringOptional. —
themeOvokThemeOverrideOptional. A partial theme is merged with the active react-native-paper theme.
slotsPartial<OvokUiSlots>Optional. Replace individual primitives without forking an SDK component.

Learn the workflow​

Continue with Ui And Data for the workflow context and examples.

Source​

View the declaration in the SDK source.