@mui/x-date-pickers-pro 8.0.0-alpha.9 → 8.0.0-beta.0

package/esm/DesktopTimeRangePicker/DesktopTimeRangePicker.js

@@ -0,0 +1,388 @@
+'use client';
+
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+const _excluded = ["openTo"];
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import resolveComponentProps from '@mui/utils/resolveComponentProps';
+import { useUtils, resolveTimeFormat, mergeSx, MULTI_SECTION_CLOCK_SECTION_WIDTH } from '@mui/x-date-pickers/internals';
+import { extractValidationProps } from '@mui/x-date-pickers/validation';
+import { multiSectionDigitalClockClasses, multiSectionDigitalClockSectionClasses } from '@mui/x-date-pickers/MultiSectionDigitalClock';
+import { digitalClockClasses } from '@mui/x-date-pickers/DigitalClock';
+import { renderDigitalClockTimeView, renderMultiSectionDigitalClockTimeView } from '@mui/x-date-pickers/timeViewRenderers';
+import { pickersLayoutClasses } from '@mui/x-date-pickers/PickersLayout';
+import { rangeValueManager } from "../internals/utils/valueManagers.js";
+import { useTimeRangePickerDefaultizedProps } from "../TimeRangePicker/shared.js";
+import { SingleInputTimeRangeField } from "../SingleInputTimeRangeField/index.js";
+import { useDesktopRangePicker } from "../internals/hooks/useDesktopRangePicker/index.js";
+import { validateTimeRange } from "../validation/validateTimeRange.js";
+import { RANGE_VIEW_HEIGHT } from "../internals/constants/dimensions.js";
+import { TimeRangePickerTimeWrapper } from "../TimeRangePicker/TimeRangePickerTimeWrapper.js";
+import { jsx as _jsx } from "react/jsx-runtime";
+const rendererInterceptor = function RendererInterceptor(props) {
+  const {
+    viewRenderers,
+    popperView,
+    rendererProps
+  } = props;
+  const otherProps = _objectWithoutPropertiesLoose(rendererProps, _excluded);
+  const finalProps = _extends({}, otherProps, {
+    sx: [{
+      [`&.${multiSectionDigitalClockClasses.root}`]: {
+        [`.${multiSectionDigitalClockSectionClasses.root}`]: {
+          flex: 1
+        },
+        [`.${multiSectionDigitalClockSectionClasses.item}`]: {
+          width: 'auto',
+          // avoid layout shift when hovering over a section with default width
+          minWidth: MULTI_SECTION_CLOCK_SECTION_WIDTH
+        }
+      },
+      [`&.${digitalClockClasses.root} .${digitalClockClasses.item}`]: {
+        justifyContent: 'center'
+      },
+      [`&.${multiSectionDigitalClockClasses.root}, .${multiSectionDigitalClockSectionClasses.root}, &.${digitalClockClasses.root}`]: {
+        maxHeight: RANGE_VIEW_HEIGHT
+      }
+    }]
+  });
+  const viewRenderer = viewRenderers[popperView];
+  return /*#__PURE__*/_jsx(TimeRangePickerTimeWrapper, _extends({}, finalProps, {
+    view: popperView,
+    viewRenderer: viewRenderer
+  }));
+};
+const DesktopTimeRangePicker = /*#__PURE__*/React.forwardRef(function DesktopTimeRangePicker(inProps, ref) {
+  const utils = useUtils();
+
+  // Props with the default values common to all time range pickers
+  const defaultizedProps = useTimeRangePickerDefaultizedProps(inProps, 'MuiDesktopTimeRangePicker');
+  const renderTimeView = defaultizedProps.shouldRenderTimeInASingleColumn ? renderDigitalClockTimeView : renderMultiSectionDigitalClockTimeView;
+  const viewRenderers = _extends({
+    hours: renderTimeView,
+    minutes: renderTimeView,
+    seconds: renderTimeView,
+    meridiem: renderTimeView
+  }, defaultizedProps.viewRenderers);
+  const shouldHoursRendererContainMeridiemView = viewRenderers.hours?.name === renderMultiSectionDigitalClockTimeView.name;
+  const views = !shouldHoursRendererContainMeridiemView ? defaultizedProps.views.filter(view => view !== 'meridiem') : defaultizedProps.views;
+  const props = _extends({}, defaultizedProps, {
+    views,
+    viewRenderers,
+    ampmInClock: true,
+    format: resolveTimeFormat(utils, defaultizedProps),
+    slots: _extends({
+      field: SingleInputTimeRangeField
+    }, defaultizedProps.slots),
+    slotProps: _extends({}, defaultizedProps.slotProps, {
+      field: ownerState => _extends({}, resolveComponentProps(defaultizedProps.slotProps?.field, ownerState), extractValidationProps(defaultizedProps)),
+      tabs: _extends({
+        hidden: true
+      }, defaultizedProps.slotProps?.tabs),
+      toolbar: _extends({
+        hidden: true
+      }, defaultizedProps.slotProps?.toolbar),
+      layout: _extends({}, defaultizedProps.slotProps?.layout, {
+        sx: mergeSx(defaultizedProps.slotProps?.layout?.sx, {
+          // Allow content wrapper to take full width when shortcuts are not present
+          [`&:not(:has(.${pickersLayoutClasses.shortcuts})) .${pickersLayoutClasses.contentWrapper}`]: {
+            gridColumn: '1 /4'
+          }
+        })
+      })
+    })
+  });
+  const {
+    renderPicker
+  } = useDesktopRangePicker({
+    ref,
+    props,
+    valueManager: rangeValueManager,
+    valueType: 'time',
+    validator: validateTimeRange,
+    rendererInterceptor
+  });
+  return renderPicker();
+});
+DesktopTimeRangePicker.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "pnpm proptypes"  |
+  // ----------------------------------------------------------------------
+  /**
+   * 12h/24h view for hour selection clock.
+   * @default utils.is12HourCycleInCurrentLocale()
+   */
+  ampm: PropTypes.bool,
+  /**
+   * If `true`, the main element is focused during the first mount.
+   * This main element is:
+   * - the element chosen by the visible view if any (i.e: the selected day on the `day` view).
+   * - the `input` element if there is a field rendered.
+   */
+  autoFocus: PropTypes.bool,
+  className: PropTypes.string,
+  /**
+   * If `true`, the Picker will close after submitting the full date.
+   * @default false
+   */
+  closeOnSelect: PropTypes.bool,
+  /**
+   * The initial position in the edited date range.
+   * Used when the component is not controlled.
+   * @default 'start'
+   */
+  defaultRangePosition: PropTypes.oneOf(['end', 'start']),
+  /**
+   * The default value.
+   * Used when the component is not controlled.
+   */
+  defaultValue: PropTypes.arrayOf(PropTypes.object),
+  /**
+   * If `true`, the component is disabled.
+   * When disabled, the value cannot be changed and no interaction is possible.
+   * @default false
+   */
+  disabled: PropTypes.bool,
+  /**
+   * If `true`, disable values after the current date for date components, time for time components and both for date time components.
+   * @default false
+   */
+  disableFuture: PropTypes.bool,
+  /**
+   * Do not ignore date part when validating min/max time.
+   * @default false
+   */
+  disableIgnoringDatePartForTimeValidation: PropTypes.bool,
+  /**
+   * If `true`, the button to open the Picker will not be rendered (it will only render the field).
+   * @default false
+   */
+  disableOpenPicker: PropTypes.bool,
+  /**
+   * If `true`, disable values before the current date for date components, time for time components and both for date time components.
+   * @default false
+   */
+  disablePast: PropTypes.bool,
+  /**
+   * @default true
+   */
+  enableAccessibleFieldDOMStructure: PropTypes.any,
+  /**
+   * Format of the date when rendered in the input(s).
+   * Defaults to localized format based on the used `views`.
+   */
+  format: PropTypes.string,
+  /**
+   * Density of the format when rendered in the input.
+   * Setting `formatDensity` to `"spacious"` will add a space before and after each `/`, `-` and `.` character.
+   * @default "dense"
+   */
+  formatDensity: PropTypes.oneOf(['dense', 'spacious']),
+  /**
+   * Pass a ref to the `input` element.
+   */
+  inputRef: PropTypes.oneOfType([PropTypes.func, PropTypes.shape({
+    current: PropTypes.object
+  })]),
+  /**
+   * The label content.
+   */
+  label: PropTypes.node,
+  /**
+   * Locale for components texts.
+   * Allows overriding texts coming from `LocalizationProvider` and `theme`.
+   */
+  localeText: PropTypes.object,
+  /**
+   * Maximal selectable time.
+   * The date part of the object will be ignored unless `props.disableIgnoringDatePartForTimeValidation === true`.
+   */
+  maxTime: PropTypes.object,
+  /**
+   * Minimal selectable time.
+   * The date part of the object will be ignored unless `props.disableIgnoringDatePartForTimeValidation === true`.
+   */
+  minTime: PropTypes.object,
+  /**
+   * Step over minutes.
+   * @default 1
+   */
+  minutesStep: PropTypes.number,
+  /**
+   * Name attribute used by the `input` element in the Field.
+   */
+  name: PropTypes.string,
+  /**
+   * Callback fired when the value is accepted.
+   * @template TValue The value type. It will be the same type as `value` or `null`. It can be in `[start, end]` format in case of range value.
+   * @template TError The validation error type. It will be either `string` or a `null`. It can be in `[start, end]` format in case of range value.
+   * @param {TValue} value The value that was just accepted.
+   * @param {FieldChangeHandlerContext<TError>} context The context containing the validation result of the current value.
+   */
+  onAccept: PropTypes.func,
+  /**
+   * Callback fired when the value changes.
+   * @template TValue The value type. It will be the same type as `value` or `null`. It can be in `[start, end]` format in case of range value.
+   * @template TError The validation error type. It will be either `string` or a `null`. It can be in `[start, end]` format in case of range value.
+   * @param {TValue} value The new value.
+   * @param {FieldChangeHandlerContext<TError>} context The context containing the validation result of the current value.
+   */
+  onChange: PropTypes.func,
+  /**
+   * Callback fired when the popup requests to be closed.
+   * Use in controlled mode (see `open`).
+   */
+  onClose: PropTypes.func,
+  /**
+   * Callback fired when the error associated with the current value changes.
+   * When a validation error is detected, the `error` parameter contains a non-null value.
+   * This can be used to render an appropriate form error.
+   * @template TError The validation error type. It will be either `string` or a `null`. It can be in `[start, end]` format in case of range value.
+   * @template TValue The value type. It will be the same type as `value` or `null`. It can be in `[start, end]` format in case of range value.
+   * @param {TError} error The reason why the current value is not valid.
+   * @param {TValue} value The value associated with the error.
+   */
+  onError: PropTypes.func,
+  /**
+   * Callback fired when the popup requests to be opened.
+   * Use in controlled mode (see `open`).
+   */
+  onOpen: PropTypes.func,
+  /**
+   * Callback fired when the range position changes.
+   * @param {RangePosition} rangePosition The new range position.
+   */
+  onRangePositionChange: PropTypes.func,
+  /**
+   * Callback fired when the selected sections change.
+   * @param {FieldSelectedSections} newValue The new selected sections.
+   */
+  onSelectedSectionsChange: PropTypes.func,
+  /**
+   * Callback fired on view change.
+   * @template TView
+   * @param {TView} view The new view.
+   */
+  onViewChange: PropTypes.func,
+  /**
+   * Control the popup or dialog open state.
+   * @default false
+   */
+  open: PropTypes.bool,
+  /**
+   * The default visible view.
+   * Used when the component view is not controlled.
+   * Must be a valid option from `views` list.
+   */
+  openTo: PropTypes.oneOf(['hours', 'minutes', 'seconds']),
+  /**
+   * The position in the currently edited date range.
+   * Used when the component position is controlled.
+   */
+  rangePosition: PropTypes.oneOf(['end', 'start']),
+  /**
+   * If `true`, the component is read-only.
+   * When read-only, the value cannot be changed but the user can interact with the interface.
+   * @default false
+   */
+  readOnly: PropTypes.bool,
+  /**
+   * If `true`, disable heavy animations.
+   * @default `@media(prefers-reduced-motion: reduce)` || `navigator.userAgent` matches Android <10 or iOS <13
+   */
+  reduceAnimations: PropTypes.bool,
+  /**
+   * The date used to generate the new value when both `value` and `defaultValue` are empty.
+   * @default The closest valid date-time using the validation props, except callbacks like `shouldDisable<...>`.
+   */
+  referenceDate: PropTypes.object,
+  /**
+   * The currently selected sections.
+   * This prop accepts four formats:
+   * 1. If a number is provided, the section at this index will be selected.
+   * 2. If a string of type `FieldSectionType` is provided, the first section with that name will be selected.
+   * 3. If `"all"` is provided, all the sections will be selected.
+   * 4. If `null` is provided, no section will be selected.
+   * If not provided, the selected sections will be handled internally.
+   */
+  selectedSections: PropTypes.oneOfType([PropTypes.oneOf(['all', 'day', 'empty', 'hours', 'meridiem', 'minutes', 'month', 'seconds', 'weekDay', 'year']), PropTypes.number]),
+  /**
+   * Disable specific time.
+   * @param {PickerValidDate} value The value to check.
+   * @param {TimeView} view The clock type of the timeValue.
+   * @returns {boolean} If `true` the time will be disabled.
+   */
+  shouldDisableTime: PropTypes.func,
+  /**
+   * If `true`, disabled digital clock items will not be rendered.
+   * @default false
+   */
+  skipDisabled: PropTypes.bool,
+  /**
+   * The props used for each component slot.
+   * @default {}
+   */
+  slotProps: PropTypes.object,
+  /**
+   * Overridable component slots.
+   * @default {}
+   */
+  slots: PropTypes.object,
+  /**
+   * The system prop that allows defining system overrides as well as additional CSS styles.
+   */
+  sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object]),
+  /**
+   * Amount of time options below or at which the single column time renderer is used.
+   * @default 24
+   */
+  thresholdToRenderTimeInASingleColumn: PropTypes.number,
+  /**
+   * The time steps between two time unit options.
+   * For example, if `timeStep.minutes = 8`, then the available minute options will be `[0, 8, 16, 24, 32, 40, 48, 56]`.
+   * When single column time renderer is used, only `timeStep.minutes` will be used.
+   * @default{ hours: 1, minutes: 5, seconds: 5 }
+   */
+  timeSteps: PropTypes.shape({
+    hours: PropTypes.number,
+    minutes: PropTypes.number,
+    seconds: PropTypes.number
+  }),
+  /**
+   * Choose which timezone to use for the value.
+   * Example: "default", "system", "UTC", "America/New_York".
+   * If you pass values from other timezones to some props, they will be converted to this timezone before being used.
+   * @see See the {@link https://mui.com/x/react-date-pickers/timezone/ timezones documentation} for more details.
+   * @default The timezone of the `value` or `defaultValue` prop is defined, 'default' otherwise.
+   */
+  timezone: PropTypes.string,
+  /**
+   * The selected value.
+   * Used when the component is controlled.
+   */
+  value: PropTypes.arrayOf(PropTypes.object),
+  /**
+   * The visible view.
+   * Used when the component view is controlled.
+   * Must be a valid option from `views` list.
+   */
+  view: PropTypes.oneOf(['hours', 'meridiem', 'minutes', 'seconds']),
+  /**
+   * Define custom view renderers for each section.
+   * If `null`, the section will only have field editing.
+   * If `undefined`, internally defined view will be the used.
+   */
+  viewRenderers: PropTypes.shape({
+    hours: PropTypes.func,
+    meridiem: PropTypes.func,
+    minutes: PropTypes.func,
+    seconds: PropTypes.func
+  }),
+  /**
+   * Available views.
+   */
+  views: PropTypes.arrayOf(PropTypes.oneOf(['hours', 'minutes', 'seconds']).isRequired)
+};
+export { DesktopTimeRangePicker };

