react-day-picker 8.0.1 → 8.0.4

package/src/hooks/useInput/useInput.ts

@@ -0,0 +1,175 @@
+import React, { useState } from 'react';
+
+import differenceInCalendarDays from 'date-fns/differenceInCalendarDays';
+import _format from 'date-fns/format';
+import enUS from 'date-fns/locale/en-US';
+import parse from 'date-fns/parse';
+
+import { parseFromToProps } from 'contexts/DayPicker/utils';
+import { DayPickerBase } from 'types/DayPickerBase';
+import { DayPickerDefaultProps } from 'types/DayPickerDefault';
+import {
+  DayClickEventHandler,
+  MonthChangeEventHandler
+} from 'types/EventHandlers';
+
+import { isValidDate } from './utils/isValidDate';
+
+/** The props to attach to the input field when using [[useInput]]. */
+export type InputHTMLAttributes = Pick<
+  React.InputHTMLAttributes<HTMLInputElement>,
+  'onBlur' | 'onChange' | 'onFocus' | 'value' | 'placeholder'
+>;
+
+/** The props to attach to the DayPicker component when using [[useInput]]. */
+export type InputDayPickerProps = Pick<
+  DayPickerDefaultProps,
+  | '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 [[useInput]]. */
+export interface UseInput {
+  /** 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 function useInput(options: UseInputOptions = {}): UseInput {
+  const {
+    locale = enUS,
+    required,
+    format = 'PP',
+    defaultSelected,
+    today = new Date()
+  } = options;
+  const { fromDate, toDate } = parseFromToProps(options);
+
+  // Shortcut to the DateFns functions
+  const parseValue = (value: string) => parse(value, format, today, { locale });
+
+  // Initialize states
+  const [month, setMonth] = useState(defaultSelected ?? today);
+  const [selectedDay, setSelectedDay] = useState(defaultSelected);
+  const defaultInputValue = defaultSelected
+    ? _format(defaultSelected, format, { locale })
+    : '';
+  const [inputValue, setInputValue] = useState(defaultInputValue);
+
+  const reset = () => {
+    setSelectedDay(defaultSelected);
+    setMonth(defaultSelected ?? today);
+    setInputValue(defaultInputValue ?? '');
+  };
+
+  const setSelected = (date: Date | undefined) => {
+    setSelectedDay(date);
+    setMonth(date ?? today);
+    setInputValue(date ? _format(date, format, { locale }) : '');
+  };
+
+  const handleDayClick: DayClickEventHandler = (day, { selected }) => {
+    if (!required && selected) {
+      setSelectedDay(undefined);
+      setInputValue('');
+      return;
+    }
+    setSelectedDay(day);
+    setInputValue(day ? _format(day, format, { locale }) : '');
+  };
+
+  const handleMonthChange: MonthChangeEventHandler = (month) => {
+    setMonth(month);
+  };
+
+  // When changing the input field, save its value in state and check if the
+  // string is a valid date. If it is a valid day, set it as selected and update
+  // the calendar’s month.
+  const handleChange: React.ChangeEventHandler<HTMLInputElement> = (e) => {
+    setInputValue(e.target.value);
+    const day = parseValue(e.target.value);
+    const isBefore = fromDate && differenceInCalendarDays(fromDate, day) > 0;
+    const isAfter = toDate && differenceInCalendarDays(day, toDate) > 0;
+    if (!isValidDate(day) || isBefore || isAfter) {
+      setSelectedDay(undefined);
+      return;
+    }
+    setSelectedDay(day);
+    setMonth(day);
+  };
+
+  // Special case for _required_ fields: on blur, if the value of the input is not
+  // a valid date, reset the calendar and the input value.
+  const handleBlur: React.FocusEventHandler<HTMLInputElement> = (e) => {
+    const day = parseValue(e.target.value);
+    if (!isValidDate(day)) {
+      reset();
+    }
+  };
+
+  // When focusing, make sure DayPicker visualizes the month of the date in the
+  // input field.
+  const handleFocus: React.FocusEventHandler<HTMLInputElement> = (e) => {
+    if (!e.target.value) {
+      reset();
+      return;
+    }
+    const day = parseValue(e.target.value);
+    if (isValidDate(day)) {
+      setMonth(day);
+    }
+  };
+
+  const dayPickerProps: InputDayPickerProps = {
+    month: month,
+    onDayClick: handleDayClick,
+    onMonthChange: handleMonthChange,
+    selected: selectedDay,
+    locale,
+    fromDate: options?.fromDate,
+    toDate: options?.toDate,
+    today
+  };
+
+  const inputProps: InputHTMLAttributes = {
+    onBlur: handleBlur,
+    onChange: handleChange,
+    onFocus: handleFocus,
+    value: inputValue,
+    placeholder: _format(new Date(), format, { locale })
+  };
+
+  return { dayPickerProps, inputProps, reset, setSelected };
+}

package/src/hooks/useInput/utils/isValidDate.tsx

@@ -0,0 +1,4 @@
+/** @private */
+export function isValidDate(day: Date): boolean {
+  return !isNaN(day.getTime());
+}

package/src/hooks/useSelectedDays/index.ts

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

package/src/hooks/useSelectedDays/useSelectedDays.test.ts

@@ -0,0 +1,72 @@
+import { RenderResult } from '@testing-library/react-hooks';
+import { DayPickerProps } from 'DayPicker';
+
+import { customRenderHook } from 'test/render';
+
+import { SelectMultipleContextValue } from 'contexts/SelectMultiple';
+import { SelectRangeContextValue } from 'contexts/SelectRange';
+import { SelectSingleContextValue } from 'contexts/SelectSingle';
+
+import { SelectedDays, useSelectedDays } from './useSelectedDays';
+
+const today = new Date(2021, 11, 8);
+
+const single: SelectSingleContextValue = {
+  selected: today
+};
+
+const multiple: SelectMultipleContextValue = {
+  selected: [today],
+  modifiers: { disabled: [] }
+};
+
+const range: SelectRangeContextValue = {
+  selected: undefined,
+  modifiers: {
+    disabled: [],
+    range_start: [],
+    range_end: [],
+    range_middle: []
+  }
+};
+const selectionContext = { single, multiple, range };
+
+let renderResult: RenderResult<SelectedDays>;
+function setup(dayPickerProps: DayPickerProps) {
+  const view = customRenderHook(
+    useSelectedDays,
+    dayPickerProps,
+    selectionContext
+  );
+  renderResult = view.result;
+}
+
+describe('when in single selection mode', () => {
+  const mode = 'single';
+  beforeEach(() => {
+    setup({ mode });
+  });
+  test('should return the selection from the single context', () => {
+    expect(renderResult.current).toBe(single.selected);
+  });
+});
+
+describe('when in multiple selection mode', () => {
+  const mode = 'multiple';
+  beforeEach(() => {
+    setup({ mode });
+  });
+  test('should return the selection from the multiple context', () => {
+    expect(renderResult.current).toBe(multiple.selected);
+  });
+});
+
+describe('when in range selection mode', () => {
+  const mode = 'range';
+  beforeEach(() => {
+    setup({ mode });
+  });
+  test('should return the selection from the range context', () => {
+    expect(renderResult.current).toBe(range.selected);
+  });
+});

package/src/hooks/useSelectedDays/useSelectedDays.ts

@@ -0,0 +1,32 @@
+import { useDayPicker } from 'contexts/DayPicker';
+import { useSelectMultiple } from 'contexts/SelectMultiple';
+import { useSelectRange } from 'contexts/SelectRange';
+import { useSelectSingle } from 'contexts/SelectSingle';
+import { isDayPickerMultiple } from 'types/DayPickerMultiple';
+import { isDayPickerRange } from 'types/DayPickerRange';
+import { isDayPickerSingle } from 'types/DayPickerSingle';
+import { DateRange } from 'types/Matchers';
+
+export 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.
+ */
+export function useSelectedDays(): SelectedDays {
+  const dayPicker = useDayPicker();
+  const single = useSelectSingle();
+  const multiple = useSelectMultiple();
+  const range = useSelectRange();
+
+  const selectedDays = isDayPickerSingle(dayPicker)
+    ? single.selected
+    : isDayPickerMultiple(dayPicker)
+    ? multiple.selected
+    : isDayPickerRange(dayPicker)
+    ? range.selected
+    : undefined;
+
+  return selectedDays;
+}

package/src/index.ts

@@ -0,0 +1,43 @@
+export * from './DayPicker';
+
+export * from 'components/Button';
+export * from 'components/Caption';
+export * from 'components/CaptionDropdowns';
+export * from 'components/CaptionLabel';
+export * from 'components/CaptionNavigation';
+export * from 'components/Day';
+export * from 'components/DayContent';
+export * from 'components/Dropdown';
+export * from 'components/Footer';
+export * from 'components/Head';
+export * from 'components/IconDropdown';
+export * from 'components/IconRight';
+export * from 'components/IconLeft';
+export * from 'components/Row';
+export * from 'components/WeekNumber';
+
+export * from 'hooks/useInput';
+export * from 'hooks/useDayRender';
+export * from 'hooks/useActiveModifiers';
+
+export * from 'contexts/DayPicker';
+export * from 'contexts/Focus';
+export * from 'contexts/Navigation';
+export * from 'contexts/RootProvider';
+export * from 'contexts/SelectMultiple';
+export * from 'contexts/SelectRange';
+export * from 'contexts/SelectSingle';
+
+export * from 'types/DayPickerBase';
+export * from 'types/DayPickerDefault';
+export * from 'types/DayPickerMultiple';
+export * from 'types/DayPickerRange';
+export * from 'types/DayPickerSingle';
+export * from 'types/EventHandlers';
+export * from 'types/Formatters';
+export * from 'types/Labels';
+export * from 'types/Matchers';
+export * from 'types/Modifiers';
+export * from 'types/Styles';
+
+export * from 'contexts/Modifiers/utils/isMatch';

package/src/style.css

@@ -0,0 +1,310 @@
+:root {
+  --rdp-cell-size: 40px;
+  --rdp-accent-color: #0000ff;
+  --rdp-background-color: #e7edff;
+  /* Switch to dark colors for dark themes */
+  --rdp-accent-color-dark: #3003e1;
+  --rdp-background-color-dark: #180270;
+  /* Outline border for focused elements */
+  --rdp-outline: 2px solid var(--rdp-accent-color);
+  /* Outline border for focused and selected elements */
+  --rdp-outline-selected: 2px solid rgba(0, 0, 0, 0.75);
+}
+
+.rdp {
+  margin: 1em;
+}
+
+/* Hide elements for devices that are not screen readers */
+.rdp-vhidden {
+  box-sizing: border-box;
+  padding: 0;
+  margin: 0;
+  background: transparent;
+  border: 0;
+  -moz-appearance: none;
+  -webkit-appearance: none;
+  appearance: none;
+  position: absolute !important;
+  top: 0;
+  width: 1px !important;
+  height: 1px !important;
+  padding: 0 !important;
+  overflow: hidden !important;
+  clip: rect(1px, 1px, 1px, 1px) !important;
+  border: 0 !important;
+}
+
+/* Buttons */
+.rdp-button_reset {
+  appearance: none;
+  position: relative;
+  margin: 0;
+  padding: 0;
+  cursor: default;
+  color: inherit;
+  outline: none;
+  background: none;
+  font: inherit;
+
+  -moz-appearance: none;
+  -webkit-appearance: none;
+}
+
+.rdp-button {
+  border: 2px solid transparent;
+}
+
+.rdp-button[disabled] {
+  opacity: 0.25;
+}
+
+.rdp-button:not([disabled]) {
+  cursor: pointer;
+}
+
+.rdp-button:focus:not([disabled]),
+.rdp-button:active:not([disabled]) {
+  color: inherit;
+  border: var(--rdp-outline);
+  background-color: var(--rdp-background-color);
+}
+
+.rdp-button:hover:not([disabled]) {
+  background-color: var(--rdp-background-color);
+}
+
+.rdp-months {
+  display: flex;
+}
+
+.rdp-month {
+  margin: 0 1em;
+}
+
+.rdp-month:first-child {
+  margin-left: 0;
+}
+
+.rdp-month:last-child {
+  margin-right: 0;
+}
+
+.rdp-table {
+  margin: 0;
+  max-width: calc(var(--rdp-cell-size) * 7);
+  border-collapse: collapse;
+}
+
+.rdp-with_weeknumber .rdp-table {
+  max-width: calc(var(--rdp-cell-size) * 8);
+  border-collapse: collapse;
+}
+
+.rdp-caption {
+  display: flex;
+  align-items: center;
+  justify-content: space-between;
+  padding: 0;
+  text-align: left;
+}
+
+.rdp-multiple_months .rdp-caption {
+  position: relative;
+  display: block;
+  text-align: center;
+}
+
+.rdp-caption_dropdowns {
+  position: relative;
+  display: inline-flex;
+}
+
+.rdp-caption_label {
+  position: relative;
+  z-index: 1;
+  display: inline-flex;
+  align-items: center;
+  margin: 0;
+  padding: 0 0.25em;
+  white-space: nowrap;
+  color: currentColor;
+  border: 0;
+  border: 2px solid transparent;
+  font-family: inherit;
+  font-size: 140%;
+  font-weight: bold;
+}
+
+.rdp-nav {
+  white-space: nowrap;
+}
+
+.rdp-multiple_months .rdp-caption_start .rdp-nav {
+  position: absolute;
+  top: 50%;
+  left: 0;
+  transform: translateY(-50%);
+}
+
+.rdp-multiple_months .rdp-caption_end .rdp-nav {
+  position: absolute;
+  top: 50%;
+  right: 0;
+  transform: translateY(-50%);
+}
+
+.rdp-nav_button {
+  display: inline-flex;
+  align-items: center;
+  justify-content: center;
+  width: var(--rdp-cell-size);
+  height: var(--rdp-cell-size);
+  padding: 0.25em;
+  border-radius: 100%;
+}
+
+/* ---------- */
+/* Dropdowns  */
+/* ---------- */
+
+.rdp-dropdown_year,
+.rdp-dropdown_month {
+  position: relative;
+  display: inline-flex;
+  align-items: center;
+}
+
+.rdp-dropdown {
+  appearance: none;
+  position: absolute;
+  z-index: 2;
+  top: 0;
+  bottom: 0;
+  left: 0;
+  width: 100%;
+  margin: 0;
+  padding: 0;
+  cursor: inherit;
+  opacity: 0;
+  border: none;
+  background-color: transparent;
+  font-family: inherit;
+  font-size: inherit;
+  line-height: inherit;
+}
+
+.rdp-dropdown[disabled] {
+  opacity: unset;
+  color: unset;
+}
+
+.rdp-dropdown:focus:not([disabled]) + .rdp-caption_label,
+.rdp-dropdown:active:not([disabled]) + .rdp-caption_label {
+  border: var(--rdp-outline);
+  border-radius: 6px;
+  background-color: var(--rdp-background-color);
+}
+
+.rdp-dropdown_icon {
+  margin: 0 0 0 5px;
+}
+
+.rdp-head {
+  border: 0;
+}
+
+.rdp-head_row,
+.rdp-row {
+  height: 100%;
+}
+
+.rdp-head_cell {
+  vertical-align: middle;
+  text-transform: uppercase;
+  font-size: 0.75em;
+  font-weight: 700;
+  text-align: center;
+  height: 100%;
+  height: var(--rdp-cell-size);
+  padding: 0;
+}
+
+.rdp-tbody {
+  border: 0;
+}
+
+.rdp-tfoot {
+  margin: 0.5em;
+}
+
+.rdp-cell {
+  width: var(--rdp-cell-size);
+  height: 100%;
+  height: var(--rdp-cell-size);
+  padding: 0;
+  text-align: center;
+}
+
+.rdp-weeknumber {
+  font-size: 0.75em;
+}
+
+.rdp-weeknumber,
+.rdp-day {
+  display: flex;
+  overflow: hidden;
+  align-items: center;
+  justify-content: center;
+  box-sizing: border-box;
+  width: var(--rdp-cell-size);
+  max-width: var(--rdp-cell-size);
+  height: var(--rdp-cell-size);
+  margin: 0;
+  border: 2px solid transparent;
+  border-radius: 100%;
+}
+
+.rdp-day_today:not(.rdp-day_outside) {
+  font-weight: bold;
+}
+
+.rdp-day_selected:not([disabled]),
+.rdp-day_selected:focus:not([disabled]),
+.rdp-day_selected:active:not([disabled]),
+.rdp-day_selected:hover:not([disabled]) {
+  color: white;
+  background-color: var(--rdp-accent-color);
+}
+
+.rdp-day_selected:focus:not([disabled]) {
+  border: var(--rdp-outline-selected);
+}
+
+.rdp:not([dir='rtl']) .rdp-day_range_start:not(.rdp-day_range_end) {
+  border-top-right-radius: 0;
+  border-bottom-right-radius: 0;
+}
+
+.rdp:not([dir='rtl']) .rdp-day_range_end:not(.rdp-day_range_start) {
+  border-top-left-radius: 0;
+  border-bottom-left-radius: 0;
+}
+
+.rdp[dir='rtl'] .rdp-day_range_start:not(.rdp-day_range_end) {
+  border-top-left-radius: 0;
+  border-bottom-left-radius: 0;
+}
+
+.rdp[dir='rtl'] .rdp-day_range_end:not(.rdp-day_range_start) {
+  border-top-right-radius: 0;
+  border-bottom-right-radius: 0;
+}
+
+.rdp-day_range_end.rdp-day_range_start {
+  border-radius: 100%;
+}
+
+.rdp-day_range_middle {
+  border-radius: 0;
+}

package/src/style.css.d.ts

@@ -0,0 +1,38 @@
+declare const styles: {
+  readonly rdp: string;
+  readonly 'rdp-vhidden': string;
+  readonly 'rdp-button_reset': string;
+  readonly 'rdp-button': string;
+  readonly 'rdp-months': string;
+  readonly 'rdp-month': string;
+  readonly 'rdp-table': string;
+  readonly 'rdp-with_weeknumber': string;
+  readonly 'rdp-caption': string;
+  readonly 'rdp-multiple_months': string;
+  readonly 'rdp-caption_dropdowns': string;
+  readonly 'rdp-caption_label': string;
+  readonly 'rdp-nav': string;
+  readonly 'rdp-caption_start': string;
+  readonly 'rdp-caption_end': string;
+  readonly 'rdp-nav_button': string;
+  readonly 'rdp-dropdown_year': string;
+  readonly 'rdp-dropdown_month': string;
+  readonly 'rdp-dropdown': string;
+  readonly 'rdp-dropdown_icon': string;
+  readonly 'rdp-head': string;
+  readonly 'rdp-head_row': string;
+  readonly 'rdp-row': string;
+  readonly 'rdp-head_cell': string;
+  readonly 'rdp-tbody': string;
+  readonly 'rdp-tfoot': string;
+  readonly 'rdp-cell': string;
+  readonly 'rdp-weeknumber': string;
+  readonly 'rdp-day': string;
+  readonly 'rdp-day_today': string;
+  readonly 'rdp-day_outside': string;
+  readonly 'rdp-day_selected': string;
+  readonly 'rdp-day_range_start': string;
+  readonly 'rdp-day_range_end': string;
+  readonly 'rdp-day_range_middle': string;
+};
+export = styles;