@super-calendar/native 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.
@@ -38,6 +38,7 @@ import type {
38
38
  WeekStartsOn,
39
39
  } from "../types";
40
40
  import {
41
+ buildMultiWeekGrid,
41
42
  type DateRange,
42
43
  type EventAccessibilityLabeler,
43
44
  eventsInTimeZone,
@@ -55,7 +56,7 @@ import { type SlotStyleProps } from "../utils/slots";
55
56
  import { YearView, type YearViewSlot } from "./YearView";
56
57
  import { Agenda, type AgendaSlot } from "./Agenda";
57
58
  import { DefaultEvent } from "./DefaultEvent";
58
- import { MonthPager } from "./MonthPager";
59
+ import { DateRowsPager } from "./MonthPager";
59
60
  import type { MonthViewSlot } from "./MonthView";
60
61
  import {
61
62
  DEFAULT_HOUR_HEIGHT,
@@ -204,6 +205,8 @@ export type CalendarProps<T> = SlotStyleProps<CalendarSlot> & {
204
205
  weekdayFormat?: WeekdayFormat;
205
206
  /** Number of day columns when `mode="custom"`. Ignored by other modes. Default 1. */
206
207
  numberOfDays?: number;
208
+ /** Consecutive full week rows for `mode="multiweek"` (default 2). */
209
+ numberOfWeeks?: number;
207
210
  /**
208
211
  * Last weekday of a `custom` partial-week view (0–6). When set, `custom` shows
209
212
  * `weekStartsOn`…`weekEndsOn` of the visible week and pages by week, taking
@@ -389,7 +392,13 @@ function visibleRange(
389
392
  weekStartsOn: WeekStartsOn,
390
393
  numberOfDays: number,
391
394
  weekEndsOn?: WeekStartsOn,
395
+ numberOfWeeks = 2,
396
+ hiddenDays?: number[],
392
397
  ): [Date, Date] {
398
+ if (mode === "multiweek") {
399
+ const { visibleRange } = buildMultiWeekGrid(date, { numberOfWeeks, weekStartsOn, hiddenDays });
400
+ return [visibleRange.start, endOfDay(addDays(visibleRange.endExclusive, -1))];
401
+ }
393
402
  if (mode === "month") {
394
403
  return [
395
404
  startOfWeek(startOfMonth(date), { weekStartsOn }),
@@ -415,7 +424,17 @@ function expansionRange(
415
424
  weekStartsOn: WeekStartsOn,
416
425
  numberOfDays: number,
417
426
  weekEndsOn?: WeekStartsOn,
427
+ numberOfWeeks = 2,
418
428
  ): [Date, Date] {
429
+ if (mode === "multiweek") {
430
+ const { period } = buildMultiWeekGrid(date, { numberOfWeeks, weekStartsOn });
431
+ const previous = addWeeks(period.start, -numberOfWeeks);
432
+ const following = addWeeks(period.endExclusive, numberOfWeeks);
433
+ return [
434
+ Number.isFinite(previous.getTime()) ? previous : period.start,
435
+ endOfDay(addDays(Number.isFinite(following.getTime()) ? following : period.endExclusive, -1)),
436
+ ];
437
+ }
419
438
  if (mode === "month") {
420
439
  return [
421
440
  startOfWeek(startOfMonth(addMonths(date, -1)), { weekStartsOn }),
@@ -513,6 +532,7 @@ function CalendarInner<T>(
513
532
  now,
514
533
  weekdayFormat,
515
534
  numberOfDays,
535
+ numberOfWeeks = 2,
516
536
  weekEndsOn,
517
537
  renderEvent = DefaultEvent,
518
538
  eventAccessibilityLabel,
@@ -589,7 +609,14 @@ function CalendarInner<T>(
589
609
  const displayEvents = useMemo(() => {
590
610
  let out = events;
591
611
  if (out.some((e) => e.recurrence)) {
592
- let [start, end] = expansionRange(mode, date, weekStartsOn, numberOfDays ?? 1, weekEndsOn);
612
+ let [start, end] = expansionRange(
613
+ mode,
614
+ date,
615
+ weekStartsOn,
616
+ numberOfDays ?? 1,
617
+ weekEndsOn,
618
+ numberOfWeeks,
619
+ );
593
620
  // A display zone shifts each occurrence's wall-clock by up to ~a day, which
594
621
  // can move an edge occurrence into a visible column; widen so it's generated.
595
622
  if (timeZone) {
@@ -601,7 +628,16 @@ function CalendarInner<T>(
601
628
  if (timeZone) out = eventsInTimeZone(out, timeZone);
602
629
  return out;
603
630
  // `date.getTime()`: recompute on the instant, not a re-created Date identity.
604
- }, [events, mode, date.getTime(), weekStartsOn, numberOfDays, weekEndsOn, timeZone]);
631
+ }, [
632
+ events,
633
+ mode,
634
+ date.getTime(),
635
+ weekStartsOn,
636
+ numberOfDays,
637
+ weekEndsOn,
638
+ timeZone,
639
+ numberOfWeeks,
640
+ ]);
605
641
 
606
642
  // Swallow presses on disabled events once, so every view inherits the guard.
607
643
  const handlePressEvent = useCallback(
@@ -624,9 +660,28 @@ function CalendarInner<T>(
624
660
  const handleChangeDate = useCallback(
625
661
  (next: Date) => {
626
662
  onChangeDate(next);
627
- onChangeDateRange?.(visibleRange(mode, next, weekStartsOn, numberOfDays ?? 1, weekEndsOn));
663
+ onChangeDateRange?.(
664
+ visibleRange(
665
+ mode,
666
+ next,
667
+ weekStartsOn,
668
+ numberOfDays ?? 1,
669
+ weekEndsOn,
670
+ numberOfWeeks,
671
+ hiddenDays,
672
+ ),
673
+ );
628
674
  },
629
- [onChangeDate, onChangeDateRange, mode, weekStartsOn, numberOfDays, weekEndsOn],
675
+ [
676
+ onChangeDate,
677
+ onChangeDateRange,
678
+ mode,
679
+ weekStartsOn,
680
+ numberOfDays,
681
+ weekEndsOn,
682
+ numberOfWeeks,
683
+ hiddenDays,
684
+ ],
630
685
  );
631
686
 
632
687
  // Inject `eventCellStyle`, `ampm`, `showTime`, `ellipsizeTitle` and
@@ -677,13 +732,25 @@ function CalendarInner<T>(
677
732
  eventAccessibilityLabel,
678
733
  ]);
679
734
 
735
+ const rowSpec = useMemo(
736
+ () =>
737
+ mode === "multiweek"
738
+ ? { kind: "multiweek" as const, numberOfWeeks }
739
+ : {
740
+ kind: "month" as const,
741
+ showAdjacentMonths: showAdjacentMonths ?? true,
742
+ showSixWeeks: showSixWeeks ?? false,
743
+ },
744
+ [mode, numberOfWeeks, showAdjacentMonths, showSixWeeks],
745
+ );
680
746
  const resolvedLabels = useMemo(() => resolveCalendarLabels(labels), [labels]);
681
747
 
682
748
  return (
683
749
  <CalendarThemeProvider value={mergedTheme}>
684
750
  <CalendarLabelsContext.Provider value={resolvedLabels}>
685
- {mode === "month" ? (
686
- <MonthPager
751
+ {mode === "month" || mode === "multiweek" ? (
752
+ <DateRowsPager
753
+ spec={rowSpec}
687
754
  date={date}
688
755
  events={displayEvents}
689
756
  maxVisibleEventCount={maxVisibleEventCount}
@@ -696,11 +763,9 @@ function CalendarInner<T>(
696
763
  labels={labels}
697
764
  sortedMonthView={sortedMonthView}
698
765
  moreLabel={moreLabel}
699
- showAdjacentMonths={showAdjacentMonths}
700
766
  highlightWeekends={highlightWeekends}
701
767
  disableMonthEventCellPress={disableMonthEventCellPress}
702
768
  isRTL={isRTL}
703
- showSixWeeks={showSixWeeks}
704
769
  showTitle={showTitle}
705
770
  activeDate={activeDate}
706
771
  renderHeaderForMonthView={renderHeaderForMonthView}
@@ -4,7 +4,17 @@ import {
4
4
  type LegendListRenderItemProps,
5
5
  type OnViewableItemsChangedInfo,
6
6
  } from "@legendapp/list/react-native";
7
- import { addMonths, differenceInCalendarMonths, format, type Locale, startOfMonth } from "date-fns";
7
+ import {
8
+ addDays,
9
+ addMonths,
10
+ addWeeks,
11
+ differenceInCalendarMonths,
12
+ differenceInCalendarWeeks,
13
+ format,
14
+ type Locale,
15
+ startOfMonth,
16
+ startOfWeek,
17
+ } from "date-fns";
8
18
  import {
9
19
  type ComponentRef,
10
20
  memo,
@@ -37,6 +47,7 @@ import type {
37
47
  import {
38
48
  type CalendarSelection,
39
49
  CalendarSelectionProvider,
50
+ buildMultiWeekGrid,
40
51
  type DateRange,
41
52
  type WeekdayFormat,
42
53
  filterHiddenDays,
@@ -46,7 +57,7 @@ import {
46
57
  import type { CalendarLabels } from "@super-calendar/core";
47
58
  import { createSlots, type SlotStyleProps } from "../utils/slots";
48
59
  import { useWebPagerKeys } from "../utils/useWebPagerKeys";
49
- import { MonthView, type MonthViewSlot } from "./MonthView";
60
+ import { DateRows, type DateRowsSource, type MonthViewSlot } from "./MonthView";
50
61
 
51
62
  // Horizontal swipe paging doesn't translate to web; there we disable it and page
52
63
  // with the arrow keys instead.
@@ -130,7 +141,41 @@ export type MonthPagerProps<T> = {
130
141
  renderCustomDateForMonth?: (date: Date) => React.ReactNode;
131
142
  } & SlotStyleProps<MonthViewSlot>;
132
143
 
144
+ /**
145
+ * Which pages a {@link DateRowsPager} swipes through. Internal to the package:
146
+ * the public pagers and `Calendar` adapt their own props to it.
147
+ */
148
+ export type DateRowsPagerSpec =
149
+ | {
150
+ kind: "month";
151
+ showAdjacentMonths: boolean;
152
+ showSixWeeks: boolean;
153
+ }
154
+ | { kind: "multiweek"; numberOfWeeks: number };
155
+
156
+ /** Props for the private {@link DateRowsPager}. */
157
+ export type DateRowsPagerProps<T> = Omit<
158
+ MonthPagerProps<T>,
159
+ "showAdjacentMonths" | "showSixWeeks"
160
+ > & {
161
+ spec: DateRowsPagerSpec;
162
+ };
163
+
133
164
  function MonthPagerInner<T>({
165
+ showAdjacentMonths = true,
166
+ showSixWeeks = false,
167
+ ...rest
168
+ }: MonthPagerProps<T>): ReactElement {
169
+ const spec = useMemo<DateRowsPagerSpec>(
170
+ () => ({ kind: "month", showAdjacentMonths, showSixWeeks }),
171
+ [showAdjacentMonths, showSixWeeks],
172
+ );
173
+ return <DateRowsPager<T> {...rest} spec={spec} />;
174
+ }
175
+
176
+ function DateRowsPagerInner<T>({
177
+ spec,
178
+ initialAnchor,
134
179
  date,
135
180
  events,
136
181
  maxVisibleEventCount,
@@ -143,7 +188,6 @@ function MonthPagerInner<T>({
143
188
  sortedMonthView,
144
189
  moreLabel,
145
190
  labels,
146
- showAdjacentMonths,
147
191
  highlightWeekends,
148
192
  disableMonthEventCellPress,
149
193
  isRTL,
@@ -171,14 +215,13 @@ function MonthPagerInner<T>({
171
215
  onChangeDate,
172
216
  freeSwipe = false,
173
217
  swipeEnabled = true,
174
- showSixWeeks = false,
175
218
  showTitle = true,
176
219
  activeDate,
177
220
  renderHeaderForMonthView,
178
221
  renderCustomDateForMonth,
179
222
  classNames,
180
223
  styles: styleOverrides,
181
- }: MonthPagerProps<T>): ReactElement {
224
+ }: DateRowsPagerProps<T> & { initialAnchor?: Date }): ReactElement {
182
225
  const theme = useCalendarTheme();
183
226
  // Stable across renders (it feeds the memoized renderItem below).
184
227
  const slot = useMemo(
@@ -221,15 +264,37 @@ function MonthPagerInner<T>({
221
264
  // A fixed window of months, anchored once and aligned to the month start. The
222
265
  // array never shifts as the date changes, so paging never re-renders a page's
223
266
  // content — LegendList virtualises and keys by month.
224
- const [anchorDate] = useState(date);
225
- const anchor = useMemo(() => startOfMonth(anchorDate), [anchorDate]);
226
- const monthDates = useMemo(
227
- () => Array.from({ length: PAGE_WINDOW * 2 + 1 }, (_, i) => addMonths(anchor, i - PAGE_WINDOW)),
228
- [anchor],
267
+ const [anchorDate] = useState(initialAnchor ?? date);
268
+ const numberOfWeeks = spec.kind === "multiweek" ? spec.numberOfWeeks : undefined;
269
+ const anchor = useMemo(
270
+ () =>
271
+ numberOfWeeks === undefined
272
+ ? startOfMonth(anchorDate)
273
+ : startOfWeek(anchorDate, { weekStartsOn }),
274
+ [anchorDate, numberOfWeeks, weekStartsOn],
229
275
  );
276
+ const monthDates = useMemo(() => {
277
+ const dates = Array.from({ length: PAGE_WINDOW * 2 + 1 }, (_, i) =>
278
+ numberOfWeeks === undefined
279
+ ? addMonths(anchor, i - PAGE_WINDOW)
280
+ : addWeeks(anchor, (i - PAGE_WINDOW) * numberOfWeeks),
281
+ );
282
+ // The requested window is valid, but preloaded neighbours can run past
283
+ // Date's endpoints. Keep only complete representable multi-week pages.
284
+ return numberOfWeeks === undefined
285
+ ? dates
286
+ : dates.filter(
287
+ (page) =>
288
+ Number.isFinite(page.getTime()) &&
289
+ Number.isFinite(addWeeks(page, numberOfWeeks).getTime()),
290
+ );
291
+ }, [anchor, numberOfWeeks]);
230
292
  const indexOfMonth = useCallback(
231
- (target: Date) => differenceInCalendarMonths(startOfMonth(target), anchor) + PAGE_WINDOW,
232
- [anchor],
293
+ (target: Date) =>
294
+ numberOfWeeks === undefined
295
+ ? differenceInCalendarMonths(startOfMonth(target), anchor) + PAGE_WINDOW
296
+ : differenceInCalendarWeeks(target, monthDates[0], { weekStartsOn }) / numberOfWeeks,
297
+ [anchor, monthDates, numberOfWeeks, weekStartsOn],
233
298
  );
234
299
 
235
300
  // The committed month's page is the centred/active one. Derived (not stored)
@@ -305,7 +370,7 @@ function MonthPagerInner<T>({
305
370
  // `fillCellOnSelection` and `onSelectDrag` ride along because they reach the
306
371
  // grids as renderItem props, not through the selection context below: toggling
307
372
  // a "pick dates" mode on must reach the pages already rendered.
308
- const listExtraData = useMemo(
373
+ const monthExtraData = useMemo(
309
374
  () => ({
310
375
  events,
311
376
  activeDate,
@@ -325,14 +390,28 @@ function MonthPagerInner<T>({
325
390
  [selectedDates, selectedRange, minDate, maxDate, isDateDisabled],
326
391
  );
327
392
 
393
+ // One source object per page date, so a memoized page skips re-rendering when
394
+ // the list calls `renderItem` again with unchanged inputs.
395
+ const sourceFor = useMemo(() => {
396
+ const cache = new WeakMap<Date, DateRowsSource>();
397
+ return (item: Date): DateRowsSource => {
398
+ let source = cache.get(item);
399
+ if (!source) {
400
+ source = { ...spec, date: item };
401
+ cache.set(item, source);
402
+ }
403
+ return source;
404
+ };
405
+ }, [spec]);
406
+
328
407
  const snapToIndices = useMemo(() => monthDates.map((_, index) => index), [monthDates]);
329
408
  const keyExtractorList = useCallback((item: Date) => item.toISOString(), []);
330
409
  const getFixedItemSize = useCallback(() => containerWidth, [containerWidth]);
331
410
  const renderItem = useCallback(
332
411
  ({ item }: LegendListRenderItemProps<Date>) => (
333
412
  <View style={{ width: containerWidth, height: pageHeight }}>
334
- <MonthView
335
- date={item}
413
+ <DateRows
414
+ source={sourceFor(item)}
336
415
  events={events}
337
416
  // The pager shows one shared weekday header and the month title above it
338
417
  // (see below), so each page's grid omits its own title and weekday row.
@@ -347,11 +426,9 @@ function MonthPagerInner<T>({
347
426
  sortedMonthView={sortedMonthView}
348
427
  moreLabel={moreLabel}
349
428
  labels={labels}
350
- showAdjacentMonths={showAdjacentMonths}
351
429
  highlightWeekends={highlightWeekends}
352
430
  disableMonthEventCellPress={disableMonthEventCellPress}
353
431
  isRTL={isRTL}
354
- showSixWeeks={showSixWeeks}
355
432
  activeDate={activeDate}
356
433
  calendarCellStyle={calendarCellStyle}
357
434
  renderEvent={renderEvent}
@@ -388,11 +465,10 @@ function MonthPagerInner<T>({
388
465
  sortedMonthView,
389
466
  moreLabel,
390
467
  labels,
391
- showAdjacentMonths,
468
+ sourceFor,
392
469
  highlightWeekends,
393
470
  disableMonthEventCellPress,
394
471
  isRTL,
395
- showSixWeeks,
396
472
  activeDate,
397
473
  calendarCellStyle,
398
474
  renderEvent,
@@ -416,6 +492,24 @@ function MonthPagerInner<T>({
416
492
  ],
417
493
  );
418
494
 
495
+ // The multi-week view invalidates cached pages for every input that reaches
496
+ // renderItem, including callbacks and layout. LegendList does not track a new
497
+ // renderItem identity on its own.
498
+ const listExtraData = useMemo(
499
+ () => (numberOfWeeks === undefined ? monthExtraData : { renderItem }),
500
+ [numberOfWeeks, monthExtraData, renderItem],
501
+ );
502
+ const visible = useMemo(
503
+ () =>
504
+ numberOfWeeks === undefined
505
+ ? null
506
+ : buildMultiWeekGrid(date, { numberOfWeeks, weekStartsOn, hiddenDays }).visibleRange,
507
+ [date, numberOfWeeks, weekStartsOn, hiddenDays],
508
+ );
509
+ const title = visible
510
+ ? `${format(visible.start, "PP", { locale })} – ${format(addDays(visible.endExclusive, -1), "PP", { locale })}`
511
+ : format(date, "MMMM yyyy", { locale });
512
+
419
513
  return (
420
514
  <CalendarSelectionProvider value={selection}>
421
515
  <View ref={containerRef} style={[styles.container, theme.containers.monthContainer]}>
@@ -429,7 +523,7 @@ function MonthPagerInner<T>({
429
523
  })}
430
524
  allowFontScaling={false}
431
525
  >
432
- {format(date, "MMMM yyyy", locale ? { locale } : undefined)}
526
+ {title}
433
527
  </Text>
434
528
  ) : null}
435
529
  {renderHeaderForMonthView ? (
@@ -506,6 +600,67 @@ function MonthPagerInner<T>({
506
600
  */
507
601
  export const MonthPager = memo(MonthPagerInner) as typeof MonthPagerInner;
508
602
 
603
+ /** The swipeable pager behind `MonthPager` and `Calendar`'s row modes. */
604
+ function DateRowsPagerRoot<T>(props: DateRowsPagerProps<T>): ReactElement {
605
+ const count = props.spec.kind === "multiweek" ? props.spec.numberOfWeeks : undefined;
606
+ const target = useMemo(
607
+ () =>
608
+ count === undefined
609
+ ? props.date
610
+ : buildMultiWeekGrid(props.date, { numberOfWeeks: count, weekStartsOn: props.weekStartsOn })
611
+ .period.start,
612
+ [props.date, count, props.weekStartsOn],
613
+ );
614
+ const [series, setSeries] = useState(() => ({
615
+ anchor: target,
616
+ count,
617
+ weekStartsOn: props.weekStartsOn,
618
+ }));
619
+ let current = series;
620
+ if (count !== undefined) {
621
+ const offset =
622
+ differenceInCalendarWeeks(target, series.anchor, { weekStartsOn: props.weekStartsOn }) /
623
+ count;
624
+ if (
625
+ series.count !== count ||
626
+ series.weekStartsOn !== props.weekStartsOn ||
627
+ !Number.isInteger(offset) ||
628
+ Math.abs(offset) > PAGE_WINDOW
629
+ ) {
630
+ current = { anchor: target, count, weekStartsOn: props.weekStartsOn };
631
+ setSeries(current);
632
+ }
633
+ }
634
+ const key =
635
+ count === undefined ? "month" : `${current.anchor.getTime()}:${count}:${props.weekStartsOn}`;
636
+ const generation = useRef(key);
637
+ generation.current = key;
638
+ useEffect(() => {
639
+ generation.current = key;
640
+ return () => {
641
+ generation.current = "unmounted";
642
+ };
643
+ }, [key]);
644
+ const onChangeDate = useCallback(
645
+ (date: Date) => {
646
+ // A remounted series can still receive a queued viewability callback from
647
+ // the old list. Never let it change the controlled date.
648
+ if (generation.current === key) props.onChangeDate(date);
649
+ },
650
+ [key, props.onChangeDate],
651
+ );
652
+ return (
653
+ <DateRowsPagerInner
654
+ {...props}
655
+ key={key}
656
+ initialAnchor={count === undefined ? undefined : current.anchor}
657
+ onChangeDate={onChangeDate}
658
+ />
659
+ );
660
+ }
661
+
662
+ export const DateRowsPager = memo(DateRowsPagerRoot) as typeof DateRowsPagerRoot;
663
+
509
664
  type MonthWeekdayHeaderProps = {
510
665
  weekDays: Date[];
511
666
  weekdayFormat?: WeekdayFormat;