@mui/x-date-pickers 8.0.0-beta.3 → 8.0.0

package/modern/DesktopTimePicker/DesktopTimePicker.js

@@ -1,353 +0,0 @@
-'use client';
-
-import _extends from "@babel/runtime/helpers/esm/extends";
-import * as React from 'react';
-import PropTypes from 'prop-types';
-import resolveComponentProps from '@mui/utils/resolveComponentProps';
-import { refType } from '@mui/utils';
-import { singleItemValueManager } from "../internals/utils/valueManagers.js";
-import { TimeField } from "../TimeField/index.js";
-import { useTimePickerDefaultizedProps } from "../TimePicker/shared.js";
-import { useUtils } from "../internals/hooks/useUtils.js";
-import { extractValidationProps, validateTime } from "../validation/index.js";
-import { useDesktopPicker } from "../internals/hooks/useDesktopPicker/index.js";
-import { renderDigitalClockTimeView, renderMultiSectionDigitalClockTimeView } from "../timeViewRenderers/index.js";
-import { resolveTimeFormat } from "../internals/utils/time-utils.js";
-import { resolveTimeViewsResponse } from "../internals/utils/date-time-utils.js";
-/**
- * Demos:
- *
- * - [TimePicker](https://mui.com/x/react-date-pickers/time-picker/)
- * - [Validation](https://mui.com/x/react-date-pickers/validation/)
- *
- * API:
- *
- * - [DesktopTimePicker API](https://mui.com/x/api/date-pickers/desktop-time-picker/)
- */
-const DesktopTimePicker = /*#__PURE__*/React.forwardRef(function DesktopTimePicker(inProps, ref) {
-  const utils = useUtils();
-
-  // Props with the default values common to all time pickers
-  const defaultizedProps = useTimePickerDefaultizedProps(inProps, 'MuiDesktopTimePicker');
-  const {
-    shouldRenderTimeInASingleColumn,
-    views: resolvedViews,
-    timeSteps
-  } = resolveTimeViewsResponse(defaultizedProps);
-  const renderTimeView = shouldRenderTimeInASingleColumn ? renderDigitalClockTimeView : renderMultiSectionDigitalClockTimeView;
-  const viewRenderers = _extends({
-    hours: renderTimeView,
-    minutes: renderTimeView,
-    seconds: renderTimeView,
-    meridiem: renderTimeView
-  }, defaultizedProps.viewRenderers);
-  const ampmInClock = defaultizedProps.ampmInClock ?? true;
-  // Need to avoid adding the `meridiem` view when unexpected renderer is specified
-  const shouldHoursRendererContainMeridiemView = viewRenderers.hours?.name === renderMultiSectionDigitalClockTimeView.name;
-  const views = !shouldHoursRendererContainMeridiemView ? resolvedViews.filter(view => view !== 'meridiem') : resolvedViews;
-
-  // Props with the default values specific to the desktop variant
-  const props = _extends({}, defaultizedProps, {
-    ampmInClock,
-    timeSteps,
-    viewRenderers,
-    format: resolveTimeFormat(utils, defaultizedProps),
-    // Setting only `hours` time view in case of single column time picker
-    // Allows for easy view lifecycle management
-    views: shouldRenderTimeInASingleColumn ? ['hours'] : views,
-    slots: _extends({
-      field: TimeField
-    }, defaultizedProps.slots),
-    slotProps: _extends({}, defaultizedProps.slotProps, {
-      field: ownerState => _extends({}, resolveComponentProps(defaultizedProps.slotProps?.field, ownerState), extractValidationProps(defaultizedProps)),
-      toolbar: _extends({
-        hidden: true,
-        ampmInClock
-      }, defaultizedProps.slotProps?.toolbar)
-    })
-  });
-  const {
-    renderPicker
-  } = useDesktopPicker({
-    ref,
-    props,
-    valueManager: singleItemValueManager,
-    valueType: 'time',
-    validator: validateTime,
-    steps: null
-  });
-  return renderPicker();
-});
-DesktopTimePicker.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,
-  /**
-   * Display ampm controls under the clock (instead of in the toolbar).
-   * @default true on desktop, false on mobile
-   */
-  ampmInClock: 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 default value.
-   * Used when the component is not controlled.
-   */
-  defaultValue: 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).
-   * @deprecated Use the [field component](https://next.mui.com/x/react-date-pickers/fields/) instead.
-   * @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: refType,
-  /**
-   * 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 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', 'meridiem', 'minutes', 'seconds']),
-  /**
-   * Force rendering in particular orientation.
-   */
-  orientation: PropTypes.oneOf(['landscape', 'portrait']),
-  /**
-   * 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.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 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 { DesktopTimePicker };

package/modern/DesktopTimePicker/DesktopTimePicker.types.d.ts

@@ -1,26 +0,0 @@
-import { MakeOptional } from '@mui/x-internals/types';
-import { UseDesktopPickerSlots, ExportedUseDesktopPickerSlotProps, DesktopOnlyPickerProps } from "../internals/hooks/useDesktopPicker/index.js";
-import { BaseTimePickerProps, BaseTimePickerSlots, BaseTimePickerSlotProps } from "../TimePicker/shared.js";
-import { TimeViewWithMeridiem } from "../internals/models/index.js";
-import { DigitalTimePickerProps } from "../internals/models/props/time.js";
-import { DigitalClockSlots, DigitalClockSlotProps } from "../DigitalClock/index.js";
-import { MultiSectionDigitalClockSlots, MultiSectionDigitalClockSlotProps } from "../MultiSectionDigitalClock/index.js";
-import { TimeView } from "../models/index.js";
-export interface DesktopTimePickerSlots extends BaseTimePickerSlots, MakeOptional<UseDesktopPickerSlots, 'field' | 'openPickerIcon'>, DigitalClockSlots, MultiSectionDigitalClockSlots {}
-export interface DesktopTimePickerSlotProps<TEnableAccessibleFieldDOMStructure extends boolean> extends BaseTimePickerSlotProps, ExportedUseDesktopPickerSlotProps<TEnableAccessibleFieldDOMStructure>, DigitalClockSlotProps, MultiSectionDigitalClockSlotProps {}
-export interface DesktopTimePickerProps<TEnableAccessibleFieldDOMStructure extends boolean = true> extends BaseTimePickerProps<TimeViewWithMeridiem>, DesktopOnlyPickerProps, DigitalTimePickerProps {
-  /**
-   * Available views.
-   */
-  views?: readonly TimeView[];
-  /**
-   * Overridable component slots.
-   * @default {}
-   */
-  slots?: DesktopTimePickerSlots;
-  /**
-   * The props used for each component slot.
-   * @default {}
-   */
-  slotProps?: DesktopTimePickerSlotProps<TEnableAccessibleFieldDOMStructure>;
-}

