@mui/x-date-pickers 5.0.0-alpha.0

package/modern/TimePicker/TimePicker.js

@@ -0,0 +1,395 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+const _excluded = ["cancelText", "clearable", "clearText", "desktopModeMediaQuery", "DialogProps", "okText", "PopperProps", "showTodayButton", "todayText", "TransitionComponent"];
+import * as React from 'react';
+import { useThemeProps } from '@mui/material/styles';
+import useMediaQuery from '@mui/material/useMediaQuery';
+import PropTypes from 'prop-types';
+import { DesktopTimePicker } from '../DesktopTimePicker';
+import { MobileTimePicker } from '../MobileTimePicker';
+import { jsx as _jsx } from "react/jsx-runtime";
+
+/**
+ *
+ * Demos:
+ *
+ * - [Pickers](https://mui.com/x/react-date-pickers/)
+ * - [Time Picker](https://mui.com/components/x/react-date-pickers/time-picker/)
+ *
+ * API:
+ *
+ * - [TimePicker API](https://mui.com/api/time-picker/)
+ */
+export const TimePicker = /*#__PURE__*/React.forwardRef(function TimePicker(inProps, ref) {
+  const props = useThemeProps({
+    props: inProps,
+    name: 'MuiTimePicker'
+  });
+
+  const {
+    cancelText,
+    clearable,
+    clearText,
+    desktopModeMediaQuery = '@media (pointer: fine)',
+    DialogProps,
+    okText,
+    PopperProps,
+    showTodayButton,
+    todayText,
+    TransitionComponent
+  } = props,
+        other = _objectWithoutPropertiesLoose(props, _excluded);
+
+  const isDesktop = useMediaQuery(desktopModeMediaQuery);
+
+  if (isDesktop) {
+    return /*#__PURE__*/_jsx(DesktopTimePicker, _extends({
+      ref: ref,
+      PopperProps: PopperProps,
+      TransitionComponent: TransitionComponent
+    }, other));
+  }
+
+  return /*#__PURE__*/_jsx(MobileTimePicker, _extends({
+    ref: ref,
+    cancelText: cancelText,
+    clearable: clearable,
+    clearText: clearText,
+    DialogProps: DialogProps,
+    okText: okText,
+    showTodayButton: showTodayButton,
+    todayText: todayText
+  }, other));
+});
+process.env.NODE_ENV !== "production" ? TimePicker.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "yarn proptypes"  |
+  // ----------------------------------------------------------------------
+
+  /**
+   * Regular expression to detect "accepted" symbols.
+   * @default /\dap/gi
+   */
+  acceptRegex: PropTypes.instanceOf(RegExp),
+
+  /**
+   * 12h/24h view for hour selection clock.
+   * @default false
+   */
+  ampm: PropTypes.bool,
+
+  /**
+   * Display ampm controls under the clock (instead of in the toolbar).
+   * @default false
+   */
+  ampmInClock: PropTypes.bool,
+
+  /**
+   * Cancel text message.
+   * @default 'Cancel'
+   */
+  cancelText: PropTypes.node,
+  children: PropTypes.node,
+
+  /**
+   * className applied to the root component.
+   */
+  className: PropTypes.string,
+
+  /**
+   * If `true`, it shows the clear action in the picker dialog.
+   * @default false
+   */
+  clearable: PropTypes.bool,
+
+  /**
+   * Clear text message.
+   * @default 'Clear'
+   */
+  clearText: PropTypes.node,
+
+  /**
+   * The components used for each slot.
+   * Either a string to use a HTML element or a component.
+   */
+  components: PropTypes.object,
+
+  /**
+   * CSS media query when `Mobile` mode will be changed to `Desktop`.
+   * @default '@media (pointer: fine)'
+   * @example '@media (min-width: 720px)' or theme.breakpoints.up("sm")
+   */
+  desktopModeMediaQuery: PropTypes.string,
+
+  /**
+   * Props applied to the [`Dialog`](/api/dialog/) element.
+   */
+  DialogProps: PropTypes.object,
+
+  /**
+   * If `true` the popup or dialog will immediately close after submitting full date.
+   * @default `true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop).
+   */
+  disableCloseOnSelect: PropTypes.bool,
+
+  /**
+   * If `true`, the picker and text field are disabled.
+   */
+  disabled: PropTypes.bool,
+
+  /**
+   * Do not ignore date part when validating min/max time.
+   * @default false
+   */
+  disableIgnoringDatePartForTimeValidation: PropTypes.bool,
+
+  /**
+   * Disable mask on the keyboard, this should be used rarely. Consider passing proper mask for your format.
+   * @default false
+   */
+  disableMaskedInput: PropTypes.bool,
+
+  /**
+   * Do not render open picker button (renders only text field with validation).
+   * @default false
+   */
+  disableOpenPicker: PropTypes.bool,
+
+  /**
+   * Accessible text that helps user to understand which time and view is selected.
+   * @param {ClockPickerView} view The current view rendered.
+   * @param {TDate | null} time The current time.
+   * @param {MuiPickersAdapter<TDate>} adapter The current date adapter.
+   * @returns {string} The clock label.
+   * @default <TDate extends any>(
+   *   view: ClockView,
+   *   time: TDate | null,
+   *   adapter: MuiPickersAdapter<TDate>,
+   * ) =>
+   *   `Select ${view}. ${
+   *     time === null ? 'No time selected' : `Selected time is ${adapter.format(time, 'fullTime')}`
+   *   }`
+   */
+  getClockLabelText: PropTypes.func,
+
+  /**
+   * Get aria-label text for control that opens picker dialog. Aria-label text must include selected date. @DateIOType
+   * @default (value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}`
+   * @param {ParseableDate<TDateValue>} value The date from which we want to add an aria-text.
+   * @param {MuiPickersAdapter<TDateValue>} utils The utils to manipulate the date.
+   * @returns {string} The aria-text to render inside the dialog.
+   */
+  getOpenDialogAriaText: PropTypes.func,
+  ignoreInvalidInputs: PropTypes.bool,
+
+  /**
+   * Props to pass to keyboard input adornment.
+   */
+  InputAdornmentProps: PropTypes.object,
+
+  /**
+   * Format string.
+   */
+  inputFormat: PropTypes.string,
+  InputProps: PropTypes.object,
+
+  /**
+   * Pass a ref to the `input` element.
+   */
+  inputRef: PropTypes.oneOfType([PropTypes.func, PropTypes.shape({
+    current: PropTypes.object
+  })]),
+  label: PropTypes.node,
+
+  /**
+   * Custom mask. Can be used to override generate from format. (e.g. `__/__/____ __:__` or `__/__/____ __:__ _M`).
+   */
+  mask: PropTypes.string,
+
+  /**
+   * Max time acceptable time.
+   * For input validation date part of passed object will be ignored if `disableIgnoringDatePartForTimeValidation` not specified.
+   */
+  maxTime: PropTypes.any,
+
+  /**
+   * Min time acceptable time.
+   * For input validation date part of passed object will be ignored if `disableIgnoringDatePartForTimeValidation` not specified.
+   */
+  minTime: PropTypes.any,
+
+  /**
+   * Step over minutes.
+   * @default 1
+   */
+  minutesStep: PropTypes.number,
+
+  /**
+   * Ok button text.
+   * @default 'OK'
+   */
+  okText: PropTypes.node,
+
+  /**
+   * Callback fired when date is accepted @DateIOType.
+   * @param {TDateValue} date The date that was just accepted.
+   */
+  onAccept: PropTypes.func,
+
+  /**
+   * Callback fired when the value (the selected date) changes @DateIOType.
+   * @param {DateRange<TDate>} date The new parsed date.
+   * @param {string} keyboardInputValue The current value of the keyboard input.
+   */
+  onChange: PropTypes.func.isRequired,
+
+  /**
+   * Callback fired when the popup requests to be closed.
+   * Use in controlled mode (see open).
+   */
+  onClose: PropTypes.func,
+
+  /**
+   * Callback that fired when input value or new `value` prop validation returns **new** validation error (or value is valid after error).
+   * In case of validation error detected `reason` prop return non-null value and `TextField` must be displayed in `error` state.
+   * This can be used to render appropriate form error.
+   *
+   * [Read the guide](https://next.material-ui-pickers.dev/guides/forms) about form integration and error displaying.
+   * @DateIOType
+   *
+   * @param {TError} reason The reason why the current value is not valid.
+   * @param {TDateValue} value The invalid value.
+   */
+  onError: PropTypes.func,
+
+  /**
+   * Callback fired when the popup requests to be opened.
+   * Use in controlled mode (see open).
+   */
+  onOpen: PropTypes.func,
+
+  /**
+   * Callback fired on view change.
+   * @param {ClockPickerView} view The new view.
+   */
+  onViewChange: PropTypes.func,
+
+  /**
+   * Control the popup or dialog open state.
+   */
+  open: PropTypes.bool,
+
+  /**
+   * Props to pass to keyboard adornment button.
+   */
+  OpenPickerButtonProps: PropTypes.object,
+
+  /**
+   * First view to show.
+   */
+  openTo: PropTypes.oneOf(['hours', 'minutes', 'seconds']),
+
+  /**
+   * Force rendering in particular orientation.
+   */
+  orientation: PropTypes.oneOf(['landscape', 'portrait']),
+
+  /**
+   * Paper props passed down to [Paper](https://mui.com/api/paper/) component.
+   */
+  PaperProps: PropTypes.object,
+
+  /**
+   * Popper props passed down to [Popper](https://mui.com/api/popper/) component.
+   */
+  PopperProps: PropTypes.object,
+
+  /**
+   * Make picker read only.
+   */
+  readOnly: PropTypes.bool,
+
+  /**
+   * The `renderInput` prop allows you to customize the rendered input.
+   * The `props` argument of this render prop contains props of [TextField](https://mui.com/api/text-field/#textfield-api) that you need to forward.
+   * Pay specific attention to the `ref` and `inputProps` keys.
+   * @example ```jsx
+   * renderInput={props => <TextField {...props} />}
+   * ````
+   * @param {MuiTextFieldPropsType} props The props of the input.
+   * @returns {React.ReactNode} The node to render as the input.
+   */
+  renderInput: PropTypes.func.isRequired,
+
+  /**
+   * Custom formatter to be passed into Rifm component.
+   * @param {string} str The un-formatted string.
+   * @returns {string} The formatted string.
+   */
+  rifmFormatter: PropTypes.func,
+
+  /**
+   * Dynamically check if time is disabled or not.
+   * If returns `false` appropriate time point will ot be acceptable.
+   * @param {number} timeValue The value to check.
+   * @param {ClockPickerView} clockType The clock type of the timeValue.
+   * @returns {boolean} Returns `true` if the time should be disabled
+   */
+  shouldDisableTime: PropTypes.func,
+
+  /**
+   * If `true`, the today button is displayed. **Note** that `showClearButton` has a higher priority.
+   * @default false
+   */
+  showTodayButton: PropTypes.bool,
+
+  /**
+   * If `true`, show the toolbar even in desktop mode.
+   */
+  showToolbar: PropTypes.bool,
+
+  /**
+   * Today text message.
+   * @default 'Today'
+   */
+  todayText: PropTypes.node,
+
+  /**
+   * Component that will replace default toolbar renderer.
+   * @default TimePickerToolbar
+   */
+  ToolbarComponent: PropTypes.elementType,
+
+  /**
+   * Date format, that is displaying in toolbar.
+   */
+  toolbarFormat: PropTypes.string,
+
+  /**
+   * Mobile picker date value placeholder, displaying if `value` === `null`.
+   * @default '–'
+   */
+  toolbarPlaceholder: PropTypes.node,
+
+  /**
+   * Mobile picker title, displaying in the toolbar.
+   * @default 'Select time'
+   */
+  toolbarTitle: PropTypes.node,
+
+  /**
+   * Custom component for popper [Transition](https://mui.com/components/transitions/#transitioncomponent-prop).
+   */
+  TransitionComponent: PropTypes.elementType,
+
+  /**
+   * The value of the picker.
+   */
+  value: PropTypes.oneOfType([PropTypes.any, PropTypes.instanceOf(Date), PropTypes.number, PropTypes.string]),
+
+  /**
+   * Array of views to show.
+   */
+  views: PropTypes.arrayOf(PropTypes.oneOf(['hours', 'minutes', 'seconds']).isRequired)
+} : void 0;

