react-day-picker 8.2.0 → 8.3.0

package/dist/contexts/Modifiers/utils/isMatch.d.ts

@@ -1,19 +0,0 @@
-import { Matcher } from '../../../types/Matchers';
-/**
- * Returns whether a day matches against at least one of the given Matchers.
- *
- * ```
- * const day = new Date(2022, 5, 19);
- * const matcher1: DateRange = {
- *    from: new Date(2021, 12, 21),
- *    to: new Date(2021, 12, 30)
- * }
- * const matcher2: DateRange = {
- *    from: new Date(2022, 5, 1),
- *    to: new Date(2022, 5, 23)
- * }
- *
- * const isMatch(day, [matcher1, matcher2]); // true, since day is in the matcher1 range.
- * ```
- * */
-export declare function isMatch(day: Date, matchers: Matcher[]): boolean;

package/dist/contexts/Modifiers/utils/matcherToArray.d.ts

@@ -1,3 +0,0 @@
-import { Matcher } from '../../../types/Matchers';
-/** Normalize to array a matcher input. */
-export declare function matcherToArray(matcher: Matcher | Matcher[] | undefined): Matcher[];

package/dist/contexts/Navigation/NavigationContext.d.ts

@@ -1,27 +0,0 @@
-import React, { ReactNode } from 'react';
-/** Represents the value of the {@link NavigationContext}. */
-export interface NavigationContextValue {
-    /** The month to display in the calendar. When `numberOfMonths` is greater than one, is the first of the displayed months. */
-    currentMonth: Date;
-    /** The months rendered by DayPicker. DayPicker can render multiple months via `numberOfMonths`. */
-    displayMonths: Date[];
-    /** Navigate to the specified month. */
-    goToMonth: (month: Date) => void;
-    /** Navigate to the specified date. */
-    goToDate: (date: Date, refDate?: Date) => void;
-    /** The next month to display. */
-    nextMonth?: Date;
-    /** The previous month to display. */
-    previousMonth?: Date;
-    /** Whether the given day is included in the displayed months. */
-    isDateDisplayed: (day: Date) => boolean;
-}
-/**
- * The Navigation context shares details and methods to navigate the months in DayPicker.
- * Access this context from the {@link useNavigation} hook.
- */
-export declare const NavigationContext: React.Context<NavigationContextValue | undefined>;
-/** Provides the values for the {@link NavigationContext}. */
-export declare function NavigationProvider(props: {
-    children?: ReactNode;
-}): JSX.Element;

package/dist/contexts/Navigation/index.d.ts

@@ -1,2 +0,0 @@
-export * from './NavigationContext';
-export * from './useNavigation';

package/dist/contexts/Navigation/useNavigation.d.ts

@@ -1,8 +0,0 @@
-import { NavigationContextValue } from './NavigationContext';
-/**
- * Hook to access the {@link NavigationContextValue}. Use this hook to navigate
- * between months or years in DayPicker.
- *
- * This hook is meant to be used inside internal or custom components.
- */
-export declare function useNavigation(): NavigationContextValue;

package/dist/contexts/Navigation/useNavigationState.d.ts

@@ -1,7 +0,0 @@
-/** Controls the navigation state. */
-export declare function useNavigationState(): [
-    /** The month DayPicker is navigating at */
-    month: Date,
-    /** Go to the specified month. */
-    goToMonth: (month: Date) => void
-];

package/dist/contexts/Navigation/utils/getDisplayMonths.d.ts

@@ -1,8 +0,0 @@
-/**
- * Return the months to display in the component according to the number of
- * months and the from/to date.
- */
-export declare function getDisplayMonths(month: Date, { reverseMonths, numberOfMonths }: {
-    reverseMonths?: boolean;
-    numberOfMonths: number;
-}): Date[];

package/dist/contexts/Navigation/utils/getInitialMonth.d.ts

@@ -1,3 +0,0 @@
-import { DayPickerContextValue } from '../../../contexts/DayPicker';
-/** Return the initial month according to the given options. */
-export declare function getInitialMonth(context: Partial<DayPickerContextValue>): Date;

package/dist/contexts/Navigation/utils/getNextMonth.d.ts

@@ -1,18 +0,0 @@
-/**
- * Returns the next month the user can navigate to according to the given
- * options.
- *
- * Please note that the next month is not always the next calendar month:
- *
- * - if after the `toDate` range, is undefined;
- * - if the navigation is paged, is the number of months displayed ahead.
- *
- */
-export declare function getNextMonth(startingMonth: Date, options: {
-    numberOfMonths?: number;
-    fromDate?: Date;
-    toDate?: Date;
-    pagedNavigation?: boolean;
-    today?: Date;
-    disableNavigation?: boolean;
-}): Date | undefined;

