@lazerlen/legend-calendar 1.4.1 → 1.6.0

package/dist/index.d.ts

@@ -1,7 +1,6 @@
-import * as react from 'react';
-import { ReactNode } from 'react';
-import { TextProps, ViewStyle, TextStyle, PressableProps, ColorSchemeName } from 'react-native';
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import { TextProps, ViewStyle, TextStyle, PressableProps, ColorSchemeName } from 'react-native';
+import { ReactNode } from 'react';
 import { LegendListProps } from '@legendapp/list/react-native';
 
 type CalendarTextProps = Omit<TextProps, "onPress" | "onLongPress" | "onPressIn" | "onPressOut">;
@@ -158,7 +157,7 @@ interface CalendarItemDayProps {
  * `CalendarItemDayWithContainer`, since it also includes the spacing between
  * each day.
  */
-declare const CalendarItemDay: react.NamedExoticComponent<CalendarItemDayProps>;
+declare const CalendarItemDay: ({ onPress, children, theme, height, metadata, textProps, CalendarPressableComponent, }: CalendarItemDayProps) => react_jsx_runtime.JSX.Element;
 interface CalendarItemDayContainerTheme {
     /** An empty view that acts as a spacer between each day. The spacing is
      * controlled by the `daySpacing` prop. */
@@ -189,7 +188,7 @@ interface CalendarItemDayContainerProps {
     /** The metadata for the day, extracted from the calendar's state. */
     metadata?: CalendarDayMetadata;
 }
-declare const CalendarItemDayContainer: react.NamedExoticComponent<CalendarItemDayContainerProps>;
+declare const CalendarItemDayContainer: ({ children, isStartOfWeek, shouldShowActiveDayFiller, theme, daySpacing, dayHeight, metadata, }: CalendarItemDayContainerProps) => react_jsx_runtime.JSX.Element;
 interface CalendarItemDayWithContainerProps extends Omit<CalendarItemDayProps, "height">, Pick<CalendarItemDayContainerProps, "daySpacing" | "dayHeight"> {
     containerTheme?: CalendarItemDayContainerTheme;
     /**
@@ -205,7 +204,7 @@ interface CalendarItemDayWithContainerProps extends Omit<CalendarItemDayProps, "
      */
     calendarInstanceId?: string;
 }
-declare const CalendarItemDayWithContainer: react.NamedExoticComponent<CalendarItemDayWithContainerProps>;
+declare const CalendarItemDayWithContainer: ({ children, metadata: baseMetadata, onPress, theme, dayHeight, daySpacing, containerTheme, calendarInstanceId, CalendarPressableComponent, }: CalendarItemDayWithContainerProps) => react_jsx_runtime.JSX.Element;
 
 interface CalendarItemEmptyProps {
     /** The height of the cell. Should be the same as `CalendarItemDay`. */
@@ -215,7 +214,7 @@ interface CalendarItemEmptyProps {
         container?: ViewStyle;
     };
 }
-declare const CalendarItemEmpty: react.NamedExoticComponent<CalendarItemEmptyProps>;
+declare const CalendarItemEmpty: (props: CalendarItemEmptyProps) => react_jsx_runtime.JSX.Element;
 
 interface CalendarItemWeekNameTheme {
     container?: ViewStyle;
@@ -232,7 +231,7 @@ interface CalendarItemWeekNameProps {
     /** Optional TextProps to spread to the <Text> component. */
     textProps?: Omit<CalendarTextProps, "children">;
 }
-declare const CalendarItemWeekName: react.NamedExoticComponent<CalendarItemWeekNameProps>;
+declare const CalendarItemWeekName: ({ children, height, theme, textProps, }: CalendarItemWeekNameProps) => react_jsx_runtime.JSX.Element;
 
 interface CalendarRowMonthTheme {
     container?: ViewStyle;
@@ -248,7 +247,7 @@ interface CalendarRowMonthProps {
     /** The theme of the month row, useful for customizing the component. */
     theme?: CalendarRowMonthTheme;
 }
-declare const CalendarRowMonth: react.NamedExoticComponent<CalendarRowMonthProps>;
+declare const CalendarRowMonth: ({ children, height, theme, }: CalendarRowMonthProps) => react_jsx_runtime.JSX.Element;
 
 /**
  * Minimal theme for the Legend Calendar component.
@@ -334,7 +333,7 @@ interface CalendarRowWeekProps {
 interface CalendarRowWeekTheme {
     container?: ViewStyle;
 }
-declare const CalendarRowWeek: react.NamedExoticComponent<CalendarRowWeekProps>;
+declare const CalendarRowWeek: ({ children, spacing, theme, }: CalendarRowWeekProps) => react_jsx_runtime.JSX.Element;
 
 type PressableLike = React.ComponentType<Pick<PressableProps, "children" | "style" | "disabled"> & {
     onPress: () => void;
@@ -410,7 +409,7 @@ interface CalendarProps extends UseCalendarParams {
     /** Optional component to replace the default <Pressable> component. */
     CalendarPressableComponent?: PressableLike;
 }
-declare const Calendar$1: react.NamedExoticComponent<CalendarProps>;
+declare const Calendar$1: (props: CalendarProps) => react_jsx_runtime.JSX.Element;
 
 interface CalendarMonth {
     id: string;
@@ -480,6 +479,29 @@ declare const getHeightForMonth: ({ calendarRowVerticalSpacing: vSpacing, calend
  * `Calendar` props to simplify building custom `Calendar` components.
  */
 type CalendarMonthEnhanced = CalendarMonth & {
+    /**
+     * The calendar configuration props for this item. Available when using a
+     * custom `renderItem` for backwards compatibility.
+     *
+     * @deprecated Prefer reading calendar config from context via
+     * `useCalendarListConfig()` instead of spreading `item.calendarProps`.
+     * This avoids creating a new data array each render and lets LegendList
+     * skip unnecessary item re-renders.
+     *
+     * **Before (slower):**
+     * ```tsx
+     * renderItem={({ item }) => (
+     *   <MyCalendar calendarMonthId={item.id} {...item.calendarProps} />
+     * )}
+     * ```
+     *
+     * **After (faster):**
+     * ```tsx
+     * // Inside your custom calendar component:
+     * const listConfig = useCalendarListConfig();
+     * // Merge: { ...listConfig, ...props }
+     * ```
+     */
     calendarProps: Omit<CalendarProps, "calendarMonthId">;
 };
 interface CalendarListProps extends Omit<CalendarProps, "calendarMonthId">, Omit<LegendListProps<CalendarMonthEnhanced>, "renderItem" | "data" | "children"> {
@@ -540,6 +562,12 @@ interface CalendarListProps extends Omit<CalendarProps, "calendarMonthId">, Omit
      * - calendarAdditionalHeight
      * - calendarRowVerticalSpacing
      * - calendarSpacing
+     *
+     * **Performance tip**: Using `item.calendarProps` is provided for
+     * backwards compatibility but creates a new data array each render.
+     * For better performance, have your custom component call
+     * `useCalendarListConfig()` to read the shared config from context
+     * and only use `item.id` as `calendarMonthId`.
      */
     renderItem?: LegendListProps<CalendarMonthEnhanced>["renderItem"];
 }
@@ -555,7 +583,7 @@ interface CalendarListRef {
     scrollToDate: (date: Date, animated: boolean, params?: ImperativeScrollParams) => void;
     scrollToOffset: (offset: number, animated: boolean) => void;
 }
-declare function CalendarList({ ref, ...props }: CalendarListProps & {
+declare function CalendarList(props: CalendarListProps & {
     ref?: React.Ref<CalendarListRef>;
 }): react_jsx_runtime.JSX.Element;
 
@@ -583,6 +611,23 @@ interface VStackProps {
 }
 declare function VStack({ children, spacing, alignItems, justifyContent, grow, }: VStackProps): react_jsx_runtime.JSX.Element;
 
+/**
+ * The calendar configuration props shared across all items in a
+ * `CalendarList`. When `Calendar` is rendered inside `CalendarList`, it reads
+ * these values from context instead of receiving them through the list item's
+ * data, which keeps the `data` array identity stable and allows LegendList to
+ * skip unnecessary re-renders.
+ *
+ * When `Calendar` is used standalone (outside a list), the context is `null`
+ * and all props are passed directly.
+ */
+type CalendarListConfig = Omit<CalendarProps, "calendarMonthId">;
+/**
+ * Returns the shared calendar configuration from the nearest
+ * `CalendarListConfigProvider`, or `null` when used outside a `CalendarList`.
+ */
+declare const useCalendarListConfig: () => CalendarListConfig | null;
+
 /**
  * This file houses the public API for the legend-calendar package.
  */
@@ -704,4 +749,4 @@ declare const useDateRange: (initialDateRange?: CalendarActiveDateRange) => {
     isDateRangeValid: boolean;
 };
 
-export { Calendar, type CalendarActiveDateRange, type CalendarDayMetadata, type CalendarItemDayContainerProps, type CalendarItemDayProps, type CalendarItemDayWithContainerProps, type CalendarItemEmptyProps, type CalendarItemWeekNameProps, type CalendarListProps, type CalendarListRef, type CalendarMonth, type CalendarMonthEnhanced, type CalendarOnDayPress, type CalendarProps, type CalendarRowMonthProps, type CalendarRowWeekProps, type CalendarTextProps, type CalendarTheme, type HStackProps, type UseCalendarListParams, type UseCalendarParams, type VStackProps, activeDateRangesStore, buildCalendar, fromDateId, getHeightForMonth, toDateId, useCalendar, useCalendarList, useDateRange, useOptimizedDayMetadata };
+export { Calendar, type CalendarActiveDateRange, type CalendarDayMetadata, type CalendarItemDayContainerProps, type CalendarItemDayProps, type CalendarItemDayWithContainerProps, type CalendarItemEmptyProps, type CalendarItemWeekNameProps, type CalendarListConfig, type CalendarListProps, type CalendarListRef, type CalendarMonth, type CalendarMonthEnhanced, type CalendarOnDayPress, type CalendarProps, type CalendarRowMonthProps, type CalendarRowWeekProps, type CalendarTextProps, type CalendarTheme, type HStackProps, type UseCalendarListParams, type UseCalendarParams, type VStackProps, activeDateRangesStore, buildCalendar, fromDateId, getHeightForMonth, toDateId, useCalendar, useCalendarList, useCalendarListConfig, useDateRange, useOptimizedDayMetadata };