@mui/x-date-pickers 6.2.0 → 6.3.0

package/legacy/MultiSectionDigitalClock/MultiSectionDigitalClock.js

@@ -0,0 +1,508 @@
+import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
+import _toConsumableArray from "@babel/runtime/helpers/esm/toConsumableArray";
+import _slicedToArray from "@babel/runtime/helpers/esm/slicedToArray";
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
+var _excluded = ["ampm", "timeSteps", "autoFocus", "components", "componentsProps", "slots", "slotProps", "value", "disableIgnoringDatePartForTimeValidation", "maxTime", "minTime", "disableFuture", "disablePast", "minutesStep", "shouldDisableClock", "shouldDisableTime", "onChange", "defaultValue", "view", "views", "openTo", "onViewChange", "focusedView", "onFocusedViewChange", "className", "disabled", "readOnly", "skipDisabled"];
+import * as React from 'react';
+import clsx from 'clsx';
+import PropTypes from 'prop-types';
+import { styled, useThemeProps } from '@mui/material/styles';
+import useEventCallback from '@mui/utils/useEventCallback';
+import composeClasses from '@mui/utils/composeClasses';
+import useControlled from '@mui/utils/useControlled';
+import { useUtils, useNow, useLocaleText } from '../internals/hooks/useUtils';
+import { convertValueToMeridiem, createIsAfterIgnoreDatePart } from '../internals/utils/time-utils';
+import { useViews } from '../internals/hooks/useViews';
+import { useMeridiemMode } from '../internals/hooks/date-helpers-hooks';
+import { PickerViewRoot } from '../internals/components/PickerViewRoot';
+import { getMultiSectionDigitalClockUtilityClass } from './multiSectionDigitalClockClasses';
+import { MultiSectionDigitalClockSection } from './MultiSectionDigitalClockSection';
+import { getHourSectionOptions, getTimeSectionOptions } from './MultiSectionDigitalClock.utils';
+import { jsx as _jsx } from "react/jsx-runtime";
+var useUtilityClasses = function useUtilityClasses(ownerState) {
+  var classes = ownerState.classes;
+  var slots = {
+    root: ['root']
+  };
+  return composeClasses(slots, getMultiSectionDigitalClockUtilityClass, classes);
+};
+var MultiSectionDigitalClockRoot = styled(PickerViewRoot, {
+  name: 'MuiMultiSectionDigitalClock',
+  slot: 'Root',
+  overridesResolver: function overridesResolver(_, styles) {
+    return styles.root;
+  }
+})(function (_ref) {
+  var theme = _ref.theme;
+  return {
+    display: 'flex',
+    flexDirection: 'row',
+    width: '100%',
+    borderBottom: "1px solid ".concat((theme.vars || theme).palette.divider)
+  };
+});
+export var MultiSectionDigitalClock = /*#__PURE__*/React.forwardRef(function MultiSectionDigitalClock(inProps, ref) {
+  var now = useNow();
+  var utils = useUtils();
+  var localeText = useLocaleText();
+  var props = useThemeProps({
+    props: inProps,
+    name: 'MuiMultiSectionDigitalClock'
+  });
+  var _props$ampm = props.ampm,
+    ampm = _props$ampm === void 0 ? utils.is12HourCycleInCurrentLocale() : _props$ampm,
+    inTimeSteps = props.timeSteps,
+    autoFocus = props.autoFocus,
+    components = props.components,
+    componentsProps = props.componentsProps,
+    slots = props.slots,
+    slotProps = props.slotProps,
+    valueProp = props.value,
+    _props$disableIgnorin = props.disableIgnoringDatePartForTimeValidation,
+    disableIgnoringDatePartForTimeValidation = _props$disableIgnorin === void 0 ? false : _props$disableIgnorin,
+    maxTime = props.maxTime,
+    minTime = props.minTime,
+    disableFuture = props.disableFuture,
+    disablePast = props.disablePast,
+    _props$minutesStep = props.minutesStep,
+    minutesStep = _props$minutesStep === void 0 ? 1 : _props$minutesStep,
+    shouldDisableClock = props.shouldDisableClock,
+    shouldDisableTime = props.shouldDisableTime,
+    onChange = props.onChange,
+    defaultValue = props.defaultValue,
+    inView = props.view,
+    _props$views = props.views,
+    inViews = _props$views === void 0 ? ['hours', 'minutes'] : _props$views,
+    openTo = props.openTo,
+    onViewChange = props.onViewChange,
+    inFocusedView = props.focusedView,
+    onFocusedViewChange = props.onFocusedViewChange,
+    className = props.className,
+    disabled = props.disabled,
+    readOnly = props.readOnly,
+    _props$skipDisabled = props.skipDisabled,
+    skipDisabled = _props$skipDisabled === void 0 ? false : _props$skipDisabled,
+    other = _objectWithoutProperties(props, _excluded);
+  var timeSteps = React.useMemo(function () {
+    return _extends({
+      hours: 1,
+      minutes: 5,
+      seconds: 5
+    }, inTimeSteps);
+  }, [inTimeSteps]);
+  var _useControlled = useControlled({
+      name: 'MultiSectionDigitalClock',
+      state: 'value',
+      controlled: valueProp,
+      default: defaultValue != null ? defaultValue : null
+    }),
+    _useControlled2 = _slicedToArray(_useControlled, 2),
+    value = _useControlled2[0],
+    setValue = _useControlled2[1];
+  var handleValueChange = useEventCallback(function (newValue, selectionState, selectedView) {
+    setValue(newValue);
+    onChange == null ? void 0 : onChange(newValue, selectionState, selectedView);
+  });
+  var views = React.useMemo(function () {
+    if (!ampm || !inViews.includes('hours')) {
+      return inViews;
+    }
+    return inViews.includes('meridiem') ? inViews : [].concat(_toConsumableArray(inViews), ['meridiem']);
+  }, [ampm, inViews]);
+  var _useViews = useViews({
+      view: inView,
+      views: views,
+      openTo: openTo,
+      onViewChange: onViewChange,
+      onChange: handleValueChange,
+      focusedView: inFocusedView,
+      onFocusedViewChange: onFocusedViewChange
+    }),
+    view = _useViews.view,
+    setValueAndGoToView = _useViews.setValueAndGoToView,
+    focusedView = _useViews.focusedView;
+  var selectedTimeOrMidnight = React.useMemo(function () {
+    return value || utils.setSeconds(utils.setMinutes(utils.setHours(now, 0), 0), 0);
+  }, [value, now, utils]);
+  var handleMeridiemValueChange = useEventCallback(function (newValue) {
+    setValueAndGoToView(newValue, null, 'meridiem');
+  });
+  var _useMeridiemMode = useMeridiemMode(selectedTimeOrMidnight, ampm, handleMeridiemValueChange, 'finish'),
+    meridiemMode = _useMeridiemMode.meridiemMode,
+    handleMeridiemChange = _useMeridiemMode.handleMeridiemChange;
+  var isTimeDisabled = React.useCallback(function (rawValue, viewType) {
+    var isAfter = createIsAfterIgnoreDatePart(disableIgnoringDatePartForTimeValidation, utils);
+    var shouldCheckPastEnd = viewType === 'hours' || viewType === 'minutes' && views.includes('seconds');
+    var containsValidTime = function containsValidTime(_ref2) {
+      var start = _ref2.start,
+        end = _ref2.end;
+      if (minTime && isAfter(minTime, end)) {
+        return false;
+      }
+      if (maxTime && isAfter(start, maxTime)) {
+        return false;
+      }
+      if (disableFuture && isAfter(start, now)) {
+        return false;
+      }
+      if (disablePast && isAfter(now, shouldCheckPastEnd ? end : start)) {
+        return false;
+      }
+      return true;
+    };
+    var isValidValue = function isValidValue(timeValue) {
+      var step = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 1;
+      if (timeValue % step !== 0) {
+        return false;
+      }
+      if (shouldDisableClock != null && shouldDisableClock(timeValue, viewType)) {
+        return false;
+      }
+      if (shouldDisableTime) {
+        switch (viewType) {
+          case 'hours':
+            return !shouldDisableTime(utils.setHours(selectedTimeOrMidnight, timeValue), 'hours');
+          case 'minutes':
+            return !shouldDisableTime(utils.setMinutes(selectedTimeOrMidnight, timeValue), 'minutes');
+          case 'seconds':
+            return !shouldDisableTime(utils.setSeconds(selectedTimeOrMidnight, timeValue), 'seconds');
+          default:
+            return false;
+        }
+      }
+      return true;
+    };
+    switch (viewType) {
+      case 'hours':
+        {
+          var valueWithMeridiem = convertValueToMeridiem(rawValue, meridiemMode, ampm);
+          var dateWithNewHours = utils.setHours(selectedTimeOrMidnight, valueWithMeridiem);
+          var start = utils.setSeconds(utils.setMinutes(dateWithNewHours, 0), 0);
+          var end = utils.setSeconds(utils.setMinutes(dateWithNewHours, 59), 59);
+          return !containsValidTime({
+            start: start,
+            end: end
+          }) || !isValidValue(valueWithMeridiem);
+        }
+      case 'minutes':
+        {
+          var dateWithNewMinutes = utils.setMinutes(selectedTimeOrMidnight, rawValue);
+          var _start = utils.setSeconds(dateWithNewMinutes, 0);
+          var _end = utils.setSeconds(dateWithNewMinutes, 59);
+          return !containsValidTime({
+            start: _start,
+            end: _end
+          }) || !isValidValue(rawValue, minutesStep);
+        }
+      case 'seconds':
+        {
+          var dateWithNewSeconds = utils.setSeconds(selectedTimeOrMidnight, rawValue);
+          var _start2 = dateWithNewSeconds;
+          var _end2 = dateWithNewSeconds;
+          return !containsValidTime({
+            start: _start2,
+            end: _end2
+          }) || !isValidValue(rawValue);
+        }
+      default:
+        throw new Error('not supported');
+    }
+  }, [ampm, selectedTimeOrMidnight, disableIgnoringDatePartForTimeValidation, maxTime, meridiemMode, minTime, minutesStep, shouldDisableClock, shouldDisableTime, utils, disableFuture, disablePast, now, views]);
+  var handleSectionChange = useEventCallback(function (sectionView, newValue) {
+    var viewIndex = views.indexOf(sectionView);
+    var nextView = views[viewIndex + 1];
+    setValueAndGoToView(newValue, nextView, sectionView);
+  });
+  var buildViewProps = React.useCallback(function (viewToBuild) {
+    switch (viewToBuild) {
+      case 'hours':
+        {
+          return {
+            onChange: function onChange(hours) {
+              var valueWithMeridiem = convertValueToMeridiem(hours, meridiemMode, ampm);
+              handleSectionChange('hours', utils.setHours(selectedTimeOrMidnight, valueWithMeridiem));
+            },
+            items: getHourSectionOptions({
+              now: now,
+              value: value,
+              ampm: ampm,
+              utils: utils,
+              isDisabled: function isDisabled(hours) {
+                return disabled || isTimeDisabled(hours, 'hours');
+              },
+              timeStep: timeSteps.hours,
+              resolveAriaLabel: localeText.hoursClockNumberText
+            })
+          };
+        }
+      case 'minutes':
+        {
+          return {
+            onChange: function onChange(minutes) {
+              handleSectionChange('minutes', utils.setMinutes(selectedTimeOrMidnight, minutes));
+            },
+            items: getTimeSectionOptions({
+              value: utils.getMinutes(selectedTimeOrMidnight),
+              isDisabled: function isDisabled(minutes) {
+                return disabled || isTimeDisabled(minutes, 'minutes');
+              },
+              resolveLabel: function resolveLabel(minutes) {
+                return utils.format(utils.setMinutes(now, minutes), 'minutes');
+              },
+              timeStep: timeSteps.minutes,
+              hasValue: !!value,
+              resolveAriaLabel: localeText.minutesClockNumberText
+            })
+          };
+        }
+      case 'seconds':
+        {
+          return {
+            onChange: function onChange(seconds) {
+              handleSectionChange('seconds', utils.setSeconds(selectedTimeOrMidnight, seconds));
+            },
+            items: getTimeSectionOptions({
+              value: utils.getSeconds(selectedTimeOrMidnight),
+              isDisabled: function isDisabled(seconds) {
+                return disabled || isTimeDisabled(seconds, 'seconds');
+              },
+              resolveLabel: function resolveLabel(seconds) {
+                return utils.format(utils.setSeconds(now, seconds), 'seconds');
+              },
+              timeStep: timeSteps.seconds,
+              hasValue: !!value,
+              resolveAriaLabel: localeText.secondsClockNumberText
+            })
+          };
+        }
+      case 'meridiem':
+        {
+          var amLabel = utils.getMeridiemText('am');
+          var pmLabel = utils.getMeridiemText('pm');
+          return {
+            onChange: handleMeridiemChange,
+            items: [{
+              value: 'am',
+              label: amLabel,
+              isSelected: function isSelected() {
+                return !!value && meridiemMode === 'am';
+              },
+              ariaLabel: amLabel
+            }, {
+              value: 'pm',
+              label: pmLabel,
+              isSelected: function isSelected() {
+                return !!value && meridiemMode === 'pm';
+              },
+              ariaLabel: pmLabel
+            }]
+          };
+        }
+      default:
+        throw new Error("Unknown view: ".concat(viewToBuild, " found."));
+    }
+  }, [now, value, ampm, utils, timeSteps.hours, timeSteps.minutes, timeSteps.seconds, localeText.hoursClockNumberText, localeText.minutesClockNumberText, localeText.secondsClockNumberText, meridiemMode, handleSectionChange, selectedTimeOrMidnight, disabled, isTimeDisabled, handleMeridiemChange]);
+  var viewTimeOptions = React.useMemo(function () {
+    return views.reduce(function (result, currentView) {
+      return _extends({}, result, _defineProperty({}, currentView, buildViewProps(currentView)));
+    }, {});
+  }, [views, buildViewProps]);
+  var ownerState = props;
+  var classes = useUtilityClasses(ownerState);
+  return /*#__PURE__*/_jsx(MultiSectionDigitalClockRoot, _extends({
+    ref: ref,
+    className: clsx(classes.root, className),
+    ownerState: ownerState,
+    role: "group"
+  }, other, {
+    children: Object.entries(viewTimeOptions).map(function (_ref3) {
+      var _ref4 = _slicedToArray(_ref3, 2),
+        timeView = _ref4[0],
+        viewOptions = _ref4[1];
+      return /*#__PURE__*/_jsx(MultiSectionDigitalClockSection, {
+        items: viewOptions.items,
+        onChange: viewOptions.onChange,
+        active: view === timeView,
+        autoFocus: autoFocus != null ? autoFocus : focusedView === timeView,
+        disabled: disabled,
+        readOnly: readOnly,
+        slots: slots != null ? slots : components,
+        slotProps: slotProps != null ? slotProps : componentsProps,
+        skipDisabled: skipDisabled,
+        "aria-label": localeText.selectViewText(timeView)
+      }, timeView);
+    })
+  }));
+});
+process.env.NODE_ENV !== "production" ? MultiSectionDigitalClock.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "yarn proptypes"  |
+  // ----------------------------------------------------------------------
+  /**
+   * 12h/24h view for hour selection clock.
+   * @default `utils.is12HourCycleInCurrentLocale()`
+   */
+  ampm: PropTypes.bool,
+  /**
+   * If `true`, the main element is focused during the first mount.
+   * This main element is:
+   * - the element chosen by the visible view if any (i.e: the selected day on the `day` view).
+   * - the `input` element if there is a field rendered.
+   */
+  autoFocus: PropTypes.bool,
+  /**
+   * Override or extend the styles applied to the component.
+   */
+  classes: PropTypes.object,
+  className: PropTypes.string,
+  /**
+   * Overrideable components.
+   * @default {}
+   * @deprecated Please use `slots`.
+   */
+  components: PropTypes.object,
+  /**
+   * The props used for each component slot.
+   * @default {}
+   * @deprecated Please use `slotProps`.
+   */
+  componentsProps: PropTypes.object,
+  /**
+   * The default selected value.
+   * Used when the component is not controlled.
+   */
+  defaultValue: PropTypes.any,
+  /**
+   * If `true`, the picker views and text field are disabled.
+   * @default false
+   */
+  disabled: PropTypes.bool,
+  /**
+   * If `true`, disable values after the current date for date components, time for time components and both for date time components.
+   * @default false
+   */
+  disableFuture: PropTypes.bool,
+  /**
+   * Do not ignore date part when validating min/max time.
+   * @default false
+   */
+  disableIgnoringDatePartForTimeValidation: PropTypes.bool,
+  /**
+   * If `true`, disable values before the current date for date components, time for time components and both for date time components.
+   * @default false
+   */
+  disablePast: PropTypes.bool,
+  /**
+   * Controlled focused view.
+   */
+  focusedView: PropTypes.oneOf(['hours', 'meridiem', 'minutes', 'seconds']),
+  /**
+   * Maximal selectable time.
+   * The date part of the object will be ignored unless `props.disableIgnoringDatePartForTimeValidation === true`.
+   */
+  maxTime: PropTypes.any,
+  /**
+   * Minimal selectable time.
+   * The date part of the object will be ignored unless `props.disableIgnoringDatePartForTimeValidation === true`.
+   */
+  minTime: PropTypes.any,
+  /**
+   * Step over minutes.
+   * @default 1
+   */
+  minutesStep: PropTypes.number,
+  /**
+   * Callback fired when the value changes.
+   * @template TDate
+   * @param {TDate | null} value The new value.
+   * @param {PickerSelectionState | undefined} selectionState Indicates if the date selection is complete.
+   * @param {TView | undefined} selectedView Indicates the view in which the selection has been made.
+   */
+  onChange: PropTypes.func,
+  /**
+   * Callback fired on focused view change.
+   * @template TView
+   * @param {TView} view The new view to focus or not.
+   * @param {boolean} hasFocus `true` if the view should be focused.
+   */
+  onFocusedViewChange: PropTypes.func,
+  /**
+   * Callback fired on view change.
+   * @template TView
+   * @param {TView} view The new view.
+   */
+  onViewChange: PropTypes.func,
+  /**
+   * The default visible view.
+   * Used when the component view is not controlled.
+   * Must be a valid option from `views` list.
+   */
+  openTo: PropTypes.oneOf(['hours', 'meridiem', 'minutes', 'seconds']),
+  /**
+   * If `true`, the picker views and text field are read-only.
+   * @default false
+   */
+  readOnly: PropTypes.bool,
+  /**
+   * Disable specific clock time.
+   * @param {number} clockValue The value to check.
+   * @param {TimeView} view The clock type of the timeValue.
+   * @returns {boolean} If `true` the time will be disabled.
+   * @deprecated Consider using `shouldDisableTime`.
+   */
+  shouldDisableClock: PropTypes.func,
+  /**
+   * Disable specific time.
+   * @template TDate
+   * @param {TDate} value The value to check.
+   * @param {TimeView} view The clock type of the timeValue.
+   * @returns {boolean} If `true` the time will be disabled.
+   */
+  shouldDisableTime: PropTypes.func,
+  /**
+   * If `true`, disabled digital clock items will not be rendered.
+   * @default false
+   */
+  skipDisabled: PropTypes.bool,
+  /**
+   * The props used for each component slot.
+   * @default {}
+   */
+  slotProps: PropTypes.object,
+  /**
+   * Overrideable component slots.
+   * @default {}
+   */
+  slots: PropTypes.object,
+  /**
+   * The system prop that allows defining system overrides as well as additional CSS styles.
+   */
+  sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object]),
+  /**
+   * The time steps between two time unit options.
+   * For example, if `timeStep.minutes = 8`, then the available minute options will be `[0, 8, 16, 24, 32, 40, 48, 56]`.
+   * @default{ hours: 1, minutes: 5, seconds: 5 }
+   */
+  timeSteps: PropTypes.shape({
+    hours: PropTypes.number,
+    minutes: PropTypes.number,
+    seconds: PropTypes.number
+  }),
+  /**
+   * The selected value.
+   * Used when the component is controlled.
+   */
+  value: PropTypes.any,
+  /**
+   * The visible view.
+   * Used when the component view is controlled.
+   * Must be a valid option from `views` list.
+   */
+  view: PropTypes.oneOf(['hours', 'meridiem', 'minutes', 'seconds']),
+  /**
+   * Available views.
+   */
+  views: PropTypes.arrayOf(PropTypes.oneOf(['hours', 'meridiem', 'minutes', 'seconds']).isRequired)
+} : void 0;

