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

package/DatePicker/shared.d.ts

@@ -0,0 +1,47 @@
+import * as React from 'react';
+import { ParseableDate } from '../internals/models/parseableDate';
+import { OverrideParseableDateProps } from '../internals/hooks/date-helpers-hooks';
+import { CalendarPickerView } from '../internals/models';
+import { ExportedCalendarPickerProps } from '../CalendarPicker/CalendarPicker';
+import { DateValidationError } from '../internals/hooks/validation/useDateValidation';
+import { ValidationProps } from '../internals/hooks/validation/useValidation';
+import { ExportedDateInputProps } from '../internals/components/PureDateInput';
+import { BasePickerProps } from '../internals/models/props/basePickerProps';
+import { BaseToolbarProps } from '../internals/models/props/baseToolbarProps';
+export interface BaseDatePickerProps<TDate> extends ExportedCalendarPickerProps<TDate>, BasePickerProps<ParseableDate<TDate>, TDate | null>, ValidationProps<DateValidationError, ParseableDate<TDate>>, ExportedDateInputProps<ParseableDate<TDate>, TDate | null> {
+    /**
+     * The components used for each slot.
+     * Either a string to use a HTML element or a component.
+     * @default {}
+     */
+    components?: OverrideParseableDateProps<TDate, ExportedCalendarPickerProps<TDate>, 'minDate' | 'maxDate'>['components'] & ExportedDateInputProps<ParseableDate<TDate>, TDate | null>['components'];
+    /**
+     * Callback fired on view change.
+     * @param {CalendarPickerView} view The new view.
+     */
+    onViewChange?: (view: CalendarPickerView) => void;
+    /**
+     * First view to show.
+     */
+    openTo?: CalendarPickerView;
+    /**
+     * Component that will replace default toolbar renderer.
+     * @default DatePickerToolbar
+     */
+    ToolbarComponent?: React.JSXElementConstructor<BaseToolbarProps<TDate | null>>;
+    /**
+     * Mobile picker title, displaying in the toolbar.
+     * @default 'Select date'
+     */
+    toolbarTitle?: React.ReactNode;
+    /**
+     * Array of views to show.
+     */
+    views?: readonly CalendarPickerView[];
+}
+export declare const isYearOnlyView: (views: readonly CalendarPickerView[]) => views is readonly "year"[];
+export declare const isYearAndMonthViews: (views: readonly CalendarPickerView[]) => views is readonly ("month" | "year")[];
+export declare type DefaultizedProps<Props> = Props & {
+    inputFormat: string;
+};
+export declare function useDatePickerDefaultizedProps<TDate, Props extends BaseDatePickerProps<TDate>>({ openTo, views, minDate: minDateProp, maxDate: maxDateProp, ...other }: Props, name: string): DefaultizedProps<Props> & Required<Pick<BaseDatePickerProps<unknown>, 'openTo' | 'views'>>;

package/DatePicker/shared.js

@@ -0,0 +1,54 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+const _excluded = ["openTo", "views", "minDate", "maxDate"];
+import { useThemeProps } from '@mui/material/styles';
+import { useDefaultDates, useUtils } from '../internals/hooks/useUtils';
+export const isYearOnlyView = views => views.length === 1 && views[0] === 'year';
+export const isYearAndMonthViews = views => views.length === 2 && views.indexOf('month') !== -1 && views.indexOf('year') !== -1;
+
+const getFormatAndMaskByViews = (views, utils) => {
+  if (isYearOnlyView(views)) {
+    return {
+      mask: '____',
+      inputFormat: utils.formats.year
+    };
+  }
+
+  if (isYearAndMonthViews(views)) {
+    return {
+      disableMaskedInput: true,
+      inputFormat: utils.formats.monthAndYear
+    };
+  }
+
+  return {
+    mask: '__/__/____',
+    inputFormat: utils.formats.keyboardDate
+  };
+};
+
+export function useDatePickerDefaultizedProps(_ref, name) {
+  let {
+    openTo = 'day',
+    views = ['year', 'day'],
+    minDate: minDateProp,
+    maxDate: maxDateProp
+  } = _ref,
+      other = _objectWithoutPropertiesLoose(_ref, _excluded);
+
+  const utils = useUtils();
+  const defaultDates = useDefaultDates();
+  const minDate = minDateProp != null ? minDateProp : defaultDates.minDate;
+  const maxDate = maxDateProp != null ? maxDateProp : defaultDates.maxDate; // This is technically unsound if the type parameters appear in optional props.
+  // Optional props can be filled by `useThemeProps` with types that don't match the type parameters.
+
+  return useThemeProps({
+    props: _extends({
+      views,
+      openTo,
+      minDate,
+      maxDate
+    }, getFormatAndMaskByViews(views, utils), other),
+    name
+  });
+}