package/dist/contexts/Navigation/utils/getPreviousMonth.d.ts

@@ -1,19 +0,0 @@
-/**
- * Returns the next previous the user can navigate to, according to the given
- * options.
- *
- * Please note that the previous month is not always the previous calendar
- * month:
- *
- * - if before the `fromDate` date, is `undefined`;
- * - if the navigation is paged, is the number of months displayed before.
- *
- */
-export declare function getPreviousMonth(startingMonth: Date, options: {
-    numberOfMonths?: number;
-    fromDate?: Date;
-    toDate?: Date;
-    pagedNavigation?: boolean;
-    today?: Date;
-    disableNavigation?: boolean;
-}): Date | undefined;

package/dist/contexts/RootProvider.d.ts

@@ -1,8 +0,0 @@
-import React from 'react';
-import { DayPickerBase } from '../types/DayPickerBase';
-/** The props of {@link RootProvider}. */
-export declare type RootContext = DayPickerBase & {
-    children: React.ReactNode;
-};
-/** Provide the value for all the context providers. */
-export declare function RootProvider(props: RootContext): JSX.Element;

package/dist/contexts/SelectMultiple/SelectMultipleContext.d.ts

@@ -1,35 +0,0 @@
-import React, { ReactNode } from 'react';
-import { DayPickerBase } from '../../types/DayPickerBase';
-import { DayPickerMultipleProps } from '../../types/DayPickerMultiple';
-import { DayClickEventHandler } from '../../types/EventHandlers';
-import { InternalModifier, Modifiers } from '../../types/Modifiers';
-/** Represent the modifiers that are changed by the multiple selection. */
-export declare type SelectMultipleModifiers = Pick<Modifiers, InternalModifier.Disabled>;
-/** Represents the value of a {@link SelectMultipleContext}. */
-export interface SelectMultipleContextValue {
-    /** The days that have been selected. */
-    selected: Date[] | undefined;
-    /** The modifiers for the corresponding selection. */
-    modifiers: SelectMultipleModifiers;
-    /** Event handler to attach to the day button to enable the multiple select. */
-    onDayClick?: DayClickEventHandler;
-}
-/**
- * The SelectMultiple context shares details about the selected days when in
- * multiple selection mode.
- *
- * Access this context from the {@link useSelectMultiple} hook.
- */
-export declare const SelectMultipleContext: React.Context<SelectMultipleContextValue | undefined>;
-export declare type SelectMultipleProviderProps = {
-    initialProps: DayPickerBase;
-    children: ReactNode;
-};
-/** Provides the values for the {@link SelectMultipleContext}. */
-export declare function SelectMultipleProvider(props: SelectMultipleProviderProps): JSX.Element;
-declare type SelectMultipleProviderInternalProps = {
-    initialProps: DayPickerMultipleProps;
-    children: ReactNode;
-};
-export declare function SelectMultipleProviderInternal({ initialProps, children }: SelectMultipleProviderInternalProps): JSX.Element;
-export {};

package/dist/contexts/SelectMultiple/index.d.ts

@@ -1,2 +0,0 @@
-export * from './SelectMultipleContext';
-export * from './useSelectMultiple';

package/dist/contexts/SelectMultiple/useSelectMultiple.d.ts

@@ -1,7 +0,0 @@
-import { SelectMultipleContextValue } from './SelectMultipleContext';
-/**
- * Hook to access the {@link SelectMultipleContextValue}.
- *
- * This hook is meant to be used inside internal or custom components.
- */
-export declare function useSelectMultiple(): SelectMultipleContextValue;

package/dist/contexts/SelectRange/SelectRangeContext.d.ts

