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

package/MobileDateTimePicker/MobileDateTimePicker.js

@@ -0,0 +1,523 @@
+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 { useDateTimePickerDefaultizedProps } from '../DateTimePicker/shared';
+import { DateTimePickerToolbar } from '../DateTimePicker/DateTimePickerToolbar';
+import { MobileWrapper } from '../internals/components/wrappers/MobileWrapper';
+import { CalendarOrClockPicker } from '../internals/components/CalendarOrClockPicker';
+import { useDateTimeValidation } from '../internals/hooks/validation/useDateTimeValidation';
+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:
+ *
+ * - [Date Time Picker](https://mui.com/components/x/react-date-pickers/date-time-picker/)
+ *
+ * API:
+ *
+ * - [MobileDateTimePicker API](https://mui.com/api/mobile-date-time-picker/)
+ */
+export const MobileDateTimePicker = /*#__PURE__*/React.forwardRef(function MobileDateTimePicker(inProps, ref) {
+  // TODO: TDate needs to be instantiated at every usage.
+  const props = useDateTimePickerDefaultizedProps(inProps, 'MuiMobileDateTimePicker');
+  const validationError = useDateTimeValidation(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 = DateTimePickerToolbar
+  } = 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" ? MobileDateTimePicker.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,
+
+  /**
+   * 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']),
+
+  /**
+   * 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,
+
+  /**
+   * 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;

package/MobileDateTimePicker/index.d.ts

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

package/MobileDateTimePicker/index.js

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

package/MobileDateTimePicker/package.json

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

package/MobileTimePicker/MobileTimePicker.d.ts

@@ -0,0 +1,20 @@
+import * as React from 'react';
+import { BaseTimePickerProps } from '../TimePicker/shared';
+import { MobileWrapperProps } from '../internals/components/wrappers/MobileWrapper';
+export interface MobileTimePickerProps<TDate = unknown> extends BaseTimePickerProps<TDate>, MobileWrapperProps {
+}
+declare type MobileTimePickerComponent = (<TDate>(props: MobileTimePickerProps<TDate> & React.RefAttributes<HTMLDivElement>) => JSX.Element) & {
+    propTypes?: any;
+};
+/**
+ *
+ * Demos:
+ *
+ * - [Time Picker](https://mui.com/components/x/react-date-pickers/time-picker/)
+ *
+ * API:
+ *
+ * - [MobileTimePicker API](https://mui.com/api/mobile-time-picker/)
+ */
+export declare const MobileTimePicker: MobileTimePickerComponent;
+export {};