@mui/x-date-pickers 6.2.1 → 6.3.1

package/modern/DigitalClock/DigitalClock.js

@@ -0,0 +1,396 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+const _excluded = ["ampm", "timeStep", "autoFocus", "components", "componentsProps", "slots", "slotProps", "value", "disableIgnoringDatePartForTimeValidation", "maxTime", "minTime", "disableFuture", "disablePast", "minutesStep", "shouldDisableClock", "shouldDisableTime", "onChange", "defaultValue", "view", "openTo", "onViewChange", "focusedView", "onFocusedViewChange", "className", "disabled", "readOnly", "views", "skipDisabled"];
+import * as React from 'react';
+import clsx from 'clsx';
+import PropTypes from 'prop-types';
+import { alpha, 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 MenuItem from '@mui/material/MenuItem';
+import MenuList from '@mui/material/MenuList';
+import useForkRef from '@mui/utils/useForkRef';
+import { useUtils, useNow, useLocaleText } from '../internals/hooks/useUtils';
+import { createIsAfterIgnoreDatePart } from '../internals/utils/time-utils';
+import { PickerViewRoot } from '../internals/components/PickerViewRoot';
+import { getDigitalClockUtilityClass } from './digitalClockClasses';
+import { useViews } from '../internals/hooks/useViews';
+import { DIGITAL_CLOCK_VIEW_HEIGHT } from '../internals/constants/dimensions';
+import { jsx as _jsx } from "react/jsx-runtime";
+const useUtilityClasses = ownerState => {
+  const {
+    classes
+  } = ownerState;
+  const slots = {
+    root: ['root'],
+    list: ['list'],
+    item: ['item']
+  };
+  return composeClasses(slots, getDigitalClockUtilityClass, classes);
+};
+const DigitalClockRoot = styled(PickerViewRoot, {
+  name: 'MuiDigitalClock',
+  slot: 'Root',
+  overridesResolver: (props, styles) => styles.root
+})(({
+  ownerState
+}) => ({
+  overflowY: 'auto',
+  width: '100%',
+  scrollBehavior: ownerState.alreadyRendered ? 'smooth' : 'auto',
+  maxHeight: DIGITAL_CLOCK_VIEW_HEIGHT
+}));
+const DigitalClockList = styled(MenuList, {
+  name: 'MuiDigitalClock',
+  slot: 'List',
+  overridesResolver: (props, styles) => styles.list
+})({
+  padding: 0
+});
+const DigitalClockItem = styled(MenuItem, {
+  name: 'MuiDigitalClock',
+  slot: 'Item',
+  overridesResolver: (props, styles) => styles.item
+})(({
+  theme
+}) => ({
+  padding: '8px 16px',
+  margin: '2px 4px',
+  '&:first-of-type': {
+    marginTop: 4
+  },
+  '&:hover': {
+    backgroundColor: theme.vars ? `rgba(${theme.vars.palette.primary.mainChannel} / ${theme.vars.palette.action.hoverOpacity})` : alpha(theme.palette.primary.main, theme.palette.action.hoverOpacity)
+  },
+  '&.Mui-selected': {
+    backgroundColor: (theme.vars || theme).palette.primary.main,
+    color: (theme.vars || theme).palette.primary.contrastText,
+    '&:focus-visible, &:hover': {
+      backgroundColor: (theme.vars || theme).palette.primary.dark
+    }
+  },
+  '&.Mui-focusVisible': {
+    backgroundColor: theme.vars ? `rgba(${theme.vars.palette.primary.mainChannel} / ${theme.vars.palette.action.focusOpacity})` : alpha(theme.palette.primary.main, theme.palette.action.focusOpacity)
+  }
+}));
+export const DigitalClock = /*#__PURE__*/React.forwardRef(function DigitalClock(inProps, ref) {
+  const now = useNow();
+  const utils = useUtils();
+  const containerRef = React.useRef(null);
+  const handleRef = useForkRef(ref, containerRef);
+  const localeText = useLocaleText();
+  const props = useThemeProps({
+    props: inProps,
+    name: 'MuiDigitalClock'
+  });
+  const {
+      ampm = utils.is12HourCycleInCurrentLocale(),
+      timeStep = 30,
+      autoFocus,
+      components,
+      componentsProps,
+      slots,
+      slotProps,
+      value: valueProp,
+      disableIgnoringDatePartForTimeValidation = false,
+      maxTime,
+      minTime,
+      disableFuture,
+      disablePast,
+      minutesStep = 1,
+      shouldDisableClock,
+      shouldDisableTime,
+      onChange,
+      defaultValue,
+      view: inView,
+      openTo,
+      onViewChange,
+      focusedView,
+      onFocusedViewChange,
+      className,
+      disabled,
+      readOnly,
+      views = ['hours'],
+      skipDisabled = false
+    } = props,
+    other = _objectWithoutPropertiesLoose(props, _excluded);
+  const ownerState = React.useMemo(() => _extends({}, props, {
+    alreadyRendered: !!containerRef.current
+  }), [props]);
+  const classes = useUtilityClasses(ownerState);
+  const ClockItem = slots?.digitalClockItem ?? components?.DigitalClockItem ?? DigitalClockItem;
+  const clockItemProps = slotProps?.digitalClockItem ?? componentsProps?.digitalClockItem;
+  const [value, setValue] = useControlled({
+    name: 'DigitalClock',
+    state: 'value',
+    controlled: valueProp,
+    default: defaultValue ?? null
+  });
+  const handleValueChange = useEventCallback(newValue => {
+    setValue(newValue);
+    onChange?.(newValue, 'finish');
+  });
+  const {
+    setValueAndGoToNextView
+  } = useViews({
+    view: inView,
+    views,
+    openTo,
+    onViewChange,
+    onChange: handleValueChange,
+    focusedView,
+    onFocusedViewChange
+  });
+  const handleItemSelect = useEventCallback(newValue => {
+    setValueAndGoToNextView(newValue, 'finish');
+  });
+  React.useEffect(() => {
+    if (containerRef.current === null) {
+      return;
+    }
+    const selectedItem = containerRef.current.querySelector('[role="listbox"] [role="option"][aria-selected="true"]');
+    if (!selectedItem) {
+      return;
+    }
+    const offsetTop = selectedItem.offsetTop;
+
+    // Subtracting the 4px of extra margin intended for the first visible section item
+    containerRef.current.scrollTop = offsetTop - 4;
+  });
+  const selectedTimeOrMidnight = React.useMemo(() => value || utils.setSeconds(utils.setMinutes(utils.setHours(now, 0), 0), 0), [value, now, utils]);
+  const isTimeDisabled = React.useCallback(valueToCheck => {
+    const isAfter = createIsAfterIgnoreDatePart(disableIgnoringDatePartForTimeValidation, utils);
+    const containsValidTime = () => {
+      if (minTime && isAfter(minTime, valueToCheck)) {
+        return false;
+      }
+      if (maxTime && isAfter(valueToCheck, maxTime)) {
+        return false;
+      }
+      if (disableFuture && isAfter(valueToCheck, now)) {
+        return false;
+      }
+      if (disablePast && isAfter(now, valueToCheck)) {
+        return false;
+      }
+      return true;
+    };
+    const isValidValue = () => {
+      if (utils.getMinutes(valueToCheck) % minutesStep !== 0) {
+        return false;
+      }
+      if (shouldDisableClock?.(utils.toJsDate(valueToCheck).getTime(), 'hours')) {
+        return false;
+      }
+      if (shouldDisableTime) {
+        return !shouldDisableTime(valueToCheck, 'hours');
+      }
+      return true;
+    };
+    return !containsValidTime() || !isValidValue();
+  }, [disableIgnoringDatePartForTimeValidation, utils, minTime, maxTime, disableFuture, now, disablePast, minutesStep, shouldDisableClock, shouldDisableTime]);
+  const timeOptions = React.useMemo(() => {
+    const startOfDay = utils.startOfDay(selectedTimeOrMidnight);
+    return [startOfDay, ...Array.from({
+      length: Math.ceil(24 * 60 / timeStep) - 1
+    }, (_, index) => utils.addMinutes(startOfDay, timeStep * (index + 1))), utils.endOfDay(selectedTimeOrMidnight)];
+  }, [selectedTimeOrMidnight, timeStep, utils]);
+  return /*#__PURE__*/_jsx(DigitalClockRoot, _extends({
+    ref: handleRef,
+    className: clsx(classes.root, className),
+    ownerState: ownerState
+  }, other, {
+    children: /*#__PURE__*/_jsx(DigitalClockList, {
+      autoFocusItem: autoFocus || !!focusedView,
+      role: "listbox",
+      "aria-label": localeText.timePickerToolbarTitle,
+      children: timeOptions.map(option => {
+        if (skipDisabled && isTimeDisabled(option)) {
+          return null;
+        }
+        const isSelected = utils.isEqual(option, value);
+        return /*#__PURE__*/_jsx(ClockItem, _extends({
+          onClick: () => !readOnly && handleItemSelect(option),
+          selected: isSelected,
+          disabled: disabled || isTimeDisabled(option),
+          disableRipple: readOnly,
+          role: "option"
+          // aria-readonly is not supported here and does not have any effect
+          ,
+          "aria-disabled": readOnly,
+          "aria-selected": isSelected
+        }, clockItemProps, {
+          children: utils.format(option, ampm ? 'fullTime12h' : 'fullTime24h')
+        }), utils.toISO(option));
+      })
+    })
+  }));
+});
+process.env.NODE_ENV !== "production" ? DigitalClock.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']),
+  /**
+   * 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']),
+  /**
+   * 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 options.
+   * For example, if `timeStep = 45`, then the available time options will be `[00:00, 00:45, 01:30, 02:15, 03:00, etc.]`.
+   * @default 30
+   */
+  timeStep: 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']),
+  /**
+   * Available views.
+   */
+  views: PropTypes.arrayOf(PropTypes.oneOf(['hours']))
+} : void 0;

