@primer/components 0.0.0-2021929153151 → 0.0.0-202192923313

package/lib-esm/DatePicker/useDatePicker.d.ts

@@ -0,0 +1,89 @@
+import React from 'react';
+export declare type AnchorVariant = 'input' | 'button' | 'icon-only';
+export declare type DateFormat = 'short' | 'long' | string;
+export declare type SelectionVariant = 'single' | 'multi' | 'range';
+export interface DatePickerConfiguration {
+    anchorVariant?: AnchorVariant;
+    blockedDates?: Array<Date>;
+    confirmation?: boolean;
+    confirmUnsavedClose?: boolean;
+    dateFormat?: DateFormat;
+    disableWeekends?: boolean;
+    iconPlacement?: 'start' | 'end' | 'none';
+    maxDate?: Date | null;
+    maxSelections?: number;
+    maxRangeSize?: number;
+    minDate?: Date | null;
+    placeholder?: string;
+    rangeIncrement?: number;
+    showInputPrompt?: boolean;
+    variant?: SelectionVariant;
+    view?: '1-month' | '2-month';
+    weekStartsOn?: 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday';
+}
+export declare type RangeSelection = {
+    from: Date;
+    to: Date | null;
+};
+export declare type StringRangeSelection = {
+    from: string;
+    to: string;
+};
+export interface DatePickerContext {
+    disabled?: boolean;
+    configuration: DatePickerConfiguration;
+    currentViewingDate: Date;
+    goToMonth: (date: Date) => void;
+    hoverRange?: RangeSelection | null;
+    selection?: Selection;
+    softSelection?: Partial<RangeSelection> | null;
+    selectionActive?: boolean;
+    formattedDate: string;
+    nextMonth: () => void;
+    onClose: () => void;
+    onDateInput: (updatedSelection: Selection) => void;
+    onDayFocus: (date: Date) => void;
+    onSelection: (date: Date) => void;
+    previousMonth: () => void;
+    revertValue: () => void;
+    saveValue: (selection?: Selection) => void;
+}
+export declare type Selection = Date | Array<Date> | RangeSelection | null;
+export declare type StringSelection = string | Array<string> | {
+    to: string;
+    from: string;
+} | null;
+export declare type DaySelection = boolean | 'start' | 'middle' | 'end';
+declare const useDatePicker: (date?: Date | undefined) => {
+    blocked: boolean | undefined;
+    disabled: boolean;
+    selected: DaySelection;
+    today: boolean;
+    configuration: DatePickerConfiguration;
+    currentViewingDate: Date;
+    goToMonth: (date: Date) => void;
+    hoverRange?: RangeSelection | null | undefined;
+    selection?: Selection | undefined;
+    softSelection?: Partial<RangeSelection> | null | undefined;
+    selectionActive?: boolean | undefined;
+    formattedDate: string;
+    nextMonth: () => void;
+    onClose: () => void;
+    onDateInput: (updatedSelection: Selection) => void;
+    onDayFocus: (date: Date) => void;
+    onSelection: (date: Date) => void;
+    previousMonth: () => void;
+    revertValue: () => void;
+    saveValue: (selection?: Selection | undefined) => void;
+};
+export default useDatePicker;
+export interface DatePickerProviderProps {
+    closePicker?: () => void;
+    configuration?: DatePickerConfiguration;
+    value?: Selection | StringSelection;
+}
+export declare function isSingleSelection(selection: Selection): selection is Date;
+export declare function isMultiSelection(selection: Selection | StringSelection): selection is Array<Date> | Array<string>;
+export declare function isRangeSelection(selection: Selection | StringSelection): selection is RangeSelection | StringRangeSelection;
+export declare function isStringRangeSelection(selection: StringSelection): selection is StringRangeSelection;
+export declare const DatePickerProvider: React.FC<DatePickerProviderProps>;

package/lib-esm/DatePicker/useDatePicker.js

