@primer/components 0.0.0-2021104155230 → 0.0.0-2021104181937

package/lib/DatePicker/useDatePicker.js

@@ -0,0 +1,561 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isSingleSelection = isSingleSelection;
+exports.isMultiSelection = isMultiSelection;
+exports.isRangeSelection = isRangeSelection;
+exports.isStringRangeSelection = isStringRangeSelection;
+exports.DatePickerProvider = exports.normalizeDate = exports.default = void 0;
+
+var _octiconsReact = require("@primer/octicons-react");
+
+var _dateFns = require("date-fns");
+
+var _esm = require("date-fns/esm");
+
+var _deepmerge = _interopRequireDefault(require("deepmerge"));
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _ = require("..");
+
+var _useResizeObserver = require("../hooks/useResizeObserver");
+
+var _dateParser = require("./dateParser");
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const DatePickerContext = /*#__PURE__*/(0, _react.createContext)(null);
+
+const useDatePicker = date => {
+  const dateCtx = (0, _react.useContext)(DatePickerContext);
+  const [selected, setSelected] = (0, _react.useState)(false);
+  const [focused, setFocused] = (0, _react.useState)(false);
+  const today = date ? (0, _dateFns.isToday)(date) : false;
+
+  if (!dateCtx) {
+    throw new Error('useDatePicker must be used inside a DatePickerProvider');
+  }
+
+  (0, _react.useEffect)(() => {
+    if (date) {
+      if (dateCtx.hoverRange) {
+        if (isRangeSelection(dateCtx.hoverRange)) {
+          if ((0, _dateFns.isEqual)(date, dateCtx.hoverRange.from)) {
+            setSelected('start');
+          } else if (dateCtx.hoverRange.to && (0, _dateFns.isEqual)(date, dateCtx.hoverRange.to)) {
+            setSelected('end');
+          } else if ((0, _dateFns.isAfter)(date, dateCtx.hoverRange.from) && dateCtx.hoverRange.to && (0, _dateFns.isBefore)(date, dateCtx.hoverRange.to)) {
+            setSelected('middle');
+          } else {
+            setSelected(false);
+          }
+        }
+      } else if (dateCtx.selection) {
+        if (isMultiSelection(dateCtx.selection)) {
+          setSelected(!!dateCtx.selection.find(d => (0, _dateFns.isEqual)(d, date)));
+        } else if (isRangeSelection(dateCtx.selection)) {
+          if ((0, _dateFns.isEqual)(date, dateCtx.selection.from)) {
+            setSelected('start');
+          } else if (dateCtx.selection.to && (0, _dateFns.isEqual)(date, dateCtx.selection.to)) {
+            setSelected('end');
+          } else if ((0, _dateFns.isAfter)(date, dateCtx.selection.from) && dateCtx.selection.to && (0, _dateFns.isBefore)(date, dateCtx.selection.to)) {
+            setSelected('middle');
+          } else {
+            setSelected(false);
+          }
+        } else {
+          setSelected((0, _dateFns.isEqual)(date, dateCtx.selection));
+        }
+      }
+    }
+  }, [date, dateCtx.hoverRange, dateCtx.selection, today]);
+  (0, _react.useEffect)(() => {
+    if (date) {
+      // Determine if date is focused
+      setFocused((0, _dateFns.isEqual)(dateCtx.focusDate, date));
+    }
+  }, [date, dateCtx.focusDate]);
+  let blocked,
+      disabled = false;
+
+  if (date) {
+    // Determine if date is blocked out
+    if (dateCtx.configuration.blockedDates) {
+      blocked = !!dateCtx.configuration.blockedDates.find(d => (0, _dateFns.isEqual)(d, date));
+    } // Determine if date is disabled
+
+
+    if (dateCtx.configuration.minDate || dateCtx.configuration.maxDate || dateCtx.configuration.disableWeekends) {
+      disabled = (dateCtx.configuration.minDate ? (0, _dateFns.isBefore)(date, dateCtx.configuration.minDate) : false) || (dateCtx.configuration.maxDate ? (0, _dateFns.isAfter)(date, dateCtx.configuration.maxDate) : false) || (dateCtx.configuration.disableWeekends ? (0, _dateFns.isWeekend)(date) : false);
+    }
+  }
+
+  return { ...dateCtx,
+    blocked,
+    disabled,
+    focused,
+    selected,
+    today
+  };
+};
+
+var _default = useDatePicker;
+exports.default = _default;
+
+function isSingleSelection(selection) {
+  return selection instanceof Date;
+}
+
+function isMultiSelection(selection) {
+  return Array.isArray(selection);
+}
+
+function isRangeSelection(selection) {
+  return !!selection.from;
+}
+
+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(normalizeDate(d));
+      }
+
+      return parsedSelection.sort((a, b) => a.getTime() - b.getTime());
+    } else if (selection instanceof Date) {
+      return [normalizeDate(selection)];
+    } else if (isRangeSelection(selection)) {
+      const parsedSelection = [];
+      parsedSelection.push(normalizeDate(selection.from));
+
+      if (selection.to) {
+        parsedSelection.push(normalizeDate(selection.to));
+      }
+
+      return parsedSelection.sort((a, b) => a.getTime() - b.getTime());
+    }
+  } else if (variant === 'range') {
+    if (isRangeSelection(selection)) {
+      return {
+        from: normalizeDate(selection.from),
+        to: selection.to ? normalizeDate(selection.to) : null
+      };
+    } else if (isMultiSelection(selection)) {
+      return {
+        from: normalizeDate(selection[0]),
+        to: selection[1] ? normalizeDate(selection[1]) : null
+      };
+    } else if (selection instanceof Date) {
+      return {
+        from: normalizeDate(selection),
+        to: null
+      };
+    }
+  } else {
+    if (selection instanceof Date) {
+      return normalizeDate(selection);
+    } else if (isMultiSelection(selection)) {
+      return normalizeDate(selection[0]);
+    } else if (isRangeSelection(selection)) {
+      return normalizeDate(selection.from);
+    } else {
+      return;
+    }
+  }
+}
+
+const getInitialFocusDate = selection => {
+  if (!selection) return normalizeDate(new Date());
+
+  if (selection instanceof Date) {
+    return normalizeDate(selection);
+  } else if (Array.isArray(selection)) {
+    return normalizeDate(selection[0]);
+  } else if (isRangeSelection(selection)) {
+    return normalizeDate(selection.from);
+  } else {
+    return normalizeDate(new Date());
+  }
+};
+
+const normalizeDate = date => new Date(new Date(date).toDateString());
+
+exports.normalizeDate = normalizeDate;
+const defaultConfiguration = {
+  anchorVariant: 'button',
+  confirmation: false,
+  confirmUnsavedClose: false,
+  compressedHeader: false,
+  disableWeekends: false,
+  iconPlacement: 'start',
+  placeholder: 'Choose Date...',
+  showInputPrompt: false,
+  variant: 'single',
+  view: '1-month',
+  weekStartsOn: 'Sunday'
+};
+
+const DatePickerProvider = ({
+  configuration: externalConfig = {},
+  children,
+  closePicker,
+  value
+}) => {
+  const [configuration, setConfiguration] = (0, _react.useState)((0, _deepmerge.default)(defaultConfiguration, externalConfig));
+  const initialSelection = parseSelection(value, configuration.variant);
+  const [previousSelection, setPreviousSelection] = (0, _react.useState)(parseSelection(value, configuration.variant));
+  const [isDirty, setIsDirty] = (0, _react.useState)(false);
+  const [selection, setSelection] = (0, _react.useState)(initialSelection);
+  const [hoverRange, setHoverRange] = (0, _react.useState)(null);
+  const [currentViewingDate, setCurrentViewingDate] = (0, _react.useState)(getInitialFocusDate(initialSelection));
+  const [multiMonthSupport, setMultiMonthSupport] = (0, _react.useState)(true);
+  const confirm = (0, _.useConfirm)();
+  const [dialogOpen, setDialogOpen] = (0, _react.useState)(false);
+  const [focusDate, setFocusDate] = (0, _react.useState)(getInitialFocusDate(initialSelection));
+  (0, _react.useEffect)(() => {
+    setConfiguration((0, _deepmerge.default)(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 = (0, _react.useCallback)(date => {
+    let newDate = date;
+    const {
+      minDate,
+      maxDate
+    } = configuration;
+
+    if (minDate && (0, _dateFns.isBefore)(date, minDate)) {
+      newDate = minDate;
+    } else if (maxDate && (0, _dateFns.isAfter)(date, maxDate)) {
+      newDate = maxDate;
+    }
+
+    setFocusDate(normalizeDate(newDate));
+    setCurrentViewingDate(normalizeDate(newDate));
+  }, [configuration]);
+  const nextMonth = (0, _react.useCallback)(() => {
+    const date = (0, _dateFns.addMonths)(currentViewingDate, 1);
+    setFocusDate(normalizeDate(date));
+    setCurrentViewingDate(date);
+  }, [currentViewingDate]);
+  const previousMonth = (0, _react.useCallback)(() => {
+    const date = (0, _dateFns.subMonths)(currentViewingDate, 1);
+    setFocusDate(normalizeDate(date));
+    setCurrentViewingDate(date);
+  }, [currentViewingDate]);
+  const formattedDate = (0, _react.useMemo)(() => {
+    const {
+      anchorVariant,
+      dateFormat,
+      placeholder,
+      variant
+    } = configuration;
+    return (0, _dateParser.formatDate)({
+      selection,
+      anchorVariant,
+      dateFormat,
+      placeholder,
+      rawFormat: false,
+      variant
+    });
+  }, [configuration, selection]);
+  const inputDate = (0, _react.useMemo)(() => {
+    const {
+      dateFormat,
+      placeholder,
+      variant
+    } = configuration;
+    return (0, _dateParser.formatDate)({
+      selection,
+      dateFormat,
+      placeholder,
+      rawFormat: true,
+      variant
+    });
+  }, [configuration, selection]);
+  const saveValue = (0, _react.useCallback)(updatedSelection => {
+    setPreviousSelection(updatedSelection !== null && updatedSelection !== void 0 ? updatedSelection : selection);
+    setIsDirty(false);
+    closePicker === null || closePicker === void 0 ? void 0 : closePicker();
+  }, [closePicker, selection]);
+  const revertValue = (0, _react.useCallback)(() => {
+    setSelection(previousSelection);
+    setIsDirty(false);
+  }, [previousSelection]);
+  const handleClose = (0, _react.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.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement(_octiconsReact.CheckIcon, null), /*#__PURE__*/_react.default.createElement(_.Text, {
+            sx: {
+              ml: 1
+            }
+          }, "Save")),
+          cancelButtonContent: /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement(_octiconsReact.TrashIcon, null), /*#__PURE__*/_react.default.createElement(_.Text, {
+            sx: {
+              ml: 1
+            }
+          }, "Discard"))
+        });
+
+        if (result) {
+          saveValue();
+        } else {
+          revertValue();
+        }
+      }
+    } else if (isDirty) revertValue();
+  }, [configuration.confirmUnsavedClose, confirm, isDirty, revertValue, saveValue]);
+  const inputHandler = (0, _react.useCallback)(updatedSelection => {
+    if (!updatedSelection) return;
+    const {
+      maxDate,
+      minDate,
+      variant,
+      maxSelections,
+      maxRangeSize
+    } = configuration;
+
+    switch (variant) {
+      case 'single':
+        {
+          if (updatedSelection instanceof Date) {
+            if (maxDate && (0, _dateFns.isAfter)(updatedSelection, maxDate)) {
+              setSelection(maxDate);
+            } else if (minDate && (0, _dateFns.isBefore)(minDate, updatedSelection)) {
+              setSelection(minDate);
+            } else {
+              setSelection(updatedSelection);
+            }
+          }
+
+          break;
+        }
+
+      case 'multi':
+        {
+          if (Array.isArray(updatedSelection)) {
+            let validSelections = updatedSelection.filter(d => (maxDate ? (0, _dateFns.isBefore)(d, maxDate) : true) && (minDate ? (0, _dateFns.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 = (0, _dateFns.isAfter)(updatedSelection.from, minDate) ? updatedSelection.from : minDate;
+
+              if (updatedSelection.to) {
+                validRange.to = (0, _dateFns.isAfter)(updatedSelection.to, minDate) ? updatedSelection.to : minDate;
+              }
+            }
+
+            if (maxDate) {
+              validRange.from = (0, _dateFns.isBefore)(updatedSelection.from, maxDate) ? updatedSelection.from : maxDate;
+
+              if (updatedSelection.to) {
+                validRange.to = (0, _dateFns.isBefore)(updatedSelection.to, maxDate) ? updatedSelection.to : maxDate;
+              }
+            }
+
+            if (maxRangeSize && validRange.to && Math.abs((0, _dateFns.differenceInDays)(validRange.from, validRange.to)) >= maxRangeSize) {
+              validRange.to = (0, _dateFns.addDays)(validRange.from, maxRangeSize - 1);
+            }
+
+            setSelection(updatedSelection);
+          }
+
+          break;
+        }
+    }
+  }, [configuration]);
+  (0, _react.useEffect)(() => {
+    setFocusDate(getInitialFocusDate(selection));
+  }, [selection]);
+  (0, _react.useEffect)(() => {
+    if (configuration.view === '1-month' || !multiMonthSupport) {
+      if (currentViewingDate.getMonth() === focusDate.getMonth() && currentViewingDate.getFullYear() === focusDate.getFullYear()) {
+        return;
+      } else {
+        setCurrentViewingDate((0, _dateFns.setDate)(focusDate, 1));
+        return;
+      }
+    }
+    /**
+     * This logic is rough, so buckle up.
+     * We want to set the currently shown months based on what has focus. If the focus leaves what we're able to view,
+     * we want to be able to change the currently shown month. However, this gets complicated with the 2-month view.
+     * FIRST: If it's the same month/year: Easy
+     * SECOND: If it's the next month, but same year: Done
+     * THIRD: If it's the next month AND next year, but it's January (i.e. we're viewing Dec/Jan): Good to go
+     */
+
+
+    if (currentViewingDate.getMonth() === focusDate.getMonth() && currentViewingDate.getFullYear() === focusDate.getFullYear() || (0, _dateFns.addMonths)(currentViewingDate, 1).getMonth() === focusDate.getMonth() && currentViewingDate.getFullYear() === focusDate.getFullYear() || (0, _dateFns.addMonths)(currentViewingDate, 1).getMonth() === focusDate.getMonth() && focusDate.getMonth() === 0 && (0, _dateFns.addYears)(currentViewingDate, 1).getFullYear() === focusDate.getFullYear()) {
+      return;
+    } else {
+      setCurrentViewingDate((0, _dateFns.setDate)(focusDate, 1));
+    }
+  }, [configuration.view, currentViewingDate, focusDate, multiMonthSupport]);
+  const selectionHandler = (0, _react.useCallback)(date => {
+    setIsDirty(true);
+
+    if (configuration.variant === 'multi') {
+      const selections = Array.isArray(selection) ? selection : [];
+      const existingIndex = selections.findIndex(s => (0, _dateFns.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((0, _dateFns.differenceInDays)(selection.from, date)) >= configuration.maxRangeSize) {
+          toDate = (0, _dateFns.isBefore)(date, selection.from) ? (0, _dateFns.subDays)(selection.from, configuration.maxRangeSize - 1) : (0, _dateFns.addDays)(selection.from, configuration.maxRangeSize - 1);
+        }
+
+        const updatedSelection = (0, _dateFns.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 focusHandler = (0, _react.useCallback)(date => {
+    if (!selection) return;
+    const {
+      minDate,
+      maxDate,
+      maxRangeSize,
+      disableWeekends,
+      variant
+    } = configuration;
+
+    if (variant === 'range' && isRangeSelection(selection) && hoverRange) {
+      let hoverDate = date;
+      if (minDate) hoverDate = (0, _dateFns.isBefore)(date, minDate) ? minDate : hoverDate;
+      if (maxDate) hoverDate = (0, _dateFns.isAfter)(date, maxDate) ? maxDate : hoverDate;
+      const daysInRange = disableWeekends ? Math.abs((0, _dateFns.differenceInBusinessDays)(selection.from, hoverDate)) : Math.abs((0, _dateFns.differenceInDays)(selection.from, hoverDate));
+
+      if (maxRangeSize && daysInRange >= maxRangeSize) {
+        if (disableWeekends) {
+          hoverDate = (0, _dateFns.isBefore)(hoverDate, selection.from) ? (0, _esm.subBusinessDays)(selection.from, configuration.maxRangeSize - 1) : (0, _esm.addBusinessDays)(selection.from, configuration.maxRangeSize - 1);
+        } else {
+          hoverDate = (0, _dateFns.isBefore)(hoverDate, selection.from) ? (0, _dateFns.subDays)(selection.from, configuration.maxRangeSize - 1) : (0, _dateFns.addDays)(selection.from, configuration.maxRangeSize - 1);
+        }
+      }
+
+      if (disableWeekends && (0, _dateFns.isWeekend)(hoverDate)) {
+        hoverDate = (0, _dateFns.previousFriday)(hoverDate);
+      }
+
+      setHoverRange((0, _dateFns.isBefore)(hoverDate, selection.from) ? {
+        from: hoverDate,
+        to: selection.from
+      } : {
+        from: selection.from,
+        to: hoverDate
+      });
+    }
+  }, [configuration, hoverRange, selection]);
+
+  const onResize = windowEntry => {
+    // Only care about the first element, we expect one element ot be watched
+    const {
+      width
+    } = windowEntry.contentRect; // 610 is the panel width with 2 months
+
+    setMultiMonthSupport(width > 610);
+  };
+
+  (0, _useResizeObserver.useResizeObserver)(onResize);
+  const datePickerCtx = (0, _react.useMemo)(() => {
+    return {
+      configuration,
+      currentViewingDate,
+      disabled: false,
+      focusDate,
+      formattedDate,
+      inputDate,
+      goToMonth,
+      hoverRange,
+      dialogOpen,
+      nextMonth,
+      onClose: handleClose,
+      onDateInput: inputHandler,
+      onDayFocus: focusHandler,
+      onSelection: selectionHandler,
+      previousMonth,
+      revertValue,
+      saveValue,
+      selectionActive: false,
+      setFocusDate,
+      setHoverRange,
+      selection,
+      setDialogOpen,
+      viewMode: configuration.view === '2-month' && multiMonthSupport ? '2-month' : '1-month'
+    };
+  }, [configuration, currentViewingDate, dialogOpen, focusDate, focusHandler, formattedDate, goToMonth, handleClose, hoverRange, inputDate, inputHandler, multiMonthSupport, nextMonth, previousMonth, revertValue, saveValue, selection, selectionHandler]);
+  return /*#__PURE__*/_react.default.createElement(DatePickerContext.Provider, {
+    value: datePickerCtx
+  }, children);
+};
+
+exports.DatePickerProvider = DatePickerProvider;
+DatePickerProvider.displayName = "DatePickerProvider";