@@ -1,36 +0,0 @@
-import React, { ReactNode } from 'react';
-import { DayPickerBase } from '../../types/DayPickerBase';
-import { DayPickerRangeProps } from '../../types/DayPickerRange';
-import { DayClickEventHandler } from '../../types/EventHandlers';
-import { DateRange } from '../../types/Matchers';
-import { InternalModifier, Modifiers } from '../../types/Modifiers';
-/** Represent the modifiers that are changed by the range selection. */
-export declare type SelectRangeModifiers = Pick<Modifiers, InternalModifier.Disabled | InternalModifier.RangeEnd | InternalModifier.RangeMiddle | InternalModifier.RangeStart>;
-/** Represents the value of a {@link SelectRangeContext}. */
-export interface SelectRangeContextValue {
-    /** The range of days that has been selected. */
-    selected: DateRange | undefined;
-    /** The modifiers for the corresponding selection. */
-    modifiers: SelectRangeModifiers;
-    /** Event handler to attach to the day button to enable the range select. */
-    onDayClick?: DayClickEventHandler;
-}
-/**
- * The SelectRange context shares details about the selected days when in
- * range selection mode.
- *
- * Access this context from the {@link useSelectRange} hook.
- */
-export declare const SelectRangeContext: React.Context<SelectRangeContextValue | undefined>;
-declare type SelectRangeProviderProps = {
-    initialProps: DayPickerBase;
-    children: ReactNode;
-};
-/** Provides the values for the {@link SelectRangeProvider}. */
-export declare function SelectRangeProvider(props: SelectRangeProviderProps): JSX.Element;
-declare type SelectRangeProviderInternalProps = {
-    initialProps: DayPickerRangeProps;
-    children: ReactNode;
-};
-export declare function SelectRangeProviderInternal({ initialProps, children }: SelectRangeProviderInternalProps): JSX.Element;
-export {};

package/dist/contexts/SelectRange/index.d.ts

@@ -1,2 +0,0 @@
-export * from './SelectRangeContext';
-export * from './useSelectRange';

package/dist/contexts/SelectRange/useSelectRange.d.ts

@@ -1,7 +0,0 @@
-import { SelectRangeContextValue } from './SelectRangeContext';
-/**
- * Hook to access the {@link SelectRangeContextValue}.
- *
- * This hook is meant to be used inside internal or custom components.
- */
-export declare function useSelectRange(): SelectRangeContextValue;

package/dist/contexts/SelectRange/utils/addToRange.d.ts

@@ -1,8 +0,0 @@
-import { DateRange } from '../../../types/Matchers';
-/**
- * Add a day to an existing range.
- *
- * The returned range takes in account the `undefined` values and if the added
- * day is already present in the range.
- */
-export declare function addToRange(day: Date, range?: DateRange): DateRange | undefined;

package/dist/contexts/SelectSingle/SelectSingleContext.d.ts

@@ -1,30 +0,0 @@
-import React from 'react';
-import { DayPickerBase } from '../../types/DayPickerBase';
-import { DayPickerSingleProps } from '../../types/DayPickerSingle';
-import { DayClickEventHandler } from '../../types/EventHandlers';
-/** Represents the value of a {@link SelectSingleContext}. */
-export interface SelectSingleContextValue {
-    /** The day that has been selected. */
-    selected: Date | undefined;
-    /** Event handler to attach to the day button to enable the single select. */
-    onDayClick?: DayClickEventHandler;
-}
-/**
- * The SelectSingle context shares details about the selected days when in
- * single selection mode.
- *
- * Access this context from the {@link useSelectSingle} hook.
- */
-export declare const SelectSingleContext: React.Context<SelectSingleContextValue | undefined>;
-declare type SelectSingleProviderProps = {
-    initialProps: DayPickerBase;
-    children: React.ReactNode;
-};
-/** Provides the values for the {@link SelectSingleProvider}. */
-export declare function SelectSingleProvider(props: SelectSingleProviderProps): JSX.Element;
-declare type SelectSingleProviderInternal = {
-    initialProps: DayPickerSingleProps;
-    children: React.ReactNode;
-};
-export declare function SelectSingleProviderInternal({ initialProps, children }: SelectSingleProviderInternal): JSX.Element;
-export {};

package/dist/contexts/SelectSingle/index.d.ts

@@ -1,2 +0,0 @@
-export * from './SelectSingleContext';
-export * from './useSelectSingle';

package/dist/contexts/SelectSingle/useSelectSingle.d.ts

@@ -1,7 +0,0 @@
-import { SelectSingleContextValue } from './SelectSingleContext';
-/**
- * Hook to access the {@link SelectSingleContextValue}.
- *
- * This hook is meant to be used inside internal or custom components.
- */
-export declare function useSelectSingle(): SelectSingleContextValue;

package/dist/hooks/useActiveModifiers/index.d.ts

@@ -1 +0,0 @@
-export * from './useActiveModifiers';

package/dist/hooks/useActiveModifiers/useActiveModifiers.d.ts

@@ -1,15 +0,0 @@
-import { ActiveModifiers } from '../../types/Modifiers';
-/**
- * Return the active modifiers for the specified day.
- *
- * This hook is meant to be used inside internal or custom components.
- *
- * @param day
- * @param displayMonth
- */
-export declare function useActiveModifiers(day: Date, 
-/**
- * The month where the date is displayed. If not the same as `date`, the day
- * is an "outside day".
- */
-displayMonth?: Date): ActiveModifiers;

package/dist/hooks/useControlledValue/index.d.ts

