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

Customizable Date Picker for React

import { DayPickerProps } from 'DayPicker';

import { DayPickerContextValue } from 'contexts/DayPicker';

import { DayPickerBase } from './DayPickerBase';
import { SelectSingleEventHandler } from './EventHandlers';

/** The props for the {@link DayPicker} component when using `mode="single"`. */
export interface DayPickerSingleProps extends DayPickerBase {
  mode: 'single';
  /** The selected day. */
  selected?: Date | undefined;
  /** Event fired when a day is selected. */
  onSelect?: SelectSingleEventHandler;
  /** Make the selection required. */
  required?: boolean;
}

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