react-day-picker/src/types/DayPickerRange.ts

Customizable Date Picker for React

import { DayPickerProps } from 'DayPicker';

import { DayPickerContextValue } from 'contexts/DayPicker';

import { DayPickerBase } from './DayPickerBase';
import { SelectRangeEventHandler } from './EventHandlers';
import { DateRange } from './Matchers';

/** The props for the {@link DayPicker} component when using `mode="range"`. */
export interface DayPickerRangeProps extends DayPickerBase {
  mode: 'range';
  /** The selected range of days. */
  selected?: DateRange | undefined;
  /** Event fired when a range (or a part of the range) is selected. */
  onSelect?: SelectRangeEventHandler;
  /** The minimum amount of days that can be selected. */
  min?: number;
  /** The maximum amount of days that can be selected. */
  max?: number;
}

/** Returns true when the props are of type {@link DayPickerRangeProps}. */
export function isDayPickerRange(
  props: DayPickerProps | DayPickerContextValue
): props is DayPickerRangeProps {
  return props.mode === 'range';
}