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

package/DatePicker/DatePicker.js

@@ -0,0 +1,466 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import { DatePicker as XDatePicker } from '@mui/x-date-pickers/DatePicker';
+import { jsx as _jsx } from "react/jsx-runtime";
+let warnedOnce = false;
+
+const warn = () => {
+  if (!warnedOnce) {
+    console.warn(['MUI: The DatePicker 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 { DatePicker } from '@mui/x-date-pickers'`", "or `import { DatePicker } from '@mui/x-date-pickers/DatePicker'`", '', '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 DatePicker = /*#__PURE__*/React.forwardRef(function DeprecatedDatePicker(props) {
+  warn();
+  return /*#__PURE__*/_jsx(XDatePicker, _extends({}, props));
+});
+process.env.NODE_ENV !== "production" ? DatePicker.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),
+
+  /**
+   * If `true`, `onChange` is fired on click even if the same date is selected.
+   * @default false
+   */
+  allowSameDateSelection: PropTypes.bool,
+
+  /**
+   * @ignore
+   */
+  autoFocus: 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.
+   * @default {}
+   */
+  components: PropTypes.shape({
+    LeftArrowButton: PropTypes.elementType,
+    LeftArrowIcon: PropTypes.elementType,
+    OpenPickerIcon: PropTypes.elementType,
+    RightArrowButton: PropTypes.elementType,
+    RightArrowIcon: PropTypes.elementType,
+    SwitchViewButton: PropTypes.elementType,
+    SwitchViewIcon: PropTypes.elementType
+  }),
+
+  /**
+   * The props used for each slot inside.
+   * @default {}
+   */
+  componentsProps: PropTypes.shape({
+    leftArrowButton: PropTypes.object,
+    rightArrowButton: PropTypes.object,
+    switchViewButton: PropTypes.object
+  }),
+
+  /**
+   * 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`](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.
+   * @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,
+
+  /**
+   * 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,
+
+  /**
+   * 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,
+
+  /**
+   * 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,
+
+  /**
+   * @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,
+
+  /**
+   * 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,
+
+  /**
+   * Min selectable date. @DateIOType
+   */
+  minDate: PropTypes.any,
+
+  /**
+   * 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 firing on month change. @DateIOType
+   * @template TDate
+   * @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 {CalendarPickerView} view The new view.
+   */
+  onViewChange: PropTypes.func,
+
+  /**
+   * Callback firing on year change @DateIOType.
+   * @template TDate
+   * @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', 'month', 'year']),
+
+  /**
+   * Force rendering in particular orientation.
+   */
+  orientation: PropTypes.oneOf(['landscape', 'portrait']),
+
+  /**
+   * Paper props passed down to [Paper](https://mui.com/material-ui/api/paper/) component.
+   */
+  PaperProps: PropTypes.object,
+
+  /**
+   * Popper props passed down to [Popper](https://mui.com/material-ui/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/x/api/date-pickers/pickers-day/) component.
+   * @template TDate
+   * @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/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,
+
+  /**
+   * 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
+   * @template TDate
+   * @param {TDate} day The date to check.
+   * @returns {boolean} If `true` the day will be disabled.
+   */
+  shouldDisableDate: PropTypes.func,
+
+  /**
+   * Disable specific years dynamically.
+   * Works like `shouldDisableDate` but for year selection view @DateIOType.
+   * @template TDate
+   * @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,
+
+  /**
+   * Today text message.
+   * @default 'Today'
+   */
+  todayText: PropTypes.node,
+
+  /**
+   * Component that will replace default toolbar renderer.
+   * @default DatePickerToolbar
+   */
+  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'
+   */
+  toolbarTitle: PropTypes.node,
+
+  /**
+   * Custom component for popper [Transition](https://mui.com/material-ui/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', 'month', 'year']).isRequired)
+} : void 0;
+export default DatePicker;

package/DatePicker/index.d.ts

@@ -1,2 +1,2 @@
-export { DatePicker as default } from '@mui/x-date-pickers/DatePicker';
-export type { DatePickerProps } from '@mui/x-date-pickers/DatePicker';
+export { default } from './DatePicker';
+export type { DatePickerProps } from '@mui/x-date-pickers/DatePicker';

package/DatePicker/index.js

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

package/DateRangePicker/DateRangePicker.d.ts

@@ -1,11 +1,11 @@
-import * as React from 'react';
-declare type DateRangePickerComponent = (<TDate>(props: DateRangePickerProps & React.RefAttributes<HTMLDivElement>) => JSX.Element) & {
-    propTypes?: any;
-};
-/**
- * @ignore - do not document.
- */
-declare const DateRangePicker: DateRangePickerComponent;
-export default DateRangePicker;
-export declare type DateRangePickerProps = Record<any, any>;
-export declare type DateRange<TDate> = [TDate | null, TDate | null];
+import * as React from 'react';
+declare type DateRangePickerComponent = (<TDate>(props: DateRangePickerProps & React.RefAttributes<HTMLDivElement>) => JSX.Element) & {
+    propTypes?: any;
+};
+/**
+ * @ignore - do not document.
+ */
+declare const DateRangePicker: DateRangePickerComponent;
+export default DateRangePicker;
+export declare type DateRangePickerProps = Record<any, any>;
+export declare type DateRange<TDate> = [TDate | null, TDate | null];

package/DateRangePicker/index.d.ts

@@ -1,2 +1,2 @@
-export { default } from './DateRangePicker';
-export * from './DateRangePicker';
+export { default } from './DateRangePicker';
+export * from './DateRangePicker';

package/DateRangePickerDay/DateRangePickerDay.d.ts

@@ -1,13 +1,13 @@
-import * as React from 'react';
-declare type DateRangePickerDayComponent = (<TDate>(props: DateRangePickerDayProps & React.RefAttributes<HTMLDivElement>) => JSX.Element) & {
-    propTypes?: any;
-};
-/**
- * @ignore - do not document.
- */
-declare const DateRangePickerDay: DateRangePickerDayComponent;
-export default DateRangePickerDay;
-export declare const getDateRangePickerDayUtilityClass: (slot: string) => string;
-export declare type DateRangePickerDayProps = Record<any, any>;
-export declare type DateRangePickerDayClasses = any;
-export declare type DateRangePickerDayClassKey = any;
+import * as React from 'react';
+declare type DateRangePickerDayComponent = (<TDate>(props: DateRangePickerDayProps & React.RefAttributes<HTMLDivElement>) => JSX.Element) & {
+    propTypes?: any;
+};
+/**
+ * @ignore - do not document.
+ */
+declare const DateRangePickerDay: DateRangePickerDayComponent;
+export default DateRangePickerDay;
+export declare const getDateRangePickerDayUtilityClass: (slot: string) => string;
+export declare type DateRangePickerDayProps = Record<any, any>;
+export declare type DateRangePickerDayClasses = any;
+export declare type DateRangePickerDayClassKey = any;

package/DateRangePickerDay/index.d.ts

@@ -1,2 +1,2 @@
-export { default } from './DateRangePickerDay';
-export * from './DateRangePickerDay';
+export { default } from './DateRangePickerDay';
+export * from './DateRangePickerDay';

package/DateTimePicker/DateTimePicker.d.ts

@@ -0,0 +1,10 @@
+import * as React from 'react';
+import { DateTimePickerProps } from '@mui/x-date-pickers/DateTimePicker';
+declare type DateTimePickerComponent = (<TDate>(props: DateTimePickerProps<TDate> & React.RefAttributes<HTMLDivElement>) => JSX.Element) & {
+    propTypes?: any;
+};
+/**
+ * @ignore - do not document.
+ */
+declare const DateTimePicker: DateTimePickerComponent;
+export default DateTimePicker;