PeriodCalendarProps

No behavioral description is attached to this declaration. The public signature, parameter and return types, and source location below document its published contract.

Kind: Type alias
Package: @ovok/native

Import

import { PeriodCalendarProps } from '@ovok/native/ui';

TypeScript shape

type PeriodCalendarProps = Omit<CalendarProps, "markers" | "getMarkerForDate"> & {
    periods: readonly PeriodDateRange[];
    periodLabel?: string;
    labelForPeriodDate?: (date: Date) => string;
    showLegend?: boolean;
};

This is a type-level export; it has no call parameters.

Public members

Member	Type	Details
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.
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. —
labelForDate	(date: Date) => string	Optional. —
previousMonthLabel	string	Optional. —
nextMonthLabel	string	Optional. —
periods	readonly PeriodDateRange[]	—
periodLabel	string	Optional. —
labelForPeriodDate	(date: Date) => string	Optional. —
showLegend	boolean	Optional. —

Learn the workflow

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

Source

View the declaration in the SDK source.