@super-calendar/dom 2.16.0 → 2.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +44 -0
- package/dist/index.d.mts +49 -7
- package/dist/index.d.ts +49 -7
- package/dist/index.js +424 -87
- package/dist/index.mjs +420 -90
- package/package.json +2 -2
- package/src/Calendar.tsx +78 -13
- package/src/MonthView.tsx +388 -65
- package/src/MultiWeekView.tsx +54 -0
- package/src/index.ts +7 -0
- package/src/touch.ts +70 -0
package/README.md
CHANGED
|
@@ -69,6 +69,50 @@ Set `touchDragDelay` and `touchDragThreshold` on `TimeGrid` or `Calendar` to adj
|
|
|
69
69
|
the hold. Mouse drag and resize retain their existing behavior. See the
|
|
70
70
|
[dragging guide](https://super-calendar.afonsojramos.me/guides/dragging).
|
|
71
71
|
|
|
72
|
+
## Multi-week grids
|
|
73
|
+
|
|
74
|
+
Use `mode="multiweek"` with `numberOfWeeks` (default `2`) for consecutive full
|
|
75
|
+
week rows without hourly slots. The first week contains `date` and aligns to
|
|
76
|
+
`weekStartsOn`. Navigation moves by the full number of weeks. `hiddenDays` only
|
|
77
|
+
shortens rows; `custom` views remain hourly even above seven columns.
|
|
78
|
+
|
|
79
|
+
```tsx
|
|
80
|
+
import { useState } from "react";
|
|
81
|
+
import { Calendar } from "@super-calendar/dom";
|
|
82
|
+
|
|
83
|
+
export function MultiWeekCalendar() {
|
|
84
|
+
const [date, setDate] = useState(new Date(2026, 11, 28));
|
|
85
|
+
return (
|
|
86
|
+
<Calendar
|
|
87
|
+
mode="multiweek"
|
|
88
|
+
numberOfWeeks={3}
|
|
89
|
+
weekStartsOn={1}
|
|
90
|
+
date={date}
|
|
91
|
+
onChangeDate={setDate}
|
|
92
|
+
events={[]}
|
|
93
|
+
height={480}
|
|
94
|
+
/>
|
|
95
|
+
);
|
|
96
|
+
}
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
`MultiWeekView` exposes a standalone window with the month grid's event bars,
|
|
100
|
+
overflow, selection, drag interactions, and styling. Pass expanded events to it;
|
|
101
|
+
`Calendar` handles recurrence and time zones. Custom event renderers receive
|
|
102
|
+
`mode: "multiweek"`. Rows scroll vertically when the container is too short.
|
|
103
|
+
Event chips and overflow buttons default to 24 pixels high; use `chipHeight` to customize them.
|
|
104
|
+
Counts must be positive safe integers whose date span is representable; invalid
|
|
105
|
+
counts or dates throw `RangeError`. Rows are materialized, so larger counts need
|
|
106
|
+
more space. `MonthView` retains its month-only behavior.
|
|
107
|
+
|
|
108
|
+
In the multi-week web grid, a quick touch swipe scrolls. Hold a day or event for
|
|
109
|
+
400 ms, then drag to create or move. Mouse input starts immediately. Cancelling
|
|
110
|
+
the pointer or changing the displayed window cancels the hold or drag.
|
|
111
|
+
|
|
112
|
+
Keep `events` stable during unrelated UI updates. With recurrence or `timeZone`,
|
|
113
|
+
replacing the array rebuilds displayed events and cancels a held move. See
|
|
114
|
+
[keep event data stable](https://super-calendar.afonsojramos.me/guides/events#keep-event-data-stable).
|
|
115
|
+
|
|
72
116
|
## Moving events
|
|
73
117
|
|
|
74
118
|
Pass `onDragEvent` and update your event state with the returned `start` and `end`.
|
package/dist/index.d.mts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Locale } from "date-fns";
|
|
2
2
|
import { CSSProperties, ComponentType, ReactElement, ReactNode, RefAttributes } from "react";
|
|
3
|
-
import { BusinessHours, BusinessHours as BusinessHours$1, BusinessHoursBand, BusinessHoursBand as BusinessHoursBand$1, BusinessHoursValue, CalendarColors, CalendarEvent, CalendarEvent as CalendarEvent$1, CalendarHandle, CalendarHandle as CalendarHandle$1, CalendarLabels, CalendarLabels as CalendarLabels$1, CalendarMode, CalendarMode as CalendarMode$1, CreateGhostArgs, CreateGhostArgs as CreateGhostArgs$1, DateRange, DateRange as DateRange$1, DateSelectionConstraints, DateSelectionConstraints as DateSelectionConstraints$1, DaySelectionState, EventAccessibilityLabelContext, EventAccessibilityLabeler, EventAccessibilityLabeler as EventAccessibilityLabeler$1, ICalEvent, ICalendarEvent, MonthEventSegment, MonthGrid, MonthGridDay, MonthGridWeek, MonthGridWeekday, MonthWeekEvents, PositionedEvent, RecurrenceFrequency, RecurrenceRule, ScrollToTimeOptions, TimeGridMode, TimeGridMode as TimeGridMode$1, ToICalendarOptions, UseDateRangeOptions, UseMonthGridOptions, WeekStartsOn, WeekStartsOn as WeekStartsOn$1, WeekdayFormat, WeekdayFormat as WeekdayFormat$1, backgroundBandsForDay, buildMonthGrid, daySelectionState, defaultCalendarLabels, expandRecurringEvents, getViewDays, isAllDayEvent, isBackgroundEvent, isDateSelectable, isRangeEndpoint, isWithinDateRange, layoutDayEvents, layoutMonthWeek, nextDateRange, parseICalendar, toICalendar, useDateRange, useEventSource, useMonthGrid, useNow, weekdayFormatToken } from "@super-calendar/core";
|
|
3
|
+
import { BusinessHours, BusinessHours as BusinessHours$1, BusinessHoursBand, BusinessHoursBand as BusinessHoursBand$1, BusinessHoursValue, CalendarColors, CalendarEvent, CalendarEvent as CalendarEvent$1, CalendarHandle, CalendarHandle as CalendarHandle$1, CalendarLabels, CalendarLabels as CalendarLabels$1, CalendarMode, CalendarMode as CalendarMode$1, CreateGhostArgs, CreateGhostArgs as CreateGhostArgs$1, DateRange, DateRange as DateRange$1, DateSelectionConstraints, DateSelectionConstraints as DateSelectionConstraints$1, DaySelectionState, EventAccessibilityLabelContext, EventAccessibilityLabeler, EventAccessibilityLabeler as EventAccessibilityLabeler$1, ICalEvent, ICalendarEvent, MonthEventSegment, MonthGrid, MonthGridDay, MonthGridWeek, MonthGridWeekday, MonthWeekEvents, MultiWeekGrid, MultiWeekGridDay, MultiWeekGridInterval, MultiWeekGridOptions, MultiWeekGridWeek, PositionedEvent, RecurrenceFrequency, RecurrenceRule, ScrollToTimeOptions, TimeGridMode, TimeGridMode as TimeGridMode$1, ToICalendarOptions, UseDateRangeOptions, UseMonthGridOptions, WeekStartsOn, WeekStartsOn as WeekStartsOn$1, WeekdayFormat, WeekdayFormat as WeekdayFormat$1, backgroundBandsForDay, buildMonthGrid, buildMultiWeekGrid, daySelectionState, defaultCalendarLabels, expandRecurringEvents, getViewDays, isAllDayEvent, isBackgroundEvent, isDateSelectable, isRangeEndpoint, isWithinDateRange, layoutDayEvents, layoutMonthWeek, nextDateRange, parseICalendar, toICalendar, useDateRange, useEventSource, useMonthGrid, useNow, weekdayFormatToken } from "@super-calendar/core";
|
|
4
4
|
/**
|
|
5
5
|
* Per-slot styling overrides. Give a slot a Tailwind/CSS class and/or an inline
|
|
6
6
|
* style; missing slots keep the built-in look.
|
|
@@ -190,6 +190,8 @@ interface DomMonthEventArgs<T = unknown> {
|
|
|
190
190
|
event: CalendarEvent$1<T>;
|
|
191
191
|
/** Call to fire the view's `onPressEvent` for this chip. */
|
|
192
192
|
onPress: () => void;
|
|
193
|
+
/** The current row view. Supplied by the calendar; optional for existing standalone chip callers. */
|
|
194
|
+
mode?: "month" | "multiweek";
|
|
193
195
|
}
|
|
194
196
|
/** A component that renders a single month-grid event chip. */
|
|
195
197
|
type DomMonthEvent<T = unknown> = ComponentType<DomMonthEventArgs<T>>;
|
|
@@ -317,7 +319,7 @@ interface MonthViewInternalProps<T = unknown> extends MonthViewProps<T> {
|
|
|
317
319
|
* <MonthView date={new Date()} events={events} onPressDay={(d) => setDate(d)} />
|
|
318
320
|
* ```
|
|
319
321
|
*/
|
|
320
|
-
export declare function MonthView<T = unknown>({ date,
|
|
322
|
+
export declare function MonthView<T = unknown>({ date, showAdjacentMonths, ...rest }: MonthViewInternalProps<T>): ReactElement;
|
|
321
323
|
/** Styleable parts of the built-in move and resize actions. */
|
|
322
324
|
type EventActionsSlot = "eventActionsTrigger" | "eventActionsList" | "eventActions" | "eventAction";
|
|
323
325
|
/**
|
|
@@ -528,8 +530,9 @@ type CalendarSlot = MonthViewSlot | TimeGridSlot | AgendaSlot | YearViewSlot;
|
|
|
528
530
|
/** Props for {@link Calendar}. */
|
|
529
531
|
interface CalendarProps<T = unknown> extends DateSelectionConstraints$1, SlotStyleProps<CalendarSlot> {
|
|
530
532
|
/**
|
|
531
|
-
* The view to render (default "week"). `month` renders a month grid,
|
|
532
|
-
* a day-grouped agenda list,
|
|
533
|
+
* The view to render (default "week"). `month` renders a month grid,
|
|
534
|
+
* `multiweek` stacked week rows, `schedule` a day-grouped agenda list, `year`
|
|
535
|
+
* twelve mini months, and the others a time grid.
|
|
533
536
|
*/
|
|
534
537
|
mode?: CalendarMode$1;
|
|
535
538
|
/**
|
|
@@ -542,8 +545,9 @@ interface CalendarProps<T = unknown> extends DateSelectionConstraints$1, SlotSty
|
|
|
542
545
|
date: Date;
|
|
543
546
|
/**
|
|
544
547
|
* Fires with the next/previous period's date when the user pages the focused
|
|
545
|
-
* calendar with **PageDown** / **PageUp** (a month in `month`,
|
|
546
|
-
* `schedule`, else the view's
|
|
548
|
+
* calendar with **PageDown** / **PageUp** (a month in `month`,
|
|
549
|
+
* `numberOfWeeks` weeks in `multiweek`, a week in `schedule`, else the view's
|
|
550
|
+
* day span). It's controlled, so update `date` in
|
|
547
551
|
* response. Omit it to leave paging to your own controls.
|
|
548
552
|
*/
|
|
549
553
|
onChangeDate?: (date: Date) => void;
|
|
@@ -561,6 +565,11 @@ interface CalendarProps<T = unknown> extends DateSelectionConstraints$1, SlotSty
|
|
|
561
565
|
now?: Date;
|
|
562
566
|
/** Column count for `mode="custom"`. */
|
|
563
567
|
numberOfDays?: number;
|
|
568
|
+
/**
|
|
569
|
+
* Week rows for `mode="multiweek"`: a positive whole number, default 2. The
|
|
570
|
+
* rows start on the week containing `date`. Other values throw a `RangeError`.
|
|
571
|
+
*/
|
|
572
|
+
numberOfWeeks?: number;
|
|
564
573
|
/** date-fns locale for titles, headers, and time labels. */
|
|
565
574
|
locale?: Locale;
|
|
566
575
|
/**
|
|
@@ -881,6 +890,39 @@ interface DateRangePickerProps extends PickerBaseProps {
|
|
|
881
890
|
* ```
|
|
882
891
|
*/
|
|
883
892
|
export declare function DateRangePicker({ value, onChange, formatLabel, weekStartsOn, height, placeholder, disabled, theme: themeOverrides, className, style, classNames, styles, minDate, maxDate, isDateDisabled }: DateRangePickerProps): ReactElement;
|
|
893
|
+
/** Props for {@link MultiWeekView}. */
|
|
894
|
+
interface MultiWeekViewProps<T = unknown> extends Omit<MonthViewProps<T>, "date" | "weekStartsOn" | "showAdjacentMonths"> {
|
|
895
|
+
/**
|
|
896
|
+
* Any day in the first week to show. The rows start on the `weekStartsOn` day
|
|
897
|
+
* on or before it, in the device's local calendar.
|
|
898
|
+
*/
|
|
899
|
+
date: Date;
|
|
900
|
+
/**
|
|
901
|
+
* How many consecutive full weeks to show, as stacked rows. A positive whole
|
|
902
|
+
* number; default 2. Other values throw a `RangeError`.
|
|
903
|
+
*/
|
|
904
|
+
numberOfWeeks?: number;
|
|
905
|
+
/** First day of the week. Sunday = 0 (default) … Saturday = 6. */
|
|
906
|
+
weekStartsOn?: WeekStartsOn$1;
|
|
907
|
+
/** Event chip and overflow-button height in pixels (default 24). */
|
|
908
|
+
chipHeight?: number;
|
|
909
|
+
}
|
|
910
|
+
/**
|
|
911
|
+
* Consecutive full weeks as stacked seven-day rows, with event chips and no hour
|
|
912
|
+
* slots. It has the month grid's event bars, overflow, selection, and drag
|
|
913
|
+
* interactions, and the month slots, `renderEvent`, and theme style it. Every
|
|
914
|
+
* row is kept at full height; when the view is given less room, the rows scroll
|
|
915
|
+
* under the title and weekday header.
|
|
916
|
+
*
|
|
917
|
+
* Standalone, it shows `events` as given; expand recurring events first with
|
|
918
|
+
* `expandRecurringEvents`, or use `Calendar` with `mode="multiweek"`.
|
|
919
|
+
*
|
|
920
|
+
* @example
|
|
921
|
+
* ```tsx
|
|
922
|
+
* <MultiWeekView date={new Date()} numberOfWeeks={3} events={events} />
|
|
923
|
+
* ```
|
|
924
|
+
*/
|
|
925
|
+
export declare function MultiWeekView<T = unknown>({ date, numberOfWeeks, chipHeight, ...rest }: MultiWeekViewProps<T>): ReactElement;
|
|
884
926
|
/**
|
|
885
927
|
* Styleable parts of {@link ResourceTimeline}. Pass a class or inline style per
|
|
886
928
|
* slot via the `classNames` / `styles` props.
|
|
@@ -1037,4 +1079,4 @@ interface ResourceTimelineProps<T = unknown> extends SlotStyleProps<ResourceTime
|
|
|
1037
1079
|
* ```
|
|
1038
1080
|
*/
|
|
1039
1081
|
export declare function ResourceTimeline<T = unknown>({ date, orientation, resources: allResources, resourcesPerPage, resourcePage, events, resourceId, startHour, endHour, hourWidth, hourHeight, rowHeight, labelWidth, ampm, theme: themeOverrides, renderEvent, onPressEvent, onDragEvent, getEventId, onPressCell, onCreateEvent, renderCreateGhost, businessHours, renderBusinessHours, renderResourceHeader, dragStepMinutes, labels: labelsProp, showNowIndicator, now: nowProp, timeZone, className, style, classNames, styles }: ResourceTimelineProps<T>): ReactElement;
|
|
1040
|
-
export { type AgendaProps, type AgendaSlot, type BusinessHours, type BusinessHoursBand, type CalendarEvent, type CalendarHandle, type CalendarLabels, type CalendarMode, type CalendarProps, type CalendarSlot, type CreateGhostArgs, type DatePickerProps, type DatePickerSlot, type DateRange, type DateRangePickerProps, type DateSelectionConstraints, type DaySelectionState, type DomAgendaEvent, type DomAgendaEventArgs, type DomCalendarTheme, type DomMonthEvent, type DomMonthEventArgs, type DomRenderEvent, type DomRenderEventArgs, type EventAccessibilityLabelContext, type EventAccessibilityLabeler, type ICalEvent, type ICalendarEvent, type MonthEventSegment, type MonthGrid, type MonthGridDay, type MonthGridWeek, type MonthGridWeekday, type MonthListProps, type MonthListSlot, type MonthViewProps, type MonthViewSlot, type MonthWeekEvents, type PositionedEvent, type RecurrenceFrequency, type RecurrenceRule, type ResolvedSlot, type Resource, type ResourceEventArgs, type ResourceTimelineProps, type ResourceTimelineSlot, type ScrollToTimeOptions, type SlotDefault, type SlotStyleProps, type TimeGridMode, type TimeGridProps, type TimeGridSlot, type ToICalendarOptions, type UseDateRangeOptions, type UseMonthGridOptions, type WeekStartsOn, type WeekdayFormat, type YearViewProps, type YearViewSlot, backgroundBandsForDay, buildMonthGrid, daySelectionState, defaultCalendarLabels, expandRecurringEvents, getViewDays, isAllDayEvent, isBackgroundEvent, isDateSelectable, isRangeEndpoint, isWithinDateRange, layoutDayEvents, layoutMonthWeek, nextDateRange, parseICalendar, toICalendar, useDateRange, useEventSource, useMonthGrid, useNow, weekdayFormatToken };
|
|
1082
|
+
export { type AgendaProps, type AgendaSlot, type BusinessHours, type BusinessHoursBand, type CalendarEvent, type CalendarHandle, type CalendarLabels, type CalendarMode, type CalendarProps, type CalendarSlot, type CreateGhostArgs, type DatePickerProps, type DatePickerSlot, type DateRange, type DateRangePickerProps, type DateSelectionConstraints, type DaySelectionState, type DomAgendaEvent, type DomAgendaEventArgs, type DomCalendarTheme, type DomMonthEvent, type DomMonthEventArgs, type DomRenderEvent, type DomRenderEventArgs, type EventAccessibilityLabelContext, type EventAccessibilityLabeler, type ICalEvent, type ICalendarEvent, type MonthEventSegment, type MonthGrid, type MonthGridDay, type MonthGridWeek, type MonthGridWeekday, type MonthListProps, type MonthListSlot, type MonthViewProps, type MonthViewSlot, type MonthWeekEvents, type MultiWeekGrid, type MultiWeekGridDay, type MultiWeekGridInterval, type MultiWeekGridOptions, type MultiWeekGridWeek, type MultiWeekViewProps, type PositionedEvent, type RecurrenceFrequency, type RecurrenceRule, type ResolvedSlot, type Resource, type ResourceEventArgs, type ResourceTimelineProps, type ResourceTimelineSlot, type ScrollToTimeOptions, type SlotDefault, type SlotStyleProps, type TimeGridMode, type TimeGridProps, type TimeGridSlot, type ToICalendarOptions, type UseDateRangeOptions, type UseMonthGridOptions, type WeekStartsOn, type WeekdayFormat, type YearViewProps, type YearViewSlot, backgroundBandsForDay, buildMonthGrid, buildMultiWeekGrid, daySelectionState, defaultCalendarLabels, expandRecurringEvents, getViewDays, isAllDayEvent, isBackgroundEvent, isDateSelectable, isRangeEndpoint, isWithinDateRange, layoutDayEvents, layoutMonthWeek, nextDateRange, parseICalendar, toICalendar, useDateRange, useEventSource, useMonthGrid, useNow, weekdayFormatToken };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Locale } from "date-fns";
|
|
2
2
|
import { CSSProperties, ComponentType, ReactElement, ReactNode, RefAttributes } from "react";
|
|
3
|
-
import { BusinessHours, BusinessHours as BusinessHours$1, BusinessHoursBand, BusinessHoursBand as BusinessHoursBand$1, BusinessHoursValue, CalendarColors, CalendarEvent, CalendarEvent as CalendarEvent$1, CalendarHandle, CalendarHandle as CalendarHandle$1, CalendarLabels, CalendarLabels as CalendarLabels$1, CalendarMode, CalendarMode as CalendarMode$1, CreateGhostArgs, CreateGhostArgs as CreateGhostArgs$1, DateRange, DateRange as DateRange$1, DateSelectionConstraints, DateSelectionConstraints as DateSelectionConstraints$1, DaySelectionState, EventAccessibilityLabelContext, EventAccessibilityLabeler, EventAccessibilityLabeler as EventAccessibilityLabeler$1, ICalEvent, ICalendarEvent, MonthEventSegment, MonthGrid, MonthGridDay, MonthGridWeek, MonthGridWeekday, MonthWeekEvents, PositionedEvent, RecurrenceFrequency, RecurrenceRule, ScrollToTimeOptions, TimeGridMode, TimeGridMode as TimeGridMode$1, ToICalendarOptions, UseDateRangeOptions, UseMonthGridOptions, WeekStartsOn, WeekStartsOn as WeekStartsOn$1, WeekdayFormat, WeekdayFormat as WeekdayFormat$1, backgroundBandsForDay, buildMonthGrid, daySelectionState, defaultCalendarLabels, expandRecurringEvents, getViewDays, isAllDayEvent, isBackgroundEvent, isDateSelectable, isRangeEndpoint, isWithinDateRange, layoutDayEvents, layoutMonthWeek, nextDateRange, parseICalendar, toICalendar, useDateRange, useEventSource, useMonthGrid, useNow, weekdayFormatToken } from "@super-calendar/core";
|
|
3
|
+
import { BusinessHours, BusinessHours as BusinessHours$1, BusinessHoursBand, BusinessHoursBand as BusinessHoursBand$1, BusinessHoursValue, CalendarColors, CalendarEvent, CalendarEvent as CalendarEvent$1, CalendarHandle, CalendarHandle as CalendarHandle$1, CalendarLabels, CalendarLabels as CalendarLabels$1, CalendarMode, CalendarMode as CalendarMode$1, CreateGhostArgs, CreateGhostArgs as CreateGhostArgs$1, DateRange, DateRange as DateRange$1, DateSelectionConstraints, DateSelectionConstraints as DateSelectionConstraints$1, DaySelectionState, EventAccessibilityLabelContext, EventAccessibilityLabeler, EventAccessibilityLabeler as EventAccessibilityLabeler$1, ICalEvent, ICalendarEvent, MonthEventSegment, MonthGrid, MonthGridDay, MonthGridWeek, MonthGridWeekday, MonthWeekEvents, MultiWeekGrid, MultiWeekGridDay, MultiWeekGridInterval, MultiWeekGridOptions, MultiWeekGridWeek, PositionedEvent, RecurrenceFrequency, RecurrenceRule, ScrollToTimeOptions, TimeGridMode, TimeGridMode as TimeGridMode$1, ToICalendarOptions, UseDateRangeOptions, UseMonthGridOptions, WeekStartsOn, WeekStartsOn as WeekStartsOn$1, WeekdayFormat, WeekdayFormat as WeekdayFormat$1, backgroundBandsForDay, buildMonthGrid, buildMultiWeekGrid, daySelectionState, defaultCalendarLabels, expandRecurringEvents, getViewDays, isAllDayEvent, isBackgroundEvent, isDateSelectable, isRangeEndpoint, isWithinDateRange, layoutDayEvents, layoutMonthWeek, nextDateRange, parseICalendar, toICalendar, useDateRange, useEventSource, useMonthGrid, useNow, weekdayFormatToken } from "@super-calendar/core";
|
|
4
4
|
/**
|
|
5
5
|
* Per-slot styling overrides. Give a slot a Tailwind/CSS class and/or an inline
|
|
6
6
|
* style; missing slots keep the built-in look.
|
|
@@ -190,6 +190,8 @@ interface DomMonthEventArgs<T = unknown> {
|
|
|
190
190
|
event: CalendarEvent$1<T>;
|
|
191
191
|
/** Call to fire the view's `onPressEvent` for this chip. */
|
|
192
192
|
onPress: () => void;
|
|
193
|
+
/** The current row view. Supplied by the calendar; optional for existing standalone chip callers. */
|
|
194
|
+
mode?: "month" | "multiweek";
|
|
193
195
|
}
|
|
194
196
|
/** A component that renders a single month-grid event chip. */
|
|
195
197
|
type DomMonthEvent<T = unknown> = ComponentType<DomMonthEventArgs<T>>;
|
|
@@ -317,7 +319,7 @@ interface MonthViewInternalProps<T = unknown> extends MonthViewProps<T> {
|
|
|
317
319
|
* <MonthView date={new Date()} events={events} onPressDay={(d) => setDate(d)} />
|
|
318
320
|
* ```
|
|
319
321
|
*/
|
|
320
|
-
export declare function MonthView<T = unknown>({ date,
|
|
322
|
+
export declare function MonthView<T = unknown>({ date, showAdjacentMonths, ...rest }: MonthViewInternalProps<T>): ReactElement;
|
|
321
323
|
/** Styleable parts of the built-in move and resize actions. */
|
|
322
324
|
type EventActionsSlot = "eventActionsTrigger" | "eventActionsList" | "eventActions" | "eventAction";
|
|
323
325
|
/**
|
|
@@ -528,8 +530,9 @@ type CalendarSlot = MonthViewSlot | TimeGridSlot | AgendaSlot | YearViewSlot;
|
|
|
528
530
|
/** Props for {@link Calendar}. */
|
|
529
531
|
interface CalendarProps<T = unknown> extends DateSelectionConstraints$1, SlotStyleProps<CalendarSlot> {
|
|
530
532
|
/**
|
|
531
|
-
* The view to render (default "week"). `month` renders a month grid,
|
|
532
|
-
* a day-grouped agenda list,
|
|
533
|
+
* The view to render (default "week"). `month` renders a month grid,
|
|
534
|
+
* `multiweek` stacked week rows, `schedule` a day-grouped agenda list, `year`
|
|
535
|
+
* twelve mini months, and the others a time grid.
|
|
533
536
|
*/
|
|
534
537
|
mode?: CalendarMode$1;
|
|
535
538
|
/**
|
|
@@ -542,8 +545,9 @@ interface CalendarProps<T = unknown> extends DateSelectionConstraints$1, SlotSty
|
|
|
542
545
|
date: Date;
|
|
543
546
|
/**
|
|
544
547
|
* Fires with the next/previous period's date when the user pages the focused
|
|
545
|
-
* calendar with **PageDown** / **PageUp** (a month in `month`,
|
|
546
|
-
* `schedule`, else the view's
|
|
548
|
+
* calendar with **PageDown** / **PageUp** (a month in `month`,
|
|
549
|
+
* `numberOfWeeks` weeks in `multiweek`, a week in `schedule`, else the view's
|
|
550
|
+
* day span). It's controlled, so update `date` in
|
|
547
551
|
* response. Omit it to leave paging to your own controls.
|
|
548
552
|
*/
|
|
549
553
|
onChangeDate?: (date: Date) => void;
|
|
@@ -561,6 +565,11 @@ interface CalendarProps<T = unknown> extends DateSelectionConstraints$1, SlotSty
|
|
|
561
565
|
now?: Date;
|
|
562
566
|
/** Column count for `mode="custom"`. */
|
|
563
567
|
numberOfDays?: number;
|
|
568
|
+
/**
|
|
569
|
+
* Week rows for `mode="multiweek"`: a positive whole number, default 2. The
|
|
570
|
+
* rows start on the week containing `date`. Other values throw a `RangeError`.
|
|
571
|
+
*/
|
|
572
|
+
numberOfWeeks?: number;
|
|
564
573
|
/** date-fns locale for titles, headers, and time labels. */
|
|
565
574
|
locale?: Locale;
|
|
566
575
|
/**
|
|
@@ -881,6 +890,39 @@ interface DateRangePickerProps extends PickerBaseProps {
|
|
|
881
890
|
* ```
|
|
882
891
|
*/
|
|
883
892
|
export declare function DateRangePicker({ value, onChange, formatLabel, weekStartsOn, height, placeholder, disabled, theme: themeOverrides, className, style, classNames, styles, minDate, maxDate, isDateDisabled }: DateRangePickerProps): ReactElement;
|
|
893
|
+
/** Props for {@link MultiWeekView}. */
|
|
894
|
+
interface MultiWeekViewProps<T = unknown> extends Omit<MonthViewProps<T>, "date" | "weekStartsOn" | "showAdjacentMonths"> {
|
|
895
|
+
/**
|
|
896
|
+
* Any day in the first week to show. The rows start on the `weekStartsOn` day
|
|
897
|
+
* on or before it, in the device's local calendar.
|
|
898
|
+
*/
|
|
899
|
+
date: Date;
|
|
900
|
+
/**
|
|
901
|
+
* How many consecutive full weeks to show, as stacked rows. A positive whole
|
|
902
|
+
* number; default 2. Other values throw a `RangeError`.
|
|
903
|
+
*/
|
|
904
|
+
numberOfWeeks?: number;
|
|
905
|
+
/** First day of the week. Sunday = 0 (default) … Saturday = 6. */
|
|
906
|
+
weekStartsOn?: WeekStartsOn$1;
|
|
907
|
+
/** Event chip and overflow-button height in pixels (default 24). */
|
|
908
|
+
chipHeight?: number;
|
|
909
|
+
}
|
|
910
|
+
/**
|
|
911
|
+
* Consecutive full weeks as stacked seven-day rows, with event chips and no hour
|
|
912
|
+
* slots. It has the month grid's event bars, overflow, selection, and drag
|
|
913
|
+
* interactions, and the month slots, `renderEvent`, and theme style it. Every
|
|
914
|
+
* row is kept at full height; when the view is given less room, the rows scroll
|
|
915
|
+
* under the title and weekday header.
|
|
916
|
+
*
|
|
917
|
+
* Standalone, it shows `events` as given; expand recurring events first with
|
|
918
|
+
* `expandRecurringEvents`, or use `Calendar` with `mode="multiweek"`.
|
|
919
|
+
*
|
|
920
|
+
* @example
|
|
921
|
+
* ```tsx
|
|
922
|
+
* <MultiWeekView date={new Date()} numberOfWeeks={3} events={events} />
|
|
923
|
+
* ```
|
|
924
|
+
*/
|
|
925
|
+
export declare function MultiWeekView<T = unknown>({ date, numberOfWeeks, chipHeight, ...rest }: MultiWeekViewProps<T>): ReactElement;
|
|
884
926
|
/**
|
|
885
927
|
* Styleable parts of {@link ResourceTimeline}. Pass a class or inline style per
|
|
886
928
|
* slot via the `classNames` / `styles` props.
|
|
@@ -1037,4 +1079,4 @@ interface ResourceTimelineProps<T = unknown> extends SlotStyleProps<ResourceTime
|
|
|
1037
1079
|
* ```
|
|
1038
1080
|
*/
|
|
1039
1081
|
export declare function ResourceTimeline<T = unknown>({ date, orientation, resources: allResources, resourcesPerPage, resourcePage, events, resourceId, startHour, endHour, hourWidth, hourHeight, rowHeight, labelWidth, ampm, theme: themeOverrides, renderEvent, onPressEvent, onDragEvent, getEventId, onPressCell, onCreateEvent, renderCreateGhost, businessHours, renderBusinessHours, renderResourceHeader, dragStepMinutes, labels: labelsProp, showNowIndicator, now: nowProp, timeZone, className, style, classNames, styles }: ResourceTimelineProps<T>): ReactElement;
|
|
1040
|
-
export { type AgendaProps, type AgendaSlot, type BusinessHours, type BusinessHoursBand, type CalendarEvent, type CalendarHandle, type CalendarLabels, type CalendarMode, type CalendarProps, type CalendarSlot, type CreateGhostArgs, type DatePickerProps, type DatePickerSlot, type DateRange, type DateRangePickerProps, type DateSelectionConstraints, type DaySelectionState, type DomAgendaEvent, type DomAgendaEventArgs, type DomCalendarTheme, type DomMonthEvent, type DomMonthEventArgs, type DomRenderEvent, type DomRenderEventArgs, type EventAccessibilityLabelContext, type EventAccessibilityLabeler, type ICalEvent, type ICalendarEvent, type MonthEventSegment, type MonthGrid, type MonthGridDay, type MonthGridWeek, type MonthGridWeekday, type MonthListProps, type MonthListSlot, type MonthViewProps, type MonthViewSlot, type MonthWeekEvents, type PositionedEvent, type RecurrenceFrequency, type RecurrenceRule, type ResolvedSlot, type Resource, type ResourceEventArgs, type ResourceTimelineProps, type ResourceTimelineSlot, type ScrollToTimeOptions, type SlotDefault, type SlotStyleProps, type TimeGridMode, type TimeGridProps, type TimeGridSlot, type ToICalendarOptions, type UseDateRangeOptions, type UseMonthGridOptions, type WeekStartsOn, type WeekdayFormat, type YearViewProps, type YearViewSlot, backgroundBandsForDay, buildMonthGrid, daySelectionState, defaultCalendarLabels, expandRecurringEvents, getViewDays, isAllDayEvent, isBackgroundEvent, isDateSelectable, isRangeEndpoint, isWithinDateRange, layoutDayEvents, layoutMonthWeek, nextDateRange, parseICalendar, toICalendar, useDateRange, useEventSource, useMonthGrid, useNow, weekdayFormatToken };
|
|
1082
|
+
export { type AgendaProps, type AgendaSlot, type BusinessHours, type BusinessHoursBand, type CalendarEvent, type CalendarHandle, type CalendarLabels, type CalendarMode, type CalendarProps, type CalendarSlot, type CreateGhostArgs, type DatePickerProps, type DatePickerSlot, type DateRange, type DateRangePickerProps, type DateSelectionConstraints, type DaySelectionState, type DomAgendaEvent, type DomAgendaEventArgs, type DomCalendarTheme, type DomMonthEvent, type DomMonthEventArgs, type DomRenderEvent, type DomRenderEventArgs, type EventAccessibilityLabelContext, type EventAccessibilityLabeler, type ICalEvent, type ICalendarEvent, type MonthEventSegment, type MonthGrid, type MonthGridDay, type MonthGridWeek, type MonthGridWeekday, type MonthListProps, type MonthListSlot, type MonthViewProps, type MonthViewSlot, type MonthWeekEvents, type MultiWeekGrid, type MultiWeekGridDay, type MultiWeekGridInterval, type MultiWeekGridOptions, type MultiWeekGridWeek, type MultiWeekViewProps, type PositionedEvent, type RecurrenceFrequency, type RecurrenceRule, type ResolvedSlot, type Resource, type ResourceEventArgs, type ResourceTimelineProps, type ResourceTimelineSlot, type ScrollToTimeOptions, type SlotDefault, type SlotStyleProps, type TimeGridMode, type TimeGridProps, type TimeGridSlot, type ToICalendarOptions, type UseDateRangeOptions, type UseMonthGridOptions, type WeekStartsOn, type WeekdayFormat, type YearViewProps, type YearViewSlot, backgroundBandsForDay, buildMonthGrid, buildMultiWeekGrid, daySelectionState, defaultCalendarLabels, expandRecurringEvents, getViewDays, isAllDayEvent, isBackgroundEvent, isDateSelectable, isRangeEndpoint, isWithinDateRange, layoutDayEvents, layoutMonthWeek, nextDateRange, parseICalendar, toICalendar, useDateRange, useEventSource, useMonthGrid, useNow, weekdayFormatToken };
|