package/esm/DesktopTimeRangePicker/DesktopTimeRangePicker.types.d.ts

@@ -0,0 +1,18 @@
+import { MakeOptional } from '@mui/x-internals/types';
+import { DigitalTimePickerProps } from '@mui/x-date-pickers/internals';
+import { UseDesktopRangePickerSlots, UseDesktopRangePickerSlotProps, DesktopRangeOnlyPickerProps } from "../internals/hooks/useDesktopRangePicker/index.js";
+import { BaseTimeRangePickerProps, BaseTimeRangePickerSlots, BaseTimeRangePickerSlotProps } from "../TimeRangePicker/shared.js";
+export interface DesktopTimeRangePickerSlots extends BaseTimeRangePickerSlots, MakeOptional<UseDesktopRangePickerSlots, 'field'> {}
+export interface DesktopTimeRangePickerSlotProps<TEnableAccessibleFieldDOMStructure extends boolean> extends BaseTimeRangePickerSlotProps, Omit<UseDesktopRangePickerSlotProps<TEnableAccessibleFieldDOMStructure>, 'tabs' | 'toolbar'> {}
+export interface DesktopTimeRangePickerProps<TEnableAccessibleFieldDOMStructure extends boolean = true> extends BaseTimeRangePickerProps, DesktopRangeOnlyPickerProps, DigitalTimePickerProps {
+  /**
+   * Overridable component slots.
+   * @default {}
+   */
+  slots?: DesktopTimeRangePickerSlots;
+  /**
+   * The props used for each component slot.
+   * @default {}
+   */
+  slotProps?: DesktopTimeRangePickerSlotProps<TEnableAccessibleFieldDOMStructure>;
+}

