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

package/MobileTimePicker/MobileTimePicker.js

@@ -0,0 +1,372 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+const _excluded = ["ToolbarComponent", "value", "onChange"];
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import { useTimePickerDefaultizedProps } from '../TimePicker/shared';
+import { TimePickerToolbar } from '../TimePicker/TimePickerToolbar';
+import { MobileWrapper } from '../internals/components/wrappers/MobileWrapper';
+import { CalendarOrClockPicker } from '../internals/components/CalendarOrClockPicker';
+import { useTimeValidation } from '../internals/hooks/validation/useTimeValidation';
+import { parsePickerInputValue } from '../internals/utils/date-utils';
+import { PureDateInput } from '../internals/components/PureDateInput';
+import { usePickerState } from '../internals/hooks/usePickerState';
+import { jsx as _jsx } from "react/jsx-runtime";
+const valueManager = {
+  emptyValue: null,
+  parseInput: parsePickerInputValue,
+  areValuesEqual: (utils, a, b) => utils.isEqual(a, b)
+};
+
+/**
+ *
+ * Demos:
+ *
+ * - [Time Picker](https://mui.com/components/x/react-date-pickers/time-picker/)
+ *
+ * API:
+ *
+ * - [MobileTimePicker API](https://mui.com/api/mobile-time-picker/)
+ */
+export const MobileTimePicker = /*#__PURE__*/React.forwardRef(function MobileTimePicker(inProps, ref) {
+  // TODO: TDate needs to be instantiated at every usage.
+  const props = useTimePickerDefaultizedProps(inProps, 'MuiMobileTimePicker');
+  const validationError = useTimeValidation(props) !== null;
+  const {
+    pickerProps,
+    inputProps,
+    wrapperProps
+  } = usePickerState(props, valueManager); // Note that we are passing down all the value without spread.
+  // It saves us >1kb gzip and make any prop available automatically on any level down.
+
+  const {
+    ToolbarComponent = TimePickerToolbar
+  } = props,
+        other = _objectWithoutPropertiesLoose(props, _excluded);
+
+  const DateInputProps = _extends({}, inputProps, other, {
+    ref,
+    validationError
+  });
+
+  return /*#__PURE__*/_jsx(MobileWrapper, _extends({}, other, wrapperProps, {
+    DateInputProps: DateInputProps,
+    PureDateInputComponent: PureDateInput,
+    children: /*#__PURE__*/_jsx(CalendarOrClockPicker, _extends({}, pickerProps, {
+      autoFocus: true,
+      toolbarTitle: props.label || props.toolbarTitle,
+      ToolbarComponent: ToolbarComponent,
+      DateInputProps: DateInputProps
+    }, other))
+  }));
+});
+process.env.NODE_ENV !== "production" ? MobileTimePicker.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,
+
+  /**
+   * 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']),
+
+  /**
+   * 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,
+
+  /**
+   * 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/MobileTimePicker/index.d.ts

@@ -0,0 +1,2 @@
+export { MobileTimePicker } from './MobileTimePicker';
+export type { MobileTimePickerProps } from './MobileTimePicker';

package/MobileTimePicker/index.js

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

package/MobileTimePicker/package.json

@@ -0,0 +1,6 @@
+{
+  "sideEffects": false,
+  "module": "./index.js",
+  "main": "../node/MobileTimePicker/index.js",
+  "types": "./index.d.ts"
+}

package/MonthPicker/MonthPicker.d.ts

@@ -0,0 +1,41 @@
+import * as React from 'react';
+import { SxProps } from '@mui/system';
+import { Theme } from '@mui/material/styles';
+import { PickerOnChangeFn } from '../internals/hooks/useViews';
+import { MonthPickerClasses } from './monthPickerClasses';
+export interface MonthPickerProps<TDate> {
+    /**
+     * className applied to the root element.
+     */
+    className?: string;
+    /**
+     * Override or extend the styles applied to the component.
+     */
+    classes?: Partial<MonthPickerClasses>;
+    /** Date value for the MonthPicker */
+    date: TDate | null;
+    /** If `true` picker is disabled */
+    disabled?: boolean;
+    /** If `true` past days are disabled. */
+    disablePast?: boolean | null;
+    /** If `true` future days are disabled. */
+    disableFuture?: boolean | null;
+    /** Minimal selectable date. */
+    minDate: TDate;
+    /** Maximal selectable date. */
+    maxDate: TDate;
+    /** Callback fired on date change. */
+    onChange: PickerOnChangeFn<TDate>;
+    onMonthChange?: (date: TDate) => void | Promise<void>;
+    /** If `true` picker is readonly */
+    readOnly?: boolean;
+    /**
+     * The system prop that allows defining system overrides as well as additional CSS styles.
+     */
+    sx?: SxProps<Theme>;
+}
+declare type MonthPickerComponent = (<TDate>(props: MonthPickerProps<TDate> & React.RefAttributes<HTMLDivElement>) => JSX.Element) & {
+    propTypes?: any;
+};
+export declare const MonthPicker: MonthPickerComponent;
+export {};