package/modern/TimePicker/TimePickerToolbar.js

@@ -0,0 +1,167 @@
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+import _extends from "@babel/runtime/helpers/esm/extends";
+const _excluded = ["ampm", "ampmInClock", "date", "isLandscape", "isMobileKeyboardViewOpen", "onChange", "openView", "setOpenView", "toggleMobileKeyboardView", "toolbarTitle", "views"];
+import * as React from 'react';
+import clsx from 'clsx';
+import { useTheme, styled } from '@mui/material/styles';
+import { unstable_composeClasses as composeClasses } from '@mui/material';
+import { PickersToolbarText } from '../internals/components/PickersToolbarText';
+import { PickersToolbarButton } from '../internals/components/PickersToolbarButton';
+import { PickersToolbar } from '../internals/components/PickersToolbar';
+import { arrayIncludes } from '../internals/utils/utils';
+import { useUtils } from '../internals/hooks/useUtils';
+import { useMeridiemMode } from '../internals/hooks/date-helpers-hooks';
+import { getTimePickerToolbarUtilityClass, timePickerToolbarClasses } from './timePickerToolbarClasses';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+
+const useUtilityClasses = ownerState => {
+  const {
+    theme,
+    isLandscape,
+    classes
+  } = ownerState;
+  const slots = {
+    penIconLandscape: ['penIconLandscape'],
+    separator: ['separator'],
+    hourMinuteLabel: ['hourMinuteLabel', isLandscape && 'hourMinuteLabelLandscape', theme.direction === 'rtl' && 'hourMinuteLabelReverse'],
+    ampmSelection: ['ampmSelection', isLandscape && 'ampmLandscape'],
+    ampmLabel: ['ampmLabel']
+  };
+  return composeClasses(slots, getTimePickerToolbarUtilityClass, classes);
+};
+
+const TimePickerToolbarRoot = styled(PickersToolbar)({
+  [`& .${timePickerToolbarClasses.penIconLandscape}`]: {
+    marginTop: 'auto'
+  }
+});
+const TimePickerToolbarSeparator = styled(PickersToolbarText)({
+  outline: 0,
+  margin: '0 4px 0 2px',
+  cursor: 'default'
+});
+const TimePickerToolbarHourMinuteLabel = styled('div')(({
+  theme,
+  ownerState
+}) => _extends({
+  display: 'flex',
+  justifyContent: 'flex-end',
+  alignItems: 'flex-end'
+}, ownerState.isLandscape && {
+  marginTop: 'auto'
+}, theme.direction === 'rtl' && {
+  flexDirection: 'row-reverse'
+}));
+const TimePickerToolbarAmPmSelection = styled('div')(({
+  ownerState
+}) => _extends({
+  display: 'flex',
+  flexDirection: 'column',
+  marginRight: 'auto',
+  marginLeft: 12
+}, ownerState.isLandscape && {
+  margin: '4px 0 auto',
+  flexDirection: 'row',
+  justifyContent: 'space-around',
+  flexBasis: '100%'
+}, {
+  [`& .${timePickerToolbarClasses.ampmLabel}`]: {
+    fontSize: 17
+  }
+}));
+/**
+ * @ignore - internal component.
+ */
+
+export const TimePickerToolbar = props => {
+  const {
+    ampm,
+    ampmInClock,
+    date,
+    isLandscape,
+    isMobileKeyboardViewOpen,
+    onChange,
+    openView,
+    setOpenView,
+    toggleMobileKeyboardView,
+    toolbarTitle = 'Select time',
+    views
+  } = props,
+        other = _objectWithoutPropertiesLoose(props, _excluded);
+
+  const utils = useUtils();
+  const theme = useTheme();
+  const showAmPmControl = Boolean(ampm && !ampmInClock);
+  const {
+    meridiemMode,
+    handleMeridiemChange
+  } = useMeridiemMode(date, ampm, onChange);
+
+  const formatHours = time => ampm ? utils.format(time, 'hours12h') : utils.format(time, 'hours24h');
+
+  const ownerState = props;
+  const classes = useUtilityClasses(_extends({}, ownerState, {
+    theme
+  }));
+
+  const separator = /*#__PURE__*/_jsx(TimePickerToolbarSeparator, {
+    tabIndex: -1,
+    value: ":",
+    variant: "h3",
+    selected: false,
+    className: classes.separator
+  });
+
+  return /*#__PURE__*/_jsxs(TimePickerToolbarRoot, _extends({
+    viewType: "clock",
+    landscapeDirection: "row",
+    toolbarTitle: toolbarTitle,
+    isLandscape: isLandscape,
+    isMobileKeyboardViewOpen: isMobileKeyboardViewOpen,
+    toggleMobileKeyboardView: toggleMobileKeyboardView,
+    ownerState: ownerState,
+    penIconClassName: clsx(isLandscape && classes.penIconLandscape)
+  }, other, {
+    children: [/*#__PURE__*/_jsxs(TimePickerToolbarHourMinuteLabel, {
+      className: classes.hourMinuteLabel,
+      ownerState: ownerState,
+      children: [arrayIncludes(views, 'hours') && /*#__PURE__*/_jsx(PickersToolbarButton, {
+        tabIndex: -1,
+        variant: "h3",
+        onClick: () => setOpenView('hours'),
+        selected: openView === 'hours',
+        value: date ? formatHours(date) : '--'
+      }), arrayIncludes(views, ['hours', 'minutes']) && separator, arrayIncludes(views, 'minutes') && /*#__PURE__*/_jsx(PickersToolbarButton, {
+        tabIndex: -1,
+        variant: "h3",
+        onClick: () => setOpenView('minutes'),
+        selected: openView === 'minutes',
+        value: date ? utils.format(date, 'minutes') : '--'
+      }), arrayIncludes(views, ['minutes', 'seconds']) && separator, arrayIncludes(views, 'seconds') && /*#__PURE__*/_jsx(PickersToolbarButton, {
+        variant: "h3",
+        onClick: () => setOpenView('seconds'),
+        selected: openView === 'seconds',
+        value: date ? utils.format(date, 'seconds') : '--'
+      })]
+    }), showAmPmControl && /*#__PURE__*/_jsxs(TimePickerToolbarAmPmSelection, {
+      className: classes.ampmSelection,
+      ownerState: ownerState,
+      children: [/*#__PURE__*/_jsx(PickersToolbarButton, {
+        disableRipple: true,
+        variant: "subtitle2",
+        selected: meridiemMode === 'am',
+        typographyClassName: classes.ampmLabel,
+        value: utils.getMeridiemText('am'),
+        onClick: () => handleMeridiemChange('am')
+      }), /*#__PURE__*/_jsx(PickersToolbarButton, {
+        disableRipple: true,
+        variant: "subtitle2",
+        selected: meridiemMode === 'pm',
+        typographyClassName: classes.ampmLabel,
+        value: utils.getMeridiemText('pm'),
+        onClick: () => handleMeridiemChange('pm')
+      })]
+    })]
+  }));
+};