package/modern/DigitalClock/DigitalClock.types.js

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

package/modern/DigitalClock/digitalClockClasses.js

@@ -0,0 +1,6 @@
+import generateUtilityClass from '@mui/utils/generateUtilityClass';
+import generateUtilityClasses from '@mui/utils/generateUtilityClasses';
+export function getDigitalClockUtilityClass(slot) {
+  return generateUtilityClass('MuiDigitalClock', slot);
+}
+export const digitalClockClasses = generateUtilityClasses('MuiDigitalClock', ['root', 'list', 'item']);

package/modern/DigitalClock/index.js

@@ -0,0 +1,2 @@
+export { DigitalClock } from './DigitalClock';
+export { digitalClockClasses, getDigitalClockUtilityClass } from './digitalClockClasses';

package/modern/MobileDatePicker/MobileDatePicker.js

@@ -6,7 +6,7 @@ import { useMobilePicker } from '../internals/hooks/useMobilePicker';
 import { getDatePickerFieldFormat, useDatePickerDefaultizedProps } from '../DatePicker/shared';
 import { useLocaleText, useUtils, validateDate } from '../internals';
 import { DateField } from '../DateField';
-import { extractValidationProps } from '../internals/utils/validation';
+import { extractValidationProps } from '../internals/utils/validation/extractValidationProps';
 import { singleItemValueManager } from '../internals/utils/valueManagers';
 import { renderDateViewCalendar } from '../dateViewRenderers';
 const MobileDatePicker = /*#__PURE__*/React.forwardRef(function MobileDatePicker(inProps, ref) {

package/modern/MobileDateTimePicker/MobileDateTimePicker.js

@@ -7,7 +7,7 @@ import { DateTimeField } from '../DateTimeField';
 import { useDateTimePickerDefaultizedProps } from '../DateTimePicker/shared';
 import { useLocaleText, validateDateTime } from '../internals';
 import { useMobilePicker } from '../internals/hooks/useMobilePicker';
-import { extractValidationProps } from '../internals/utils/validation';
+import { extractValidationProps } from '../internals/utils/validation/extractValidationProps';
 import { renderDateViewCalendar } from '../dateViewRenderers';
 import { renderTimeViewClock } from '../timeViewRenderers';
 const MobileDateTimePicker = /*#__PURE__*/React.forwardRef(function MobileDateTimePicker(inProps, ref) {
@@ -345,6 +345,7 @@ MobileDateTimePicker.propTypes = {
   shouldDisableMonth: 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.

package/modern/MobileTimePicker/MobileTimePicker.js

@@ -7,7 +7,7 @@ import { TimeField } from '../TimeField';
 import { useTimePickerDefaultizedProps } from '../TimePicker/shared';
 import { useLocaleText, validateTime } from '../internals';
 import { useMobilePicker } from '../internals/hooks/useMobilePicker';
-import { extractValidationProps } from '../internals/utils/validation';
+import { extractValidationProps } from '../internals/utils/validation/extractValidationProps';
 import { renderTimeViewClock } from '../timeViewRenderers';
 const MobileTimePicker = /*#__PURE__*/React.forwardRef(function MobileTimePicker(inProps, ref) {
   const localeText = useLocaleText();
@@ -248,6 +248,7 @@ MobileTimePicker.propTypes = {
   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.