@@ -1 +0,0 @@
-export * from './useControlledValue';

package/dist/hooks/useControlledValue/useControlledValue.d.ts

@@ -1,12 +0,0 @@
-import React from 'react';
-export declare type DispatchStateAction<T> = React.Dispatch<React.SetStateAction<T>>;
-/**
- * Helper hook for using controlled/uncontrolled values from a component props.
- *
- * When the value is not controlled, pass `undefined` as `controlledValue` and
- * use the returned setter to update it.
- *
- * When the value is controlled, pass the controlled value as second
- * argument, which will be always returned as `value`.
- */
-export declare function useControlledValue<T>(defaultValue: T, controlledValue: T | undefined): [T, DispatchStateAction<T>];

package/dist/hooks/useDayEventHandlers/index.d.ts

@@ -1 +0,0 @@
-export * from './useDayEventHandlers';

package/dist/hooks/useDayEventHandlers/useDayEventHandlers.d.ts

@@ -1,26 +0,0 @@
-import { HTMLProps } from 'react';
-import { ActiveModifiers } from '../../types/Modifiers';
-export declare type EventName = 'onClick' | 'onFocus' | 'onBlur' | 'onKeyDown' | 'onKeyUp' | 'onMouseEnter' | 'onMouseLeave' | 'onTouchCancel' | 'onTouchEnd' | 'onTouchMove' | 'onTouchStart';
-export declare type DayEventName = 'onDayClick' | 'onDayFocus' | 'onDayBlur' | 'onDayKeyDown' | 'onDayKeyUp' | 'onDayMouseEnter' | 'onDayMouseLeave' | 'onDayTouchCancel' | 'onDayTouchEnd' | 'onDayTouchMove' | 'onDayTouchStart';
-export declare type DayEventHandlers = Pick<HTMLProps<HTMLButtonElement>, EventName>;
-/**
- * This hook returns details about the content to render in the day cell.
- *
- *
- * When a day cell is rendered in the table, DayPicker can either:
- *
- * - render nothing: when the day is outside the month or has matched the
- *   "hidden" modifier.
- * - render a button when `onDayClick` or a selection mode is set.
- * - render a non-interactive element: when no selection mode is set, the day
- *   cell shouldn’t respond to any interaction. DayPicker should render a `div`
- *   or a `span`.
- *
- * ### Usage
- *
- * Use this hook to customize the behavior of the {@link Day} component. Create a
- * new `Day` component using this hook and pass it to the `components` prop.
- * The source of {@link Day} can be a good starting point.
- *
- */
-export declare function useDayEventHandlers(date: Date, activeModifiers: ActiveModifiers): DayEventHandlers;

package/dist/hooks/useDayRender/index.d.ts

@@ -1 +0,0 @@
-export * from './useDayRender';

package/dist/hooks/useDayRender/useDayRender.d.ts

@@ -1,32 +0,0 @@
-import React from 'react';
-import { ButtonProps } from '../../components/Button';
-import { DayEventHandlers } from '../../hooks/useDayEventHandlers';
-import { SelectedDays } from '../../hooks/useSelectedDays';
-import { ActiveModifiers } from '../../types/Modifiers';
-import { StyledComponent } from '../../types/Styles';
-export declare type DayRender = {
-    /** Whether the day should be rendered a `button` instead of a `div` */
-    isButton: boolean;
-    /** Whether the day should be hidden. */
-    isHidden: boolean;
-    /** The modifiers active for the given day. */
-    activeModifiers: ActiveModifiers;
-    /** The props to apply to the button element (when `isButton` is true). */
-    buttonProps: StyledComponent & Pick<ButtonProps, 'disabled' | 'aria-pressed' | 'tabIndex'> & DayEventHandlers;
-    /** The props to apply to the div element (when `isButton` is false). */
-    divProps: StyledComponent;
-    selectedDays: SelectedDays;
-};
-/**
- * Return props and data used to render the {@link Day} component.
- *
- * Use this hook when creating a component to replace the built-in `Day`
- * component.
- */
-export declare function useDayRender(
-/** The date to render. */
-day: Date, 
-/** The month where the date is displayed (if not the same as `date`, it means it is an "outside" day). */
-displayMonth: Date, 
-/** A ref to the button element that will be target of focus when rendered (if required). */
-buttonRef: React.RefObject<HTMLButtonElement>): DayRender;

package/dist/hooks/useDayRender/utils/getDayClassNames.d.ts