package/modern/TimePicker/index.js

@@ -0,0 +1 @@
+export { TimePicker } from './TimePicker';

package/modern/TimePicker/shared.js

@@ -0,0 +1,45 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+const _excluded = ["ampm", "components", "inputFormat", "openTo", "views"];
+import { useThemeProps } from '@mui/material/styles';
+import { Clock } from '../internals/components/icons';
+import { pick12hOr24hFormat } from '../internals/utils/text-field-helper';
+import { useUtils } from '../internals/hooks/useUtils';
+
+function getTextFieldAriaText(value, utils) {
+  return value && utils.isValid(utils.date(value)) ? `Choose time, selected time is ${utils.format(utils.date(value), 'fullTime')}` : 'Choose time';
+}
+
+export function useTimePickerDefaultizedProps(_ref, name) {
+  let {
+    ampm,
+    components,
+    inputFormat,
+    openTo = 'hours',
+    views = ['hours', 'minutes']
+  } = _ref,
+      other = _objectWithoutPropertiesLoose(_ref, _excluded);
+
+  const utils = useUtils();
+  const willUseAmPm = ampm ?? utils.is12HourCycleInCurrentLocale();
+  return useThemeProps({
+    props: _extends({
+      views,
+      openTo,
+      ampm: willUseAmPm,
+      acceptRegex: willUseAmPm ? /[\dapAP]/gi : /\d/gi,
+      mask: '__:__',
+      disableMaskedInput: willUseAmPm,
+      getOpenDialogAriaText: getTextFieldAriaText,
+      components: _extends({
+        OpenPickerIcon: Clock
+      }, components),
+      inputFormat: pick12hOr24hFormat(inputFormat, willUseAmPm, {
+        localized: utils.formats.fullTime,
+        '12h': utils.formats.fullTime12h,
+        '24h': utils.formats.fullTime24h
+      })
+    }, other),
+    name
+  });
+}

package/modern/TimePicker/timePickerToolbarClasses.js

@@ -0,0 +1,5 @@
+import { generateUtilityClass, generateUtilityClasses } from '@mui/material';
+export function getTimePickerToolbarUtilityClass(slot) {
+  return generateUtilityClass('PrivateTimePickerToolbar', slot);
+}
+export const timePickerToolbarClasses = generateUtilityClasses('PrivateTimePickerToolbar', ['separator', 'hourMinuteLabel', 'hourMinuteLabelLandscape', 'hourMinuteLabelReverse', 'ampmSelection', 'ampmLandscape', 'ampmLabel', 'penIconLandscape']);