@super-calendar/native 2.0.0

package/dist/index.d.ts

@@ -0,0 +1,386 @@
+import { C as defaultTheme, S as darkTheme, T as useCalendarTheme, _ as TimeGridMode, a as MonthPagerProps, b as CalendarThemeProvider, c as BusinessHours, d as EventKeyExtractor, f as ICalendarEvent, g as RenderEventArgs, h as RenderEvent, i as MonthPager, l as CalendarEvent, m as RecurrenceRule, n as MonthList, o as MonthView, p as RecurrenceFrequency, r as MonthListProps, s as MonthViewProps, t as DefaultMonthEvent, u as CalendarMode, v as WeekStartsOn, w as mergeTheme, x as PartialCalendarTheme, y as CalendarTheme } from "./DefaultMonthEvent-86XCNCge.js";
+import { Locale } from "date-fns";
+import { StyleProp, ViewStyle } from "react-native";
+import { SharedValue, useSharedValue } from "react-native-reanimated";
+import { DateRange, DateSelectionConstraints, DaySelectionState, MonthGrid, MonthGridDay, MonthGridWeek, MonthGridWeekday, PositionedEvent, UseDateRangeOptions, UseMonthGridOptions, buildMonthGrid, buildMonthWeeks, daySelectionState, eventsInTimeZone, expandRecurringEvents, getIsToday, getViewDays, getWeekDays, isAllDayEvent, isDateSelectable, isRangeEndpoint, isSameCalendarDay, isWeekend, isWithinDateRange, layoutDayEvents, minutesIntoDay, nextDateRange, toZonedTime, useDateRange, useMonthGrid } from "@super-calendar/core";
+import { ComponentType } from "react";
+
+//#region src/components/TimeGrid.d.ts
+declare const DEFAULT_HOUR_HEIGHT = 48;
+/**
+ * Called when an event is dragged (moved or resized) to new start/end times.
+ * Return `false` to reject the drop — the event snaps back to where it started
+ * (e.g. to forbid overlaps or out-of-bounds slots). Any other return accepts it.
+ */
+type EventDragHandler<T> = (event: CalendarEvent<T>, start: Date, end: Date) => void | boolean;
+/**
+ * Called when a move or resize gesture begins, before any change is committed:
+ * on grab for a move (after the long-press), and when the resize drag starts.
+ * Handy for haptic feedback (e.g. `expo-haptics`). Requires drag to be enabled
+ * via `onDragEvent`.
+ */
+type EventDragStartHandler<T> = (event: CalendarEvent<T>) => void;
+/** Replace the hour-axis label. Receives the hour (0–23) and the `ampm` flag. */
+type HourRenderer = (hour: number, ampm: boolean) => React.ReactNode;
+type TimeGridProps<T> = {
+  mode: TimeGridMode; /** Day columns to show in `custom` mode. Ignored by day/3days/week. Default 1. */
+  numberOfDays?: number;
+  /**
+   * Last weekday of a `custom` partial-week view (0–6). When set, `custom` shows
+   * `weekStartsOn`…`weekEndsOn` of `date`'s week and pages by week, taking
+   * precedence over `numberOfDays`. Ignored by other modes.
+   */
+  weekEndsOn?: WeekStartsOn;
+  date: Date;
+  events: CalendarEvent<T>[];
+  cellHeight: SharedValue<number>; /** Initial per-hour row height in px; seeds scroll/zoom without reading the shared value during render. */
+  hourHeight?: number;
+  weekStartsOn: WeekStartsOn;
+  renderEvent: RenderEvent<T>;
+  keyExtractor: EventKeyExtractor<T>;
+  scrollOffsetMinutes?: number;
+  hourColumnWidth?: number; /** Hide the left hour-axis column (lines stay, labels/gutter go). Default false. */
+  hideHours?: boolean; /** Sub-hour divider lines per hour (e.g. 2 = half-hours). Default 1 (none). */
+  timeslots?: number; /** Show the all-day lane above the grid. Default true. */
+  showAllDayEventCell?: boolean; /** Per-date style merged onto each day column. */
+  calendarCellStyle?: (date: Date) => StyleProp<ViewStyle>;
+  businessHours?: BusinessHours; /** Show the ISO week number in the header gutter. Default false. */
+  showWeekNumber?: boolean; /** Element rendered between the day header and the grid. */
+  headerComponent?: React.ReactNode; /** First hour shown (0–23). Default 0. */
+  minHour?: number; /** Last hour shown, exclusive (1–24). Default 24. */
+  maxHour?: number; /** Show hour labels in 12-hour AM/PM form. Default false (24h). */
+  ampm?: boolean; /** Reverse day-column order (right-to-left). Default false. */
+  isRTL?: boolean;
+  minHourHeight?: number;
+  maxHourHeight?: number;
+  showNowIndicator?: boolean;
+  locale?: Locale;
+  freeSwipe?: boolean; /** Allow swiping between pages. Default true. */
+  swipeEnabled?: boolean; /** Show the vertical scroll indicator on the time grid. Default true. */
+  showVerticalScrollIndicator?: boolean; /** Allow vertical scrolling of the time grid. Default true. */
+  verticalScrollEnabled?: boolean; /** Prefix for the week-number label (e.g. "W"). Default "W". */
+  weekNumberPrefix?: string; /** Replace the hour-axis label. Receives the hour (0–23) and `ampm`. */
+  hourComponent?: HourRenderer; /** Highlight this date in the header instead of the real "today". */
+  activeDate?: Date; /** After an empty-cell press, snap the pager back to the active page. Default false. */
+  resetPageOnPressCell?: boolean; /** Minutes a drag-to-move/resize snaps to. Default 15. */
+  dragStepMinutes?: number;
+  /**
+   * Show the resize grip on draggable events. Default true. Set false to keep
+   * drag-to-move and drag-to-resize working while hiding the visible indicator.
+   */
+  showDragHandle?: boolean;
+  onPressEvent: (event: CalendarEvent<T>) => void;
+  onLongPressEvent?: (event: CalendarEvent<T>) => void;
+  /**
+   * Enable drag-to-move and drag-to-resize on the week/day grid. Called with the
+   * event's new start/end (snapped to `dragStepMinutes`); update your own state.
+   */
+  onDragEvent?: EventDragHandler<T>; /** Fired the moment an event is grabbed for a move or resize (e.g. for haptics). */
+  onDragStart?: EventDragStartHandler<T>;
+  onPressCell?: (date: Date) => void;
+  onLongPressCell?: (date: Date) => void;
+  onCreateEvent?: (start: Date, end: Date) => void; /** Tap a day's column header (default header only). */
+  onPressDateHeader?: (date: Date) => void;
+  onChangeDate: (date: Date) => void; /** Optional header above the grid (e.g. weekday labels). Rendered full-width. */
+  renderHeader?: (days: Date[]) => React.ReactNode;
+};
+declare function TimeGridInner<T>({
+  mode,
+  numberOfDays,
+  weekEndsOn,
+  date,
+  events,
+  cellHeight,
+  hourHeight,
+  weekStartsOn,
+  renderEvent,
+  keyExtractor,
+  scrollOffsetMinutes,
+  hourColumnWidth: hourColumnWidthProp,
+  hideHours,
+  timeslots,
+  showAllDayEventCell,
+  calendarCellStyle,
+  businessHours,
+  showWeekNumber,
+  headerComponent,
+  minHour,
+  maxHour,
+  ampm,
+  isRTL,
+  minHourHeight,
+  maxHourHeight,
+  showNowIndicator,
+  locale,
+  freeSwipe,
+  swipeEnabled,
+  showVerticalScrollIndicator,
+  verticalScrollEnabled,
+  weekNumberPrefix,
+  hourComponent,
+  activeDate,
+  resetPageOnPressCell,
+  dragStepMinutes,
+  showDragHandle,
+  onPressEvent,
+  onLongPressEvent,
+  onDragEvent,
+  onDragStart,
+  onPressCell,
+  onLongPressCell,
+  onCreateEvent,
+  onPressDateHeader,
+  onChangeDate,
+  renderHeader
+}: TimeGridProps<T>): import("react").JSX.Element;
+declare const TimeGrid: typeof TimeGridInner;
+//#endregion
+//#region src/components/Calendar.d.ts
+type CalendarProps<T> = {
+  events: CalendarEvent<T>[];
+  mode: CalendarMode;
+  date: Date;
+  onChangeDate: (date: Date) => void; /** Fired alongside `onChangeDate` with the `[start, end]` of the newly-visible range. */
+  onChangeDateRange?: (range: [Date, Date]) => void;
+  onPressEvent: (event: CalendarEvent<T>) => void; /** Long-press an event (month/week/day). */
+  onLongPressEvent?: (event: CalendarEvent<T>) => void;
+  /**
+   * Enable drag-to-move and drag-to-resize on the week/day grid. Called with the
+   * dragged event and its new start/end (snapped to `dragStepMinutes`); update
+   * your own event state in response. Long-press an event to move it (drag
+   * horizontally to change the day too); drag its bottom grip to resize. Return
+   * `false` to reject the drop (e.g. an overlap) and snap the event back.
+   */
+  onDragEvent?: EventDragHandler<T>;
+  /**
+   * Fired when a move or resize gesture begins on the week/day grid, before any
+   * change is committed: on grab for a move (after the long-press), and when a
+   * resize drag starts. Use it to trigger haptic feedback, e.g.
+   * `Haptics.impactAsync()` from `expo-haptics`. Native-only and inert unless
+   * `onDragEvent` is also set.
+   */
+  onDragStart?: EventDragStartHandler<T>; /** Minutes a drag-to-move/resize snaps to. Default 15. */
+  dragStepMinutes?: number;
+  /**
+   * Show the resize grip on draggable events. Default true. Set false to keep
+   * drag-to-move and drag-to-resize working while hiding the visible indicator.
+   */
+  showDragHandle?: boolean; /** Tap a day cell (month mode) — e.g. drill into the day view. */
+  onPressDay?: (date: Date) => void; /** Long-press a day cell (month mode). */
+  onLongPressDay?: (date: Date) => void; /** Tap the "+N more" overflow label in a month cell. */
+  onPressMore?: (events: CalendarEvent<T>[], date: Date) => void; /** Tap empty space on the week/day grid; receives the date+time pressed. */
+  onPressCell?: (date: Date) => void; /** After an empty-cell press, snap the pager back to the active page. Default false. */
+  resetPageOnPressCell?: boolean; /** Long-press empty space on the week/day grid; receives the date+time. */
+  onLongPressCell?: (date: Date) => void;
+  /**
+   * Enable drag-to-create on the week/day grid: long-press empty space and drag
+   * to sweep out a new event's time range. Called on release with the snapped
+   * `start`/`end` (to `dragStepMinutes`); create your own event in response. A
+   * stationary press yields a one-step range. Native-only; supersedes
+   * `onLongPressCell` on empty space when set.
+   */
+  onCreateEvent?: (start: Date, end: Date) => void; /** Tap a day's column header on the week/day grid (default header only). */
+  onPressDateHeader?: (date: Date) => void;
+  /**
+   * Max event chips per month cell before they collapse into "+N more". Omit to
+   * auto-fit as many as the cell height allows (default); set a number for a
+   * fixed cap. Pass an explicit value when using a custom `renderEvent`.
+   */
+  maxVisibleEventCount?: number; /** Sort each month day's events by start. Default true. */
+  sortedMonthView?: boolean; /** Month overflow label template; `{moreCount}` is replaced. Default "{moreCount} More". */
+  moreLabel?: string; /** Show dimmed adjacent-month days in the month grid. Default true. */
+  showAdjacentMonths?: boolean; /** Ignore taps on month-cell events (day taps still fire). Default false. */
+  disableMonthEventCellPress?: boolean; /** First day of the week. Sunday = 0 (default) … Saturday = 6. */
+  weekStartsOn?: WeekStartsOn; /** Number of day columns when `mode="custom"`. Ignored by other modes. Default 1. */
+  numberOfDays?: number;
+  /**
+   * Last weekday of a `custom` partial-week view (0–6). When set, `custom` shows
+   * `weekStartsOn`…`weekEndsOn` of the visible week and pages by week, taking
+   * precedence over `numberOfDays`. Ignored by other modes.
+   */
+  weekEndsOn?: WeekStartsOn; /** Replace the built-in event box. Return a `flex: 1` element. */
+  renderEvent?: RenderEvent<T>; /** Per-event style merged onto the built-in event box (static or a function of the event). */
+  eventCellStyle?: StyleProp<ViewStyle> | ((event: CalendarEvent<T>) => StyleProp<ViewStyle>); /** Per-date style for month cells and week/day columns (e.g. shade specific dates). */
+  calendarCellStyle?: (date: Date) => StyleProp<ViewStyle>;
+  /**
+   * Week/day grid only: open hours per day for business-hours shading. Hours
+   * outside the returned `{ start, end }` are tinted; return `null` to shade the
+   * whole day (closed). Omit for no shading.
+   */
+  businessHours?: BusinessHours; /** Stable key per event. Defaults to start-time + index. */
+  keyExtractor?: EventKeyExtractor<T>; /** Partial theme merged over the defaults. */
+  theme?: PartialCalendarTheme; /** Externally-owned per-hour row height (week/day). Created internally if omitted. */
+  cellHeight?: ReturnType<typeof useSharedValue<number>>; /** Initial per-hour row height in px (week/day). Default 48. */
+  hourHeight?: number;
+  minHourHeight?: number;
+  maxHourHeight?: number;
+  hourColumnWidth?: number; /** Hide the left hour-axis column on the week/day grid. Default false. */
+  hideHours?: boolean; /** Sub-hour divider lines per hour on the week/day grid (e.g. 2 = half-hours). Default 1. */
+  timeslots?: number;
+  /**
+   * Show the all-day lane above the week/day grid. Default true. When false the
+   * lane is never rendered, so all-day events (see `ICalendarEvent.allDay` and
+   * whole-day spans) are not shown on the time grid.
+   */
+  showAllDayEventCell?: boolean; /** Show the ISO week number in the week/day header gutter. Default false. */
+  showWeekNumber?: boolean; /** Prefix for the week-number label (e.g. "W"). Default "W". */
+  weekNumberPrefix?: string; /** Replace the hour-axis label on the week/day grid. Receives the hour (0–23) and `ampm`. */
+  hourComponent?: HourRenderer; /** Always render six week rows in month view, for a fixed-height grid. Default false. */
+  showSixWeeks?: boolean; /** Allow swiping between pages (all modes). Default true. */
+  swipeEnabled?: boolean; /** Show the vertical scroll indicator on the week/day grid. Default true. */
+  showVerticalScrollIndicator?: boolean; /** Allow vertical scrolling of the week/day grid. Default true. */
+  verticalScrollEnabled?: boolean; /** Element rendered between the day header and the week/day grid. */
+  headerComponent?: React.ReactNode; /** First hour shown on the week/day grid (0–23). Default 0. */
+  minHour?: number; /** Last hour shown on the week/day grid, exclusive (1–24). Default 24. */
+  maxHour?: number; /** Show hour labels (and built-in event times) in 12-hour AM/PM form. Default false (24h). */
+  ampm?: boolean; /** Show the time range in the built-in event renderer (day/week/schedule). Default true. */
+  showTime?: boolean; /** Add a trailing ellipsis (…) when an event title overflows in the built-in renderer; otherwise the text is clipped. Default false. */
+  ellipsizeTitle?: boolean; /** Label the built-in renderer shows for an all-day event in the schedule (and its screen-reader text). Default "All day". */
+  allDayLabel?: string; /** Initial vertical scroll, in minutes from midnight (week/day). */
+  scrollOffsetMinutes?: number; /** Show the current-time line on the week/day grid. Default true. */
+  showNowIndicator?: boolean; /** A date-fns `Locale` for weekday/date labels. Defaults to English. */
+  locale?: Locale; /** Highlight this date (header/cell/agenda) instead of the real "today". */
+  activeDate?: Date;
+  /**
+   * Lay the day columns out right-to-left (month, week/day grid and all-day lane).
+   * Cosmetic only: the hour gutter stays on the left and paging still advances
+   * with the system scroll direction. Default false. For full RTL (including
+   * scroll direction), also enable React Native's `I18nManager`.
+   */
+  isRTL?: boolean;
+  /**
+   * Allow a fling to carry across several pages before snapping. Default false:
+   * one day/week/month per swipe.
+   */
+  freeSwipe?: boolean; /** Custom header above the week/day grid. Receives the visible days. */
+  renderTimeGridHeader?: (days: Date[]) => React.ReactNode; /** Replace the weekday-label header above the month grid. Return `null` to hide it. */
+  renderHeaderForMonthView?: (weekDays: Date[]) => React.ReactNode;
+  /**
+   * Month mode only: replace the default date badge in each day cell. Receives
+   * the day; return your own date label (e.g. a number with a dot or badge).
+   * Event chips and the "+N more" label still render below it.
+   */
+  renderCustomDateForMonth?: (date: Date) => React.ReactNode; /** Drawn between rows of the `schedule` (agenda) list. */
+  itemSeparatorComponent?: React.ComponentType<unknown> | null;
+};
+declare function Calendar<T>({
+  events,
+  mode,
+  date,
+  onChangeDate,
+  onChangeDateRange,
+  onPressEvent,
+  onLongPressEvent,
+  onDragEvent,
+  onDragStart,
+  dragStepMinutes,
+  showDragHandle,
+  onPressDay,
+  onLongPressDay,
+  onPressMore,
+  onPressCell,
+  resetPageOnPressCell,
+  onLongPressCell,
+  onCreateEvent,
+  onPressDateHeader,
+  maxVisibleEventCount,
+  sortedMonthView,
+  moreLabel,
+  showAdjacentMonths,
+  disableMonthEventCellPress,
+  weekStartsOn,
+  numberOfDays,
+  weekEndsOn,
+  renderEvent,
+  eventCellStyle,
+  calendarCellStyle,
+  businessHours,
+  keyExtractor,
+  theme,
+  cellHeight: cellHeightProp,
+  hourHeight,
+  minHourHeight,
+  maxHourHeight,
+  hourColumnWidth,
+  hideHours,
+  timeslots,
+  showAllDayEventCell,
+  showWeekNumber,
+  weekNumberPrefix,
+  hourComponent,
+  showSixWeeks,
+  swipeEnabled,
+  showVerticalScrollIndicator,
+  verticalScrollEnabled,
+  headerComponent,
+  minHour,
+  maxHour,
+  ampm,
+  showTime,
+  ellipsizeTitle,
+  allDayLabel,
+  scrollOffsetMinutes,
+  showNowIndicator,
+  locale,
+  activeDate,
+  isRTL,
+  freeSwipe,
+  renderTimeGridHeader,
+  renderHeaderForMonthView,
+  renderCustomDateForMonth,
+  itemSeparatorComponent
+}: CalendarProps<T>): import("react").JSX.Element;
+//#endregion
+//#region src/components/Agenda.d.ts
+type AgendaProps<T> = {
+  events: CalendarEvent<T>[];
+  locale?: Locale;
+  renderEvent: RenderEvent<T>;
+  keyExtractor: EventKeyExtractor<T>;
+  onPressEvent: (event: CalendarEvent<T>) => void;
+  onLongPressEvent?: (event: CalendarEvent<T>) => void;
+  onPressDay?: (date: Date) => void; /** Highlight this date's header instead of the real "today". */
+  activeDate?: Date; /** Drawn between rows of the agenda list. */
+  itemSeparatorComponent?: ComponentType<unknown> | null;
+};
+/**
+ * A vertical, day-grouped list of events (no time grid). Events are sorted by
+ * start, grouped under a date header per day. The consumer controls which
+ * events (and therefore which date range) are shown.
+ */
+declare function Agenda<T>({
+  events,
+  locale,
+  renderEvent,
+  keyExtractor,
+  onPressEvent,
+  onLongPressEvent,
+  onPressDay,
+  activeDate,
+  itemSeparatorComponent
+}: AgendaProps<T>): import("react").JSX.Element;
+//#endregion
+//#region src/components/DefaultEvent.d.ts
+/**
+ * The built-in event renderer: a filled, rounded box showing the event title
+ * and (on the day/week grid, when the box is tall enough) its time range. The
+ * title fills the box in whole lines, never a half-cut last line, and clips
+ * without an ellipsis unless `ellipsizeTitle` is set. The time is secondary: it
+ * only shows once a full line is free beneath the title. Pass your own
+ * `renderEvent` to `<Calendar>` to replace it entirely.
+ */
+declare function DefaultEvent<T>({
+  event,
+  mode,
+  boxHeight,
+  isAllDay,
+  ampm,
+  showTime,
+  ellipsizeTitle,
+  allDayLabel,
+  cellStyle,
+  onPress,
+  onLongPress
+}: RenderEventArgs<T>): import("react").JSX.Element;
+//#endregion
+export { Agenda, type AgendaProps, type BusinessHours, Calendar, type CalendarEvent, type CalendarMode, type CalendarProps, type CalendarTheme, CalendarThemeProvider, DEFAULT_HOUR_HEIGHT, type DateRange, type DateSelectionConstraints, type DaySelectionState, DefaultEvent, DefaultMonthEvent, type EventDragHandler, type EventDragStartHandler, type EventKeyExtractor, type HourRenderer, type ICalendarEvent, type MonthGrid, type MonthGridDay, type MonthGridWeek, type MonthGridWeekday, MonthList, type MonthListProps, MonthPager, type MonthPagerProps, MonthView, type MonthViewProps, type PartialCalendarTheme, type PositionedEvent, type RecurrenceFrequency, type RecurrenceRule, type RenderEvent, type RenderEventArgs, TimeGrid, type TimeGridMode, type TimeGridProps, type UseDateRangeOptions, type UseMonthGridOptions, type WeekStartsOn, buildMonthGrid, buildMonthWeeks, darkTheme, daySelectionState, defaultTheme, eventsInTimeZone, expandRecurringEvents, getIsToday, getViewDays, getWeekDays, isAllDayEvent, isDateSelectable, isRangeEndpoint, isSameCalendarDay, isWeekend, isWithinDateRange, layoutDayEvents, mergeTheme, minutesIntoDay, nextDateRange, toZonedTime, useCalendarTheme, useDateRange, useMonthGrid };