@@ -0,0 +1,408 @@
+import { CheckIcon, TrashIcon } from '@primer/octicons-react';
+import { isEqual, isAfter, isBefore, addMonths, subMonths, isToday, isWeekend, differenceInDays, addDays, subDays } from 'date-fns';
+import deepmerge from 'deepmerge';
+import React, { createContext, useCallback, useContext, useMemo, useEffect, useState } from 'react';
+import { Text, useConfirm } from '..';
+import { formatDate } from './dateParser';
+const DatePickerContext = /*#__PURE__*/createContext(null);
+
+const useDatePicker = date => {
+  const value = useContext(DatePickerContext);
+  const [selected, setSelected] = useState(false);
+  const today = date ? isToday(date) : false;
+
+  if (!value) {
+    throw new Error('useDatePicker must be used inside a DatePickerProvider');
+  }
+
+  useEffect(() => {
+    if (date) {
+      if (value.hoverRange) {
+        if (isRangeSelection(value.hoverRange)) {
+          if (isEqual(date, value.hoverRange.from)) {
+            setSelected('start');
+          } else if (value.hoverRange.to && isEqual(date, value.hoverRange.to)) {
+            setSelected('end');
+          } else if (isAfter(date, value.hoverRange.from) && value.hoverRange.to && isBefore(date, value.hoverRange.to)) {
+            setSelected('middle');
+          } else {
+            setSelected(false);
+          }
+        }
+      } else if (value.selection) {
+        if (isMultiSelection(value.selection)) {
+          setSelected(!!value.selection.find(d => isEqual(d, date)));
+        } else if (isRangeSelection(value.selection)) {
+          if (isEqual(date, value.selection.from)) {
+            setSelected('start');
+          } else if (value.selection.to && isEqual(date, value.selection.to)) {
+            setSelected('end');
+          } else if (isAfter(date, value.selection.from) && value.selection.to && isBefore(date, value.selection.to)) {
+            setSelected('middle');
+          } else {
+            setSelected(false);
+          }
+        } else {
+          setSelected(isEqual(date, value.selection));
+        }
+      }
+    }
+  }, [date, value.hoverRange, value.selection, today]);
+  let blocked,
+      disabled = false;
+
+  if (date) {
+    // Determine if date is blocked out
+    if (value.configuration.blockedDates) {
+      blocked = !!value.configuration.blockedDates.find(d => isEqual(d, date));
+    } // Determine if date is disabled
+
+
+    if (value.configuration.minDate || value.configuration.maxDate || value.configuration.disableWeekends) {
+      disabled = (value.configuration.minDate ? isBefore(date, value.configuration.minDate) : false) || (value.configuration.maxDate ? isAfter(date, value.configuration.maxDate) : false) || (value.configuration.disableWeekends ? isWeekend(date) : false);
+    }
+  }
+
+  return { ...value,
+    blocked,
+    disabled,
+    selected,
+    today
+  };
+};
+
+export default useDatePicker;
+export function isSingleSelection(selection) {
+  return selection instanceof Date;
+}
+export function isMultiSelection(selection) {
+  return Array.isArray(selection);
+}
+export function isRangeSelection(selection) {
+  return !!selection.from;
+}
+export function isStringRangeSelection(selection) {
+  return !!selection.from;
+}
+
+function parseSelection(selection, variant) {
+  if (!selection) return;
+
+  if (variant === 'multi') {
+    if (isMultiSelection(selection)) {
+      const parsedSelection = [];
+
+      for (const d of selection) {
+        parsedSelection.push(new Date(new Date(d).toDateString()));
+      }
+
+      return parsedSelection.sort((a, b) => a.getTime() - b.getTime());
+    } else if (selection instanceof Date) {
+      return [new Date(new Date(selection).toDateString())];
+    } else if (isRangeSelection(selection)) {
+      const parsedSelection = [];
+      parsedSelection.push(new Date(new Date(selection.from).toDateString()));
+
+      if (selection.to) {
+        parsedSelection.push(new Date(new Date(selection.to).toDateString()));
+      }
+
+      return parsedSelection.sort((a, b) => a.getTime() - b.getTime());
+    }
+  } else if (variant === 'range') {
+    if (isRangeSelection(selection)) {
+      return {
+        from: new Date(new Date(selection.from).toDateString()),
+        to: selection.to ? new Date(new Date(selection.to).toDateString()) : null
+      };
+    } else if (isMultiSelection(selection)) {
+      return {
+        from: new Date(new Date(selection[0]).toDateString()),
+        to: selection[1] ? new Date(new Date(selection[1]).toDateString()) : null
+      };
+    } else if (selection instanceof Date) {
+      return {
+        from: new Date(new Date(selection).toDateString()),
+        to: null
+      };
+    }
+  } else {
+    if (selection instanceof Date) {
+      return new Date(new Date(selection).toDateString());
+    } else if (isMultiSelection(selection)) {
+      return new Date(new Date(selection[0]).toDateString());
+    } else if (isRangeSelection(selection)) {
+      return new Date(new Date(selection.from).toDateString());
+    } else {
+      return;
+    }
+  }
+}
+
+const defaultConfiguration = {
+  anchorVariant: 'button',
+  confirmation: false,
+  confirmUnsavedClose: false,
+  disableWeekends: false,
+  iconPlacement: 'start',
+  placeholder: 'Select a Date...',
+  showInputPrompt: false,
+  variant: 'single',
+  view: '2-month',
+  weekStartsOn: 'Sunday'
+};
+export const DatePickerProvider = ({
+  configuration: externalConfig = {},
+  children,
+  closePicker,
+  value
+}) => {
+  const [configuration, setConfiguration] = useState(deepmerge(defaultConfiguration, externalConfig));
+  const [previousSelection, setPreviousSelection] = useState(parseSelection(value, configuration.variant));
+  const [isDirty, setIsDirty] = useState(false);
+  const [selection, setSelection] = useState(parseSelection(value, configuration.variant));
+  const [hoverRange, setHoverRange] = useState(null);
+  const [currentViewingDate, setCurrentViewingDate] = useState(new Date());
+  const confirm = useConfirm();
+  useEffect(() => {
+    setConfiguration(deepmerge(defaultConfiguration, externalConfig));
+    setSelection(parseSelection(selection, configuration.variant)); // Don't want this to run every time selection gets updated
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [configuration.variant, externalConfig]);
+  const goToMonth = useCallback(date => {
+    setCurrentViewingDate(new Date(new Date(date).toDateString()));
+  }, []);
+  const nextMonth = useCallback(() => {
+    setCurrentViewingDate(addMonths(currentViewingDate, 1));
+  }, [currentViewingDate]);
+  const previousMonth = useCallback(() => {
+    setCurrentViewingDate(subMonths(currentViewingDate, 1));
+  }, [currentViewingDate]);
+  const getFormattedDate = useMemo(() => {
+    const {
+      anchorVariant,
+      dateFormat,
+      placeholder,
+      variant
+    } = configuration;
+    return formatDate({
+      selection,
+      anchorVariant,
+      dateFormat,
+      placeholder,
+      variant
+    });
+  }, [configuration, selection]);
+  const saveValue = useCallback(updatedSelection => {
+    setPreviousSelection(updatedSelection !== null && updatedSelection !== void 0 ? updatedSelection : selection);
+    setIsDirty(false);
+    closePicker === null || closePicker === void 0 ? void 0 : closePicker();
+  }, [closePicker, selection]);
+  const revertValue = useCallback(() => {
+    setSelection(previousSelection);
+    setIsDirty(false);
+  }, [previousSelection]);
+  const handleClose = useCallback(async () => {
+    if (configuration.confirmUnsavedClose) {
+      if (isDirty) {
+        const result = await confirm({
+          title: 'Save Changes?',
+          content: 'You have unsaved changes, would you like to save them?',
+          confirmButtonContent: /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(CheckIcon, null), /*#__PURE__*/React.createElement(Text, {
+            sx: {
+              ml: 1
+            }
+          }, "Save")),
+          cancelButtonContent: /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(TrashIcon, null), /*#__PURE__*/React.createElement(Text, {
+            sx: {
+              ml: 1
+            }
+          }, "Discard"))
+        });
+
+        if (result) {
+          saveValue();
+        } else {
+          revertValue();
+        }
+      }
+    } else if (isDirty) revertValue();
+  }, [configuration.confirmUnsavedClose, confirm, isDirty, revertValue, saveValue]);
+  const inputHandler = useCallback(updatedSelection => {
+    if (!updatedSelection) return;
+    const {
+      maxDate,
+      minDate,
+      variant,
+      maxSelections,
+      maxRangeSize
+    } = configuration;
+
+    switch (variant) {
+      case 'single':
+        {
+          if (updatedSelection instanceof Date) {
+            if (maxDate && isAfter(updatedSelection, maxDate)) {
+              setSelection(maxDate);
+            } else if (minDate && isBefore(minDate, updatedSelection)) {
+              setSelection(minDate);
+            } else {
+              setSelection(updatedSelection);
+            }
+          }
+
+          break;
+        }
+
+      case 'multi':
+        {
+          if (Array.isArray(updatedSelection)) {
+            let validSelections = updatedSelection.filter(d => (maxDate ? isBefore(d, maxDate) : true) && (minDate ? isAfter(d, minDate) : true));
+
+            if (maxSelections) {
+              validSelections = validSelections.slice(0, maxSelections);
+            }
+
+            setSelection(validSelections);
+          }
+
+          break;
+        }
+
+      case 'range':
+        {
+          if (isRangeSelection(updatedSelection)) {
+            const validRange = updatedSelection;
+
+            if (minDate) {
+              validRange.from = isAfter(updatedSelection.from, minDate) ? updatedSelection.from : minDate;
+
+              if (updatedSelection.to) {
+                validRange.to = isAfter(updatedSelection.to, minDate) ? updatedSelection.to : minDate;
+              }
+            }
+
+            if (maxDate) {
+              validRange.from = isBefore(updatedSelection.from, maxDate) ? updatedSelection.from : maxDate;
+
+              if (updatedSelection.to) {
+                validRange.to = isBefore(updatedSelection.to, maxDate) ? updatedSelection.to : maxDate;
+              }
+            }
+
+            if (maxRangeSize && validRange.to && Math.abs(differenceInDays(validRange.from, validRange.to)) >= maxRangeSize) {
+              validRange.to = addDays(validRange.from, maxRangeSize - 1);
+            }
+
+            setSelection(updatedSelection);
+          }
+
+          break;
+        }
+    }
+  }, [configuration]);
+  const selectionHandler = useCallback(date => {
+    setIsDirty(true);
+
+    if (configuration.variant === 'multi') {
+      const selections = [...selection];
+      const existingIndex = selections.findIndex(s => isEqual(s, date));
+
+      if (existingIndex > -1) {
+        selections.splice(existingIndex, 1);
+        setSelection(selections.sort((a, b) => a.getTime() - b.getTime()));
+      } else {
+        if (configuration.maxSelections && selections.length + 1 > configuration.maxSelections) return;
+        setSelection([...selections, date].sort((a, b) => a.getTime() - b.getTime()));
+      }
+    } else if (configuration.variant === 'range') {
+      if (selection && isRangeSelection(selection) && !selection.to) {
+        let toDate = date;
+
+        if (configuration.maxRangeSize && Math.abs(differenceInDays(selection.from, date)) >= configuration.maxRangeSize) {
+          toDate = isBefore(date, selection.from) ? subDays(selection.from, configuration.maxRangeSize - 1) : addDays(selection.from, configuration.maxRangeSize - 1);
+        }
+
+        const updatedSelection = isBefore(toDate, selection.from) ? {
+          from: toDate,
+          to: selection.from
+        } : {
+          from: selection.from,
+          to: toDate
+        };
+        setSelection(updatedSelection);
+        setHoverRange(null);
+
+        if (!configuration.confirmation) {
+          saveValue(updatedSelection);
+        }
+      } else {
+        setHoverRange({
+          from: date,
+          to: date
+        });
+        setSelection({
+          from: date,
+          to: null
+        });
+      }
+    } else {
+      setSelection(date);
+
+      if (!configuration.confirmation) {
+        saveValue(date);
+      }
+    }
+  }, [configuration.confirmation, configuration.maxRangeSize, configuration.maxSelections, configuration.variant, saveValue, selection]);
+  const focusHnadler = useCallback(date => {
+    if (!selection) return;
+    const {
+      minDate,
+      maxDate,
+      maxRangeSize,
+      variant
+    } = configuration;
+
+    if (variant === 'range' && isRangeSelection(selection) && hoverRange) {
+      let hoverDate = date;
+      if (minDate) hoverDate = isBefore(date, minDate) ? minDate : hoverDate;
+      if (maxDate) hoverDate = isAfter(date, maxDate) ? maxDate : hoverDate;
+
+      if (maxRangeSize && Math.abs(differenceInDays(selection.from, hoverDate)) >= maxRangeSize) {
+        hoverDate = isBefore(hoverDate, selection.from) ? subDays(selection.from, configuration.maxRangeSize - 1) : addDays(selection.from, configuration.maxRangeSize - 1);
+      }
+
+      setHoverRange(isBefore(hoverDate, selection.from) ? {
+        from: hoverDate,
+        to: selection.from
+      } : {
+        from: selection.from,
+        to: hoverDate
+      });
+    }
+  }, [configuration, hoverRange, selection]);
+  const datePickerCtx = useMemo(() => {
+    return {
+      configuration,
+      currentViewingDate,
+      disabled: false,
+      formattedDate: getFormattedDate,
+      goToMonth,
+      hoverRange,
+      nextMonth,
+      onClose: handleClose,
+      onDateInput: inputHandler,
+      onDayFocus: focusHnadler,
+      onSelection: selectionHandler,
+      previousMonth,
+      revertValue,
+      saveValue,
+      selectionActive: false,
+      selection
+    };
+  }, [configuration, currentViewingDate, focusHnadler, getFormattedDate, goToMonth, handleClose, hoverRange, inputHandler, nextMonth, previousMonth, revertValue, saveValue, selection, selectionHandler]);
+  return /*#__PURE__*/React.createElement(DatePickerContext.Provider, {
+    value: datePickerCtx
+  }, children);
+};
+DatePickerProvider.displayName = "DatePickerProvider";