package/DateTimePicker/DateTimePicker.d.ts

@@ -0,0 +1,27 @@
+import * as React from 'react';
+import { DesktopDateTimePickerProps } from '../DesktopDateTimePicker';
+import { MobileDateTimePickerProps } from '../MobileDateTimePicker';
+export interface DateTimePickerProps<TDate = unknown> extends DesktopDateTimePickerProps<TDate>, MobileDateTimePickerProps<TDate> {
+    /**
+     * 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?: string;
+}
+declare type DateTimePickerComponent = (<TDate>(props: DateTimePickerProps<TDate> & React.RefAttributes<HTMLDivElement>) => JSX.Element) & {
+    propTypes?: any;
+};
+/**
+ *
+ * Demos:
+ *
+ * - [Date Time Picker](https://mui.com/components/x/react-date-pickers/date-time-picker/)
+ * - [Pickers](https://mui.com/x/react-date-pickers/)
+ *
+ * API:
+ *
+ * - [DateTimePicker API](https://mui.com/api/date-time-picker/)
+ */
+declare const DateTimePicker: DateTimePickerComponent;
+export { DateTimePicker };

package/DateTimePicker/DateTimePicker.js

@@ -0,0 +1,542 @@
+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 PropTypes from 'prop-types';
+import { useThemeProps } from '@mui/material/styles';
+import useMediaQuery from '@mui/material/useMediaQuery';
+import { DesktopDateTimePicker } from '../DesktopDateTimePicker';
+import { MobileDateTimePicker } from '../MobileDateTimePicker';
+import { jsx as _jsx } from "react/jsx-runtime";
+
+/**
+ *
+ * Demos:
+ *
+ * - [Date Time Picker](https://mui.com/components/x/react-date-pickers/date-time-picker/)
+ * - [Pickers](https://mui.com/x/react-date-pickers/)
+ *
+ * API:
+ *
+ * - [DateTimePicker API](https://mui.com/api/date-time-picker/)
+ */
+const DateTimePicker = /*#__PURE__*/React.forwardRef(function DateTimePicker(inProps, ref) {
+  const props = useThemeProps({
+    props: inProps,
+    name: 'MuiDateTimePicker'
+  });
+
+  const {
+    cancelText,
+    clearable,
+    clearText,
+    desktopModeMediaQuery = '@media (pointer: fine)',
+    DialogProps,
+    okText,
+    PopperProps,
+    showTodayButton,
+    todayText,
+    TransitionComponent
+  } = props,
+        other = _objectWithoutPropertiesLoose(props, _excluded);
+
+  const isDesktop = useMediaQuery(desktopModeMediaQuery);
+  return isDesktop ? /*#__PURE__*/_jsx(DesktopDateTimePicker, _extends({
+    ref: ref,
+    PopperProps: PopperProps,
+    TransitionComponent: TransitionComponent
+  }, other)) : /*#__PURE__*/_jsx(MobileDateTimePicker, _extends({
+    ref: ref,
+    cancelText: cancelText,
+    clearable: clearable,
+    clearText: clearText,
+    DialogProps: DialogProps,
+    okText: okText,
+    showTodayButton: showTodayButton,
+    todayText: todayText
+  }, other));
+});
+process.env.NODE_ENV !== "production" ? DateTimePicker.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),
+
+  /**
+   * If `true`, `onChange` is fired on click even if the same date is selected.
+   * @default false
+   */
+  allowSameDateSelection: PropTypes.bool,
+
+  /**
+   * 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,
+  autoFocus: 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.
+   * @default {}
+   */
+  components: PropTypes.object,
+
+  /**
+   * The props used for each slot inside.
+   * @default {}
+   */
+  componentsProps: PropTypes.object,
+
+  /**
+   * Date tab icon.
+   */
+  dateRangeIcon: PropTypes.node,
+
+  /**
+   * Default calendar month displayed when `value={null}`.
+   */
+  defaultCalendarMonth: PropTypes.any,
+
+  /**
+   * 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.
+   * @default false
+   */
+  disabled: PropTypes.bool,
+
+  /**
+   * @default false
+   */
+  disableFuture: PropTypes.bool,
+
+  /**
+   * If `true`, todays date is rendering without highlighting with circle.
+   * @default false
+   */
+  disableHighlightToday: 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,
+
+  /**
+   * @default false
+   */
+  disablePast: 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,
+
+  /**
+   * Get aria-label text for switching between views button.
+   * @param {CalendarPickerView} currentView The view from which we want to get the button text.
+   * @returns {string} The label of the view.
+   */
+  getViewSwitchingButtonText: PropTypes.func,
+
+  /**
+   * To show tabs.
+   */
+  hideTabs: PropTypes.bool,
+  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,
+
+  /**
+   * Left arrow icon aria-label text.
+   */
+  leftArrowButtonText: PropTypes.string,
+
+  /**
+   * If `true` renders `LoadingComponent` in calendar instead of calendar view.
+   * Can be used to preload information and show it in calendar.
+   * @default false
+   */
+  loading: PropTypes.bool,
+
+  /**
+   * Custom mask. Can be used to override generate from format. (e.g. `__/__/____ __:__` or `__/__/____ __:__ _M`).
+   */
+  mask: PropTypes.string,
+
+  /**
+   * Max selectable date. @DateIOType
+   */
+  maxDate: PropTypes.any,
+
+  /**
+   * Minimal selectable moment of time with binding to date, to set max time in each day use `maxTime`.
+   */
+  maxDateTime: PropTypes.any,
+
+  /**
+   * Max time acceptable time.
+   * For input validation date part of passed object will be ignored if `disableIgnoringDatePartForTimeValidation` not specified.
+   */
+  maxTime: PropTypes.any,
+
+  /**
+   * Min selectable date. @DateIOType
+   */
+  minDate: PropTypes.any,
+
+  /**
+   * Minimal selectable moment of time with binding to date, to set min time in each day use `minTime`.
+   */
+  minDateTime: 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 firing on month change. @DateIOType
+   * @param {TDate} month The new month.
+   */
+  onMonthChange: 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 {CalendarOrClockPickerView} view The new view.
+   */
+  onViewChange: PropTypes.func,
+
+  /**
+   * Callback firing on year change @DateIOType.
+   * @param {TDate} year The new year.
+   */
+  onYearChange: 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(['day', 'hours', 'minutes', 'month', 'seconds', 'year']),
+
+  /**
+   * 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.
+   * @default false
+   */
+  readOnly: PropTypes.bool,
+
+  /**
+   * Disable heavy animations.
+   * @default typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)
+   */
+  reduceAnimations: PropTypes.bool,
+
+  /**
+   * Custom renderer for day. Check the [PickersDay](https://mui.com/api/pickers-day/) component.
+   * @param {TDate} day The day to render.
+   * @param {Array<TDate | null>} selectedDates The dates currently selected.
+   * @param {PickersDayProps<TDate>} pickersDayProps The props of the day to render.
+   * @returns {JSX.Element} The element representing the day.
+   */
+  renderDay: PropTypes.func,
+
+  /**
+   * 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,
+
+  /**
+   * Component displaying when passed `loading` true.
+   * @returns {React.ReactNode} The node to render when loading.
+   * @default () => <span data-mui-test="loading-progress">...</span>
+   */
+  renderLoading: PropTypes.func,
+
+  /**
+   * Custom formatter to be passed into Rifm component.
+   * @param {string} str The un-formatted string.
+   * @returns {string} The formatted string.
+   */
+  rifmFormatter: PropTypes.func,
+
+  /**
+   * Right arrow icon aria-label text.
+   */
+  rightArrowButtonText: PropTypes.string,
+
+  /**
+   * Disable specific date. @DateIOType
+   * @param {TDate} day The date to check.
+   * @returns {boolean} If `true` the day will be disabled.
+   */
+  shouldDisableDate: 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,
+
+  /**
+   * Disable specific years dynamically.
+   * Works like `shouldDisableDate` but for year selection view @DateIOType.
+   * @param {TDate} year The year to test.
+   * @returns {boolean} Return `true` if the year should be disabled.
+   */
+  shouldDisableYear: PropTypes.func,
+
+  /**
+   * If `true`, days that have `outsideCurrentMonth={true}` are displayed.
+   * @default false
+   */
+  showDaysOutsideCurrentMonth: PropTypes.bool,
+
+  /**
+   * 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,
+
+  /**
+   * Time tab icon.
+   */
+  timeIcon: PropTypes.node,
+
+  /**
+   * Today text message.
+   * @default 'Today'
+   */
+  todayText: PropTypes.node,
+
+  /**
+   * Component that will replace default toolbar renderer.
+   * @default DateTimePickerToolbar
+   */
+  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 date & 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(['day', 'hours', 'minutes', 'month', 'seconds', 'year']).isRequired)
+} : void 0;
+export { DateTimePicker };

package/DateTimePicker/DateTimePickerTabs.d.ts

@@ -0,0 +1,12 @@
+import * as React from 'react';
+import { CalendarOrClockPickerView } from '../internals/models';
+export interface DateTimePickerTabsProps {
+    dateRangeIcon?: React.ReactNode;
+    onChange: (view: CalendarOrClockPickerView) => void;
+    timeIcon?: React.ReactNode;
+    view: CalendarOrClockPickerView;
+}
+/**
+ * @ignore - internal component.
+ */
+export declare const DateTimePickerTabs: (props: DateTimePickerTabsProps) => JSX.Element;