package/esm/DesktopTimeRangePicker/DesktopTimeRangePicker.types.js

@@ -0,0 +1 @@
+export {};

package/esm/DesktopTimeRangePicker/index.d.ts

@@ -0,0 +1,2 @@
+export { DesktopTimeRangePicker } from "./DesktopTimeRangePicker.js";
+export type { DesktopTimeRangePickerProps, DesktopTimeRangePickerSlots, DesktopTimeRangePickerSlotProps } from './DesktopTimeRangePicker.types';

package/esm/DesktopTimeRangePicker/index.js

@@ -0,0 +1 @@
+export { DesktopTimeRangePicker } from "./DesktopTimeRangePicker.js";

package/esm/LocalizationProvider/index.d.ts

@@ -0,0 +1 @@
+export { LocalizationProvider } from '@mui/x-date-pickers/LocalizationProvider';

package/esm/LocalizationProvider/index.js

@@ -0,0 +1 @@
+export { LocalizationProvider } from '@mui/x-date-pickers/LocalizationProvider';

package/esm/MobileDateRangePicker/MobileDateRangePicker.d.ts

@@ -0,0 +1,17 @@
+import * as React from 'react';
+import { MobileDateRangePickerProps } from "./MobileDateRangePicker.types.js";
+type MobileDateRangePickerComponent = (<TEnableAccessibleFieldDOMStructure extends boolean = true>(props: MobileDateRangePickerProps<TEnableAccessibleFieldDOMStructure> & React.RefAttributes<HTMLDivElement>) => React.JSX.Element) & {
+  propTypes?: any;
+};
+/**
+ * Demos:
+ *
+ * - [DateRangePicker](https://mui.com/x/react-date-pickers/date-range-picker/)
+ * - [Validation](https://mui.com/x/react-date-pickers/validation/)
+ *
+ * API:
+ *
+ * - [MobileDateRangePicker API](https://mui.com/x/api/date-pickers/mobile-date-range-picker/)
+ */
+declare const MobileDateRangePicker: MobileDateRangePickerComponent;
+export { MobileDateRangePicker };