@@ -1,10 +0,0 @@
-import { DayPickerContextValue } from '../../../contexts/DayPicker';
-import { ActiveModifiers } from '../../../types/Modifiers';
-/**
- * Return the class names for the Day element, according to the given active
- * modifiers.
- *
- * Custom class names are set via `modifiersClassNames` or `classNames`,
- * where the first have the precedence.
- */
-export declare function getDayClassNames(dayPicker: Pick<DayPickerContextValue, 'modifiersClassNames' | 'classNames'>, activeModifiers: ActiveModifiers): string[];

package/dist/hooks/useDayRender/utils/getDayStyle.d.ts

@@ -1,5 +0,0 @@
-/// <reference types="react" />
-import { DayPickerContextValue } from '../../../contexts/DayPicker';
-import { ActiveModifiers } from '../../../types/Modifiers';
-/** Return the style for the Day element, according to the given active modifiers. */
-export declare function getDayStyle(dayPicker: Pick<DayPickerContextValue, 'modifiersStyles' | 'styles'>, activeModifiers: ActiveModifiers): React.CSSProperties;

package/dist/hooks/useId/index.d.ts

@@ -1 +0,0 @@
-export * from './useId';

package/dist/hooks/useId/useId.d.ts

@@ -1,19 +0,0 @@
-/**
- * useId
- *
- * Autogenerate IDs to facilitate WAI-ARIA and server rendering.
- *
- * Note: The returned ID will initially be `null` and will update after a
- * component mounts. Users may need to supply their own ID if they need
- * consistent values for SSR.
- *
- * @see Docs https://reach.tech/auto-id
- */
-declare function useId(idFromProps: string): string;
-declare function useId(idFromProps: number): number;
-declare function useId(idFromProps: string | number): string | number;
-declare function useId(idFromProps: string | undefined | null): string | undefined;
-declare function useId(idFromProps: number | undefined | null): number | undefined;
-declare function useId(idFromProps: string | number | undefined | null): string | number | undefined;
-declare function useId(): string | undefined;
-export { useId };

package/dist/hooks/useInput/index.d.ts

@@ -1 +0,0 @@
-export * from './useInput';

package/dist/hooks/useInput/useInput.d.ts

@@ -1,28 +0,0 @@
-import React from 'react';
-import { DayPickerBase } from '../../types/DayPickerBase';
-import { DayPickerSingleProps } from '../../types/DayPickerSingle';
-/** The props to attach to the input field when using {@link useInput}. */
-export declare type InputHTMLAttributes = Pick<React.InputHTMLAttributes<HTMLInputElement>, 'onBlur' | 'onChange' | 'onFocus' | 'value' | 'placeholder'>;
-/** The props to attach to the DayPicker component when using {@link useInput}. */
-export declare type InputDayPickerProps = Pick<DayPickerSingleProps, 'fromDate' | 'toDate' | 'locale' | 'month' | 'onDayClick' | 'onMonthChange' | 'selected' | 'today'>;
-export interface UseInputOptions extends Pick<DayPickerBase, 'locale' | 'fromDate' | 'toDate' | 'fromMonth' | 'toMonth' | 'fromYear' | 'toYear' | 'today'> {
-    /** The initially selected date */
-    defaultSelected?: Date;
-    /** The format string for formatting the input field. See https://date-fns.org/docs/format for a list of format strings. Default to `PP`. */
-    format?: string;
-    /** Make the selection required. */
-    required?: boolean;
-}
-/** Represent the value returned by {@link useInput}. */
-export interface UseInputValue {
-    /** The props to pass to a DayPicker component. */
-    dayPickerProps: InputDayPickerProps;
-    /** The props to pass to an input field. */
-    inputProps: InputHTMLAttributes;
-    /** A function to reset to the initial state. */
-    reset: () => void;
-    /** A function to set the selected day. */
-    setSelected: (day: Date | undefined) => void;
-}
-/** Return props and setters for binding an input field to DayPicker. */
-export declare function useInput(options?: UseInputOptions): UseInputValue;

package/dist/hooks/useInput/utils/isValidDate.d.ts

@@ -1,2 +0,0 @@
-/** @private */
-export declare function isValidDate(day: Date): boolean;

package/dist/hooks/useSelectedDays/index.d.ts

@@ -1 +0,0 @@
-export * from './useSelectedDays';

package/dist/hooks/useSelectedDays/useSelectedDays.d.ts

@@ -1,10 +0,0 @@
-import { DateRange } from '../../types/Matchers';
-export declare type SelectedDays = Date | Date[] | DateRange | undefined;
-/**
- * Return the current selected days when DayPicker is in selection mode. Days
- * selected by the custom selection mode are not returned.
- *
- * This hook is meant to be used inside internal or custom components.
- *
- */
-export declare function useSelectedDays(): SelectedDays;