package/legacy/MultiSectionDigitalClock/MultiSectionDigitalClock.types.js

@@ -0,0 +1 @@
+export {};

package/legacy/MultiSectionDigitalClock/MultiSectionDigitalClock.utils.js

@@ -0,0 +1,65 @@
+import _toConsumableArray from "@babel/runtime/helpers/esm/toConsumableArray";
+export var getHourSectionOptions = function getHourSectionOptions(_ref) {
+  var now = _ref.now,
+    value = _ref.value,
+    utils = _ref.utils,
+    ampm = _ref.ampm,
+    isDisabled = _ref.isDisabled,
+    resolveAriaLabel = _ref.resolveAriaLabel,
+    timeStep = _ref.timeStep;
+  var currentHours = value ? utils.getHours(value) : null;
+  var result = [];
+  var isSelected = function isSelected(hour) {
+    if (currentHours === null) {
+      return false;
+    }
+    if (ampm) {
+      if (hour === 12) {
+        return currentHours === 12 || currentHours === 0;
+      }
+      return currentHours === hour || currentHours - 12 === hour;
+    }
+    return currentHours === hour;
+  };
+  var endHour = ampm ? 11 : 23;
+  for (var hour = 0; hour <= endHour; hour += timeStep) {
+    var label = utils.format(utils.setHours(now, hour), ampm ? 'hours12h' : 'hours24h');
+    var ariaLabel = resolveAriaLabel(parseInt(label, 10).toString());
+    label = utils.formatNumber(label);
+    result.push({
+      value: hour,
+      label: label,
+      isSelected: isSelected,
+      isDisabled: isDisabled,
+      ariaLabel: ariaLabel
+    });
+  }
+  return result;
+};
+export var getTimeSectionOptions = function getTimeSectionOptions(_ref2) {
+  var value = _ref2.value,
+    isDisabled = _ref2.isDisabled,
+    timeStep = _ref2.timeStep,
+    resolveLabel = _ref2.resolveLabel,
+    resolveAriaLabel = _ref2.resolveAriaLabel,
+    _ref2$hasValue = _ref2.hasValue,
+    hasValue = _ref2$hasValue === void 0 ? true : _ref2$hasValue;
+  var isSelected = function isSelected(timeValue) {
+    if (value === null) {
+      return false;
+    }
+    return hasValue && value === timeValue;
+  };
+  return _toConsumableArray(Array.from({
+    length: Math.ceil(60 / timeStep)
+  }, function (_, index) {
+    var timeValue = timeStep * index;
+    return {
+      value: timeValue,
+      label: resolveLabel(timeValue),
+      isDisabled: isDisabled,
+      isSelected: isSelected,
+      ariaLabel: resolveAriaLabel(timeValue.toString())
+    };
+  }));
+};