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

package/DesktopTimePicker/DesktopTimePicker.js

@@ -0,0 +1,361 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+const _excluded = ["onChange", "PopperProps", "ToolbarComponent", "TransitionComponent", "value"];
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import { useTimePickerDefaultizedProps } from '../TimePicker/shared';
+import { TimePickerToolbar } from '../TimePicker/TimePickerToolbar';
+import { DesktopWrapper } from '../internals/components/wrappers/DesktopWrapper';
+import { CalendarOrClockPicker } from '../internals/components/CalendarOrClockPicker';
+import { useTimeValidation } from '../internals/hooks/validation/useTimeValidation';
+import { parsePickerInputValue } from '../internals/utils/date-utils';
+import { KeyboardDateInput } from '../internals/components/KeyboardDateInput';
+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:
+ *
+ * - [DesktopTimePicker API](https://mui.com/api/desktop-time-picker/)
+ */
+export const DesktopTimePicker = /*#__PURE__*/React.forwardRef(function DesktopTimePicker(inProps, ref) {
+  // TODO: TDate needs to be instantiated at every usage.
+  const props = useTimePickerDefaultizedProps(inProps, 'MuiDesktopTimePicker');
+  const validationError = useTimeValidation(props) !== null;
+  const {
+    pickerProps,
+    inputProps,
+    wrapperProps
+  } = usePickerState(props, valueManager);
+
+  const {
+    PopperProps,
+    ToolbarComponent = TimePickerToolbar,
+    TransitionComponent
+  } = props,
+        other = _objectWithoutPropertiesLoose(props, _excluded);
+
+  const DateInputProps = _extends({}, inputProps, other, {
+    ref,
+    validationError
+  });
+
+  return /*#__PURE__*/_jsx(DesktopWrapper, _extends({}, wrapperProps, {
+    DateInputProps: DateInputProps,
+    KeyboardDateInputComponent: KeyboardDateInput,
+    PopperProps: PopperProps,
+    TransitionComponent: TransitionComponent,
+    children: /*#__PURE__*/_jsx(CalendarOrClockPicker, _extends({}, pickerProps, {
+      autoFocus: true,
+      toolbarTitle: props.label || props.toolbarTitle,
+      ToolbarComponent: ToolbarComponent,
+      DateInputProps: DateInputProps
+    }, other))
+  }));
+});
+process.env.NODE_ENV !== "production" ? DesktopTimePicker.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,
+  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,
+
+  /**
+   * 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,
+
+  /**
+   * 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']),
+
+  /**
+   * 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.
+   */
+  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`, show the toolbar even in desktop mode.
+   */
+  showToolbar: PropTypes.bool,
+
+  /**
+   * 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,
+
+  /**
+   * 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(['hours', 'minutes', 'seconds']).isRequired)
+} : void 0;

package/DesktopTimePicker/index.d.ts

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

package/DesktopTimePicker/index.js

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

package/DesktopTimePicker/package.json

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

package/LocalizationProvider/LocalizationProvider.d.ts

@@ -0,0 +1,34 @@
+import * as React from 'react';
+import { DateIOFormats } from '@date-io/core/IUtils';
+import { MuiPickersAdapter } from '../internals/models';
+export interface MuiPickersAdapterContextValue<TDate> {
+    defaultDates: {
+        minDate: TDate;
+        maxDate: TDate;
+    };
+    utils: MuiPickersAdapter<TDate>;
+}
+export declare const MuiPickersAdapterContext: React.Context<MuiPickersAdapterContextValue<unknown> | null>;
+export interface LocalizationProviderProps {
+    children?: React.ReactNode;
+    /** DateIO adapter class function */
+    dateAdapter: new (...args: any) => MuiPickersAdapter<unknown>;
+    /** Formats that are used for any child pickers */
+    dateFormats?: Partial<DateIOFormats>;
+    /**
+     * Date library instance you are using, if it has some global overrides
+     * ```jsx
+     * dateLibInstance={momentTimeZone}
+     * ```
+     */
+    dateLibInstance?: any;
+    /** Locale for the date library you are using */
+    locale?: string | object;
+}
+/**
+ * @ignore - do not document.
+ */
+export declare function LocalizationProvider(props: LocalizationProviderProps): JSX.Element;
+export declare namespace LocalizationProvider {
+    var propTypes: any;
+}

package/LocalizationProvider/LocalizationProvider.js

@@ -0,0 +1,100 @@
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import { jsx as _jsx } from "react/jsx-runtime";
+export const MuiPickersAdapterContext = /*#__PURE__*/React.createContext(null);
+
+if (process.env.NODE_ENV !== 'production') {
+  MuiPickersAdapterContext.displayName = 'MuiPickersAdapterContext';
+}
+
+/**
+ * @ignore - do not document.
+ */
+export function LocalizationProvider(props) {
+  const {
+    children,
+    dateAdapter: Utils,
+    dateFormats,
+    dateLibInstance,
+    locale
+  } = props;
+  const utils = React.useMemo(() => new Utils({
+    locale,
+    formats: dateFormats,
+    instance: dateLibInstance
+  }), [Utils, locale, dateFormats, dateLibInstance]);
+  const defaultDates = React.useMemo(() => {
+    return {
+      minDate: utils.date('1900-01-01T00:00:00.000'),
+      maxDate: utils.date('2099-12-31T00:00:00.000')
+    };
+  }, [utils]);
+  const contextValue = React.useMemo(() => {
+    return {
+      utils,
+      defaultDates
+    };
+  }, [defaultDates, utils]);
+  return /*#__PURE__*/_jsx(MuiPickersAdapterContext.Provider, {
+    value: contextValue,
+    children: children
+  });
+}
+process.env.NODE_ENV !== "production" ? LocalizationProvider.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "yarn proptypes"  |
+  // ----------------------------------------------------------------------
+  children: PropTypes.node,
+
+  /**
+   * DateIO adapter class function
+   */
+  dateAdapter: PropTypes.func.isRequired,
+
+  /**
+   * Formats that are used for any child pickers
+   */
+  dateFormats: PropTypes.shape({
+    dayOfMonth: PropTypes.string,
+    fullDate: PropTypes.string,
+    fullDateTime: PropTypes.string,
+    fullDateTime12h: PropTypes.string,
+    fullDateTime24h: PropTypes.string,
+    fullDateWithWeekday: PropTypes.string,
+    fullTime: PropTypes.string,
+    fullTime12h: PropTypes.string,
+    fullTime24h: PropTypes.string,
+    hours12h: PropTypes.string,
+    hours24h: PropTypes.string,
+    keyboardDate: PropTypes.string,
+    keyboardDateTime: PropTypes.string,
+    keyboardDateTime12h: PropTypes.string,
+    keyboardDateTime24h: PropTypes.string,
+    minutes: PropTypes.string,
+    month: PropTypes.string,
+    monthAndDate: PropTypes.string,
+    monthAndYear: PropTypes.string,
+    monthShort: PropTypes.string,
+    normalDate: PropTypes.string,
+    normalDateWithWeekday: PropTypes.string,
+    seconds: PropTypes.string,
+    shortDate: PropTypes.string,
+    weekday: PropTypes.string,
+    weekdayShort: PropTypes.string,
+    year: PropTypes.string
+  }),
+
+  /**
+   * Date library instance you are using, if it has some global overrides
+   * ```jsx
+   * dateLibInstance={momentTimeZone}
+   * ```
+   */
+  dateLibInstance: PropTypes.any,
+
+  /**
+   * Locale for the date library you are using
+   */
+  locale: PropTypes.oneOfType([PropTypes.object, PropTypes.string])
+} : void 0;

package/LocalizationProvider/index.d.ts

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

package/LocalizationProvider/index.js

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

package/LocalizationProvider/package.json

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

package/MobileDatePicker/MobileDatePicker.d.ts

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