package/modern/DesktopTimePicker/DesktopTimePicker.types.js

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

package/modern/DesktopTimePicker/index.d.ts

@@ -1,2 +0,0 @@
-export { DesktopTimePicker } from "./DesktopTimePicker.js";
-export type { DesktopTimePickerProps, DesktopTimePickerSlots, DesktopTimePickerSlotProps } from './DesktopTimePicker.types';

package/modern/DesktopTimePicker/index.js

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

package/modern/DigitalClock/DigitalClock.d.ts

@@ -1,18 +0,0 @@
-import * as React from 'react';
-import { DigitalClockProps } from "./DigitalClock.types.js";
-export declare const DigitalClockItem: import("@emotion/styled").StyledComponent<import("@mui/material").MenuItemOwnProps & Omit<import("@mui/material").ButtonBaseOwnProps, "classes"> & import("@mui/material/OverridableComponent").CommonProps & Omit<React.DetailedHTMLProps<React.LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>, "style" | "dense" | "disabled" | "action" | "selected" | "autoFocus" | "className" | "tabIndex" | "children" | "sx" | "classes" | "disableGutters" | "divider" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef"> & import("@mui/system").MUIStyledCommonProps<import("@mui/material").Theme>, {}, {}>;
-type DigitalClockComponent = ((props: DigitalClockProps & React.RefAttributes<HTMLDivElement>) => React.JSX.Element) & {
-  propTypes?: any;
-};
-/**
- * Demos:
- *
- * - [TimePicker](https://mui.com/x/react-date-pickers/time-picker/)
- * - [DigitalClock](https://mui.com/x/react-date-pickers/digital-clock/)
- *
- * API:
- *
- * - [DigitalClock API](https://mui.com/x/api/date-pickers/digital-clock/)
- */
-export declare const DigitalClock: DigitalClockComponent;
-export {};