package/MonthPicker/MonthPicker.js

@@ -0,0 +1,161 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+const _excluded = ["className", "date", "disabled", "disableFuture", "disablePast", "maxDate", "minDate", "onChange", "onMonthChange", "readOnly"];
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import clsx from 'clsx';
+import { styled, useThemeProps } from '@mui/material/styles';
+import { unstable_composeClasses as composeClasses } from '@mui/material';
+import { PickersMonth } from './PickersMonth';
+import { useUtils, useNow } from '../internals/hooks/useUtils';
+import { getMonthPickerUtilityClass } from './monthPickerClasses';
+import { jsx as _jsx } from "react/jsx-runtime";
+
+const useUtilityClasses = ownerState => {
+  const {
+    classes
+  } = ownerState;
+  const slots = {
+    root: ['root']
+  };
+  return composeClasses(slots, getMonthPickerUtilityClass, classes);
+};
+
+const MonthPickerRoot = styled('div', {
+  name: 'MuiMonthPicker',
+  slot: 'Root',
+  overridesResolver: (props, styles) => styles.root
+})({
+  width: 310,
+  display: 'flex',
+  flexWrap: 'wrap',
+  alignContent: 'stretch',
+  margin: '0 4px'
+});
+export const MonthPicker = /*#__PURE__*/React.forwardRef(function MonthPicker(inProps, ref) {
+  const props = useThemeProps({
+    props: inProps,
+    name: 'MuiMonthPicker'
+  });
+
+  const {
+    className,
+    date,
+    disabled,
+    disableFuture,
+    disablePast,
+    maxDate,
+    minDate,
+    onChange,
+    onMonthChange,
+    readOnly
+  } = props,
+        other = _objectWithoutPropertiesLoose(props, _excluded);
+
+  const ownerState = props;
+  const classes = useUtilityClasses(ownerState);
+  const utils = useUtils();
+  const now = useNow();
+  const currentMonth = utils.getMonth(date || now);
+
+  const shouldDisableMonth = month => {
+    const firstEnabledMonth = utils.startOfMonth(disablePast && utils.isAfter(now, minDate) ? now : minDate);
+    const lastEnabledMonth = utils.startOfMonth(disableFuture && utils.isBefore(now, maxDate) ? now : maxDate);
+    const isBeforeFirstEnabled = utils.isBefore(month, firstEnabledMonth);
+    const isAfterLastEnabled = utils.isAfter(month, lastEnabledMonth);
+    return isBeforeFirstEnabled || isAfterLastEnabled;
+  };
+
+  const onMonthSelect = month => {
+    if (readOnly) {
+      return;
+    }
+
+    const newDate = utils.setMonth(date || now, month);
+    onChange(newDate, 'finish');
+
+    if (onMonthChange) {
+      onMonthChange(newDate);
+    }
+  };
+
+  return /*#__PURE__*/_jsx(MonthPickerRoot, _extends({
+    ref: ref,
+    className: clsx(classes.root, className),
+    ownerState: ownerState
+  }, other, {
+    children: utils.getMonthArray(date || now).map(month => {
+      const monthNumber = utils.getMonth(month);
+      const monthText = utils.format(month, 'monthShort');
+      return /*#__PURE__*/_jsx(PickersMonth, {
+        value: monthNumber,
+        selected: monthNumber === currentMonth,
+        onSelect: onMonthSelect,
+        disabled: disabled || shouldDisableMonth(month),
+        children: monthText
+      }, monthText);
+    })
+  }));
+});
+process.env.NODE_ENV !== "production" ? MonthPicker.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "yarn proptypes"  |
+  // ----------------------------------------------------------------------
+
+  /**
+   * Override or extend the styles applied to the component.
+   */
+  classes: PropTypes.object,
+
+  /**
+   * className applied to the root element.
+   */
+  className: PropTypes.string,
+
+  /**
+   * Date value for the MonthPicker
+   */
+  date: PropTypes.any,
+
+  /**
+   * If `true` picker is disabled
+   */
+  disabled: PropTypes.bool,
+
+  /**
+   * If `true` future days are disabled.
+   */
+  disableFuture: PropTypes.bool,
+
+  /**
+   * If `true` past days are disabled.
+   */
+  disablePast: PropTypes.bool,
+
+  /**
+   * Maximal selectable date.
+   */
+  maxDate: PropTypes.any.isRequired,
+
+  /**
+   * Minimal selectable date.
+   */
+  minDate: PropTypes.any.isRequired,
+
+  /**
+   * Callback fired on date change.
+   */
+  onChange: PropTypes.func.isRequired,
+  onMonthChange: PropTypes.func,
+
+  /**
+   * If `true` picker is readonly
+   */
+  readOnly: PropTypes.bool,
+
+  /**
+   * 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])
+} : void 0;

package/MonthPicker/PickersMonth.d.ts

@@ -0,0 +1,15 @@
+import * as React from 'react';
+declare const classes: Record<"root" | "selected", string>;
+export interface MonthProps {
+    children: React.ReactNode;
+    disabled?: boolean;
+    onSelect: (value: any) => void;
+    selected?: boolean;
+    value: any;
+}
+export declare type PickersMonthClassKey = keyof typeof classes;
+/**
+ * @ignore - do not document.
+ */
+export declare const PickersMonth: React.FC<MonthProps>;
+export {};

