@mui/lab 5.0.0-alpha.82 → 5.0.0-alpha.85

package/modern/MobileTimePicker/MobileTimePicker.js

@@ -0,0 +1,362 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import { MobileTimePicker as XMobileTimePicker } from '@mui/x-date-pickers/MobileTimePicker';
+import { jsx as _jsx } from "react/jsx-runtime";
+let warnedOnce = false;
+
+const warn = () => {
+  if (!warnedOnce) {
+    console.warn(['MUI: The MobileTimePicker component was moved from `@mui/lab` to `@mui/x-date-pickers`.', 'The component will no longer be exported from `@mui/lab` in the first release of July 2022.', '', "You should use `import { MobileTimePicker } from '@mui/x-date-pickers'`", "or `import { MobileTimePicker } from '@mui/x-date-pickers/MobileTimePicker'`", '', 'More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.'].join('\n'));
+    warnedOnce = true;
+  }
+};
+
+/**
+ * @ignore - do not document.
+ */
+const MobileTimePicker = /*#__PURE__*/React.forwardRef(function DeprecatedMobileTimePicker(props) {
+  warn();
+  return /*#__PURE__*/_jsx(XMobileTimePicker, _extends({}, props));
+});
+process.env.NODE_ENV !== "production" ? MobileTimePicker.propTypes
+/* remove-proptypes */
+= {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // |     To update them edit 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,
+
+  /**
+   * @ignore
+   */
+  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 an HTML element or a component.
+   */
+  components: PropTypes.shape({
+    OpenPickerIcon: PropTypes.elementType
+  }),
+
+  /**
+   * Props applied to the [`Dialog`](https://mui.com/material-ui/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.
+   * @template TDate
+   * @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
+   * @template TDateValue
+   * @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.
+   * @default (value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}`
+   */
+  getOpenDialogAriaText: PropTypes.func,
+
+  /**
+   * @ignore
+   */
+  ignoreInvalidInputs: PropTypes.bool,
+
+  /**
+   * Props to pass to keyboard input adornment.
+   */
+  InputAdornmentProps: PropTypes.object,
+
+  /**
+   * Format string.
+   */
+  inputFormat: PropTypes.string,
+
+  /**
+   * @ignore
+   */
+  InputProps: PropTypes.object,
+
+  /**
+   * Pass a ref to the `input` element.
+   */
+  inputRef: PropTypes.oneOfType([PropTypes.func, PropTypes.shape({
+    current: PropTypes.object
+  })]),
+
+  /**
+   * @ignore
+   */
+  key: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+
+  /**
+   * @ignore
+   */
+  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.
+   * @template TDateValue
+   * @param {TDateValue} date The date that was just accepted.
+   */
+  onAccept: PropTypes.func,
+
+  /**
+   * Callback fired when the value (the selected date) changes @DateIOType.
+   * @template TDate
+   * @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
+   *
+   * @template TError, TDateValue
+   * @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/material-ui/api/text-field/#props) 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;
+export default MobileTimePicker;

package/modern/MobileTimePicker/index.js

@@ -1 +1 @@
-export { MobileTimePicker as default } from '@mui/x-date-pickers/MobileTimePicker';
+export { default } from './MobileTimePicker';

package/modern/MonthPicker/MonthPicker.js

@@ -0,0 +1,21 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import * as React from 'react';
+import { MonthPicker as XMonthPicker } from '@mui/x-date-pickers/MonthPicker';
+import { jsx as _jsx } from "react/jsx-runtime";
+let warnedOnce = false;
+
+const warn = () => {
+  if (!warnedOnce) {
+    console.warn(['MUI: The MonthPicker component was moved from `@mui/lab` to `@mui/x-date-pickers`.', 'The component will no longer be exported from `@mui/lab` in the first release of July 2022.', '', "You should use `import { MonthPicker } from '@mui/x-date-pickers'`", "or `import { MonthPicker } from '@mui/x-date-pickers/MonthPicker'`", '', 'More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.'].join('\n'));
+    warnedOnce = true;
+  }
+};
+
+/**
+ * @ignore - do not document.
+ */
+const MonthPicker = /*#__PURE__*/React.forwardRef(function DeprecatedMonthPicker(props) {
+  warn();
+  return /*#__PURE__*/_jsx(XMonthPicker, _extends({}, props));
+});
+export default MonthPicker;

package/modern/MonthPicker/index.js

@@ -1 +1,2 @@
-export { MonthPicker as default, getMonthPickerUtilityClass, monthPickerClasses } from '@mui/x-date-pickers/MonthPicker';
+export { default } from './MonthPicker';
+export { getMonthPickerUtilityClass, monthPickerClasses } from '@mui/x-date-pickers/MonthPicker';

package/modern/PickersDay/PickersDay.js

@@ -0,0 +1,35 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import { PickersDay as XPickersDay } from '@mui/x-date-pickers/PickersDay';
+import { jsx as _jsx } from "react/jsx-runtime";
+let warnedOnce = false;
+
+const warn = () => {
+  if (!warnedOnce) {
+    console.warn(['MUI: The PickersDay component was moved from `@mui/lab` to `@mui/x-date-pickers`.', 'The component will no longer be exported from `@mui/lab` in the first release of July 2022.', '', "You should use `import { PickersDay } from '@mui/x-date-pickers'`", "or `import { PickersDay } from '@mui/x-date-pickers/PickersDay'`", '', 'More information about this migration on our blog: https://mui.com/blog/lab-date-pickers-to-mui-x/.'].join('\n'));
+    warnedOnce = true;
+  }
+};
+
+/**
+ * @ignore - do not document.
+ */
+const PickersDay = /*#__PURE__*/React.forwardRef(function DeprecatedPickersDay(props) {
+  warn();
+  return /*#__PURE__*/_jsx(XPickersDay, _extends({}, props));
+});
+process.env.NODE_ENV !== "production" ? PickersDay.propTypes
+/* remove-proptypes */
+= {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // |     To update them edit TypeScript types and run "yarn proptypes"  |
+  // ----------------------------------------------------------------------
+
+  /**
+   * The content of the component.
+   */
+  children: PropTypes.node
+} : void 0;
+export default PickersDay;

package/modern/PickersDay/index.js

@@ -1 +1,2 @@
-export { PickersDay as default, pickersDayClasses, getPickersDayUtilityClass } from '@mui/x-date-pickers/PickersDay';
+export { default } from './PickersDay';
+export { pickersDayClasses, getPickersDayUtilityClass } from '@mui/x-date-pickers/PickersDay';