0
Fork 0
mirror of https://github.com/TanStack/time.git synced 2026-11-16 19:09:47 +00:00
time/docs/reference/interfaces/CalendarCoreOptions.md
2026-08-22 23:22:16 +00:00

4.7 KiB

id title
CalendarCoreOptions CalendarCoreOptions

Interface: CalendarCoreOptions<TFeatures, TResource, TEvent>

Defined in: calendar/calendar.ts:59

Extends

Type Parameters

TFeatures

TFeatures extends CalendarFeatureList

TResource

TResource extends Resource = Resource

TEvent

TEvent extends Event<TResource> = Event<TResource>

Properties

calendar?

optional calendar: CalendarLike;

Defined in: calendar/date-core.ts:67

Inherited from

DateCoreOptions.calendar


calendars?

optional calendars: WorkingCalendar[] | null;

Defined in: calendar/calendar.ts:70


dateFormatter?

optional dateFormatter: DateTimeFormat;

Defined in: calendar/date-core.ts:71

Inherited from

DateCoreOptions.dateFormatter


dateTimeFormatter?

optional dateTimeFormatter: DateTimeFormat;

Defined in: calendar/date-core.ts:75

Inherited from

DateCoreOptions.dateTimeFormatter


defaultCalendarId?

optional defaultCalendarId: string;

Defined in: calendar/calendar.ts:72


events?

optional events: NoInfer<TEvent>[] | null;

Defined in: calendar/calendar.ts:66


features

features: TFeatures;

Defined in: calendar/calendar.ts:64


fetchEvents()?

optional fetchEvents: (range) => Promise<NoInfer<TEvent>[]>;

Defined in: calendar/calendar.ts:76

Parameters

range
end

string

start

string

Returns

Promise<NoInfer<TEvent>[]>


layout?

optional layout: LayoutOptions;

Defined in: calendar/calendar.ts:78


locale?

optional locale: string;

Defined in: calendar/date-core.ts:63

Inherited from

DateCoreOptions.locale


multiResource?

optional multiResource: "intersection" | "union";

Defined in: calendar/calendar.ts:74


range?

optional range: DateRange;

Defined in: calendar/date-core.ts:69

Inherited from

DateCoreOptions.range


resources?

optional resources: TResource[] | null;

Defined in: calendar/calendar.ts:68


timeFormatter?

optional timeFormatter: DateTimeFormat;

Defined in: calendar/date-core.ts:73

Inherited from

DateCoreOptions.timeFormatter


timeZone?

optional timeZone: TimeZoneLike;

Defined in: calendar/date-core.ts:65

Inherited from

DateCoreOptions.timeZone


viewMode

viewMode: ViewMode;

Defined in: calendar/date-core.ts:61

Inherited from

DateCoreOptions.viewMode