package/MonthPicker/PickersMonth.js

@@ -0,0 +1,70 @@
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+import _extends from "@babel/runtime/helpers/esm/extends";
+const _excluded = ["disabled", "onSelect", "selected", "value"];
+import * as React from 'react';
+import clsx from 'clsx';
+import Typography from '@mui/material/Typography';
+import { styled, alpha } from '@mui/material/styles';
+import { generateUtilityClasses } from '@mui/material';
+import { onSpaceOrEnter } from '../internals/utils/utils';
+import { jsx as _jsx } from "react/jsx-runtime";
+const classes = generateUtilityClasses('PrivatePickersMonth', ['root', 'selected']);
+const PickersMonthRoot = styled(Typography)(({
+  theme
+}) => _extends({
+  flex: '1 0 33.33%',
+  display: 'flex',
+  alignItems: 'center',
+  justifyContent: 'center',
+  color: 'unset',
+  backgroundColor: 'transparent',
+  border: 0,
+  outline: 0
+}, theme.typography.subtitle1, {
+  margin: '8px 0',
+  height: 36,
+  borderRadius: 18,
+  cursor: 'pointer',
+  '&:focus, &:hover': {
+    backgroundColor: alpha(theme.palette.action.active, theme.palette.action.hoverOpacity)
+  },
+  '&:disabled': {
+    pointerEvents: 'none',
+    color: theme.palette.text.secondary
+  },
+  [`&.${classes.selected}`]: {
+    color: theme.palette.primary.contrastText,
+    backgroundColor: theme.palette.primary.main,
+    '&:focus, &:hover': {
+      backgroundColor: theme.palette.primary.dark
+    }
+  }
+}));
+/**
+ * @ignore - do not document.
+ */
+
+export const PickersMonth = props => {
+  const {
+    disabled,
+    onSelect,
+    selected,
+    value
+  } = props,
+        other = _objectWithoutPropertiesLoose(props, _excluded);
+
+  const handleSelection = () => {
+    onSelect(value);
+  };
+
+  return /*#__PURE__*/_jsx(PickersMonthRoot, _extends({
+    component: "button",
+    className: clsx(classes.root, selected && classes.selected),
+    tabIndex: disabled ? -1 : 0,
+    onClick: handleSelection,
+    onKeyDown: onSpaceOrEnter(handleSelection),
+    color: selected ? 'primary' : undefined,
+    variant: selected ? 'h5' : 'subtitle1',
+    disabled: disabled
+  }, other));
+};

package/MonthPicker/index.d.ts

@@ -0,0 +1,4 @@
+export { MonthPicker } from './MonthPicker';
+export type { MonthPickerProps } from './MonthPicker';
+export { monthPickerClasses, getMonthPickerUtilityClass } from './monthPickerClasses';
+export type { MonthPickerClasses, MonthPickerClassKey } from './monthPickerClasses';

package/MonthPicker/index.js

@@ -0,0 +1,2 @@
+export { MonthPicker } from './MonthPicker';
+export { monthPickerClasses, getMonthPickerUtilityClass } from './monthPickerClasses';

package/MonthPicker/monthPickerClasses.d.ts

@@ -0,0 +1,7 @@
+export declare function getMonthPickerUtilityClass(slot: string): string;
+export interface MonthPickerClasses {
+    /** Styles applied to the root element. */
+    root: string;
+}
+export declare type MonthPickerClassKey = keyof MonthPickerClasses;
+export declare const monthPickerClasses: Record<"root", string>;