@mui/x-date-pickers 8.0.0-alpha.13 → 8.0.0-alpha.14

package/modern/internals/hooks/usePicker/usePickerValue.js

@@ -1,226 +0,0 @@
-import _extends from "@babel/runtime/helpers/esm/extends";
-import * as React from 'react';
-import useEventCallback from '@mui/utils/useEventCallback';
-import { useOpenState } from "../useOpenState.js";
-import { useLocalizationContext, useUtils } from "../useUtils.js";
-import { useValidation } from "../../../validation/index.js";
-import { useValueWithTimezone } from "../useValueWithTimezone.js";
-/**
- * Manage the value lifecycle of all the pickers.
- */
-export const usePickerValue = ({
-  props,
-  valueManager,
-  valueType,
-  validator
-}) => {
-  const {
-    onAccept,
-    onChange,
-    value: inValueWithoutRenderTimezone,
-    defaultValue: inDefaultValue,
-    closeOnSelect = false,
-    timezone: timezoneProp,
-    referenceDate
-  } = props;
-  const {
-    current: defaultValue
-  } = React.useRef(inDefaultValue);
-  const {
-    current: isControlled
-  } = React.useRef(inValueWithoutRenderTimezone !== undefined);
-  const [previousTimezoneProp, setPreviousTimezoneProp] = React.useState(timezoneProp);
-
-  /* eslint-disable react-hooks/rules-of-hooks, react-hooks/exhaustive-deps */
-  if (process.env.NODE_ENV !== 'production') {
-    React.useEffect(() => {
-      if (isControlled !== (inValueWithoutRenderTimezone !== undefined)) {
-        console.error([`MUI X: A component is changing the ${isControlled ? '' : 'un'}controlled value of a picker to be ${isControlled ? 'un' : ''}controlled.`, 'Elements should not switch from uncontrolled to controlled (or vice versa).', `Decide between using a controlled or uncontrolled value` + 'for the lifetime of the component.', "The nature of the state is determined during the first render. It's considered controlled if the value is not `undefined`.", 'More info: https://fb.me/react-controlled-components'].join('\n'));
-      }
-    }, [inValueWithoutRenderTimezone]);
-    React.useEffect(() => {
-      if (!isControlled && defaultValue !== inDefaultValue) {
-        console.error([`MUI X: A component is changing the defaultValue of an uncontrolled picker after being initialized. ` + `To suppress this warning opt to use a controlled value.`].join('\n'));
-      }
-    }, [JSON.stringify(defaultValue)]);
-  }
-  /* eslint-enable react-hooks/rules-of-hooks, react-hooks/exhaustive-deps */
-
-  const utils = useUtils();
-  const adapter = useLocalizationContext();
-  const {
-    open,
-    setOpen
-  } = useOpenState(props);
-  const {
-    timezone,
-    value: inValueWithTimezoneToRender,
-    handleValueChange
-  } = useValueWithTimezone({
-    timezone: timezoneProp,
-    value: inValueWithoutRenderTimezone,
-    defaultValue,
-    referenceDate,
-    onChange,
-    valueManager
-  });
-  const [dateState, setDateState] = React.useState(() => {
-    let initialValue;
-    if (inValueWithTimezoneToRender !== undefined) {
-      initialValue = inValueWithTimezoneToRender;
-    } else if (defaultValue !== undefined) {
-      initialValue = defaultValue;
-    } else {
-      initialValue = valueManager.emptyValue;
-    }
-    return {
-      draft: initialValue,
-      lastPublishedValue: initialValue,
-      lastCommittedValue: initialValue,
-      lastControlledValue: inValueWithoutRenderTimezone,
-      hasBeenModifiedSinceMount: false
-    };
-  });
-  const timezoneFromDraftValue = valueManager.getTimezone(utils, dateState.draft);
-  if (previousTimezoneProp !== timezoneProp) {
-    setPreviousTimezoneProp(timezoneProp);
-    if (timezoneProp && timezoneFromDraftValue && timezoneProp !== timezoneFromDraftValue) {
-      setDateState(prev => _extends({}, prev, {
-        draft: valueManager.setTimezone(utils, timezoneProp, prev.draft)
-      }));
-    }
-  }
-  const {
-    getValidationErrorForNewValue
-  } = useValidation({
-    props,
-    validator,
-    timezone,
-    value: dateState.draft,
-    onError: props.onError
-  });
-  const setValue = useEventCallback((newValue, options) => {
-    const {
-      changeImportance = 'accept',
-      skipPublicationIfPristine = false,
-      validationError,
-      shortcut,
-      shouldClose = changeImportance === 'accept'
-    } = options ?? {};
-    let shouldPublish;
-    let shouldCommit;
-    if (!skipPublicationIfPristine && !isControlled && !dateState.hasBeenModifiedSinceMount) {
-      // If the value is not controlled and the value has never been modified before,
-      // Then clicking on any value (including the one equal to `defaultValue`) should call `onChange` and `onAccept`
-      shouldPublish = true;
-      shouldCommit = changeImportance === 'accept';
-    } else {
-      shouldPublish = !valueManager.areValuesEqual(utils, newValue, dateState.lastPublishedValue);
-      shouldCommit = changeImportance === 'accept' && !valueManager.areValuesEqual(utils, newValue, dateState.lastCommittedValue);
-    }
-    setDateState(prev => _extends({}, prev, {
-      draft: newValue,
-      lastPublishedValue: shouldPublish ? newValue : prev.lastPublishedValue,
-      lastCommittedValue: shouldCommit ? newValue : prev.lastCommittedValue,
-      hasBeenModifiedSinceMount: true
-    }));
-    let cachedContext = null;
-    const getContext = () => {
-      if (!cachedContext) {
-        cachedContext = {
-          validationError: validationError == null ? getValidationErrorForNewValue(newValue) : validationError
-        };
-        if (shortcut) {
-          cachedContext.shortcut = shortcut;
-        }
-      }
-      return cachedContext;
-    };
-    if (shouldPublish) {
-      handleValueChange(newValue, getContext());
-    }
-    if (shouldCommit && onAccept) {
-      onAccept(newValue, getContext());
-    }
-    if (shouldClose) {
-      setOpen(false);
-    }
-  });
-  if (dateState.lastControlledValue !== inValueWithoutRenderTimezone) {
-    const isUpdateComingFromPicker = valueManager.areValuesEqual(utils, dateState.draft, inValueWithTimezoneToRender);
-    setDateState(prev => _extends({}, prev, {
-      lastControlledValue: inValueWithoutRenderTimezone
-    }, isUpdateComingFromPicker ? {} : {
-      lastCommittedValue: inValueWithTimezoneToRender,
-      lastPublishedValue: inValueWithTimezoneToRender,
-      draft: inValueWithTimezoneToRender,
-      hasBeenModifiedSinceMount: true
-    }));
-  }
-  const isValid = testedValue => {
-    const error = validator({
-      adapter,
-      value: testedValue,
-      timezone,
-      props
-    });
-    return !valueManager.hasError(error);
-  };
-  const clearValue = useEventCallback(() => setValue(valueManager.emptyValue));
-  const setValueToToday = useEventCallback(() => setValue(valueManager.getTodayValue(utils, timezone, valueType)));
-  const acceptValueChanges = useEventCallback(() => setValue(dateState.lastPublishedValue));
-  const cancelValueChanges = useEventCallback(() => setValue(dateState.lastCommittedValue, {
-    skipPublicationIfPristine: true
-  }));
-  const dismissViews = useEventCallback(() => {
-    setValue(dateState.lastPublishedValue, {
-      skipPublicationIfPristine: true
-    });
-  });
-  const setValueFromView = useEventCallback((newValue, selectionState = 'partial') => {
-    // TODO: Expose a new method (private?) like `setView` that only updates the draft value.
-    if (selectionState === 'shallow') {
-      setDateState(prev => _extends({}, prev, {
-        draft: newValue,
-        hasBeenModifiedSinceMount: true
-      }));
-    }
-    setValue(newValue, {
-      changeImportance: selectionState === 'finish' && closeOnSelect ? 'accept' : 'set'
-    });
-  });
-  const valueWithoutError = React.useMemo(() => valueManager.cleanValue(utils, dateState.draft), [utils, valueManager, dateState.draft]);
-  const viewResponse = {
-    value: valueWithoutError,
-    onChange: setValueFromView,
-    open,
-    setOpen
-  };
-  const actionsContextValue = React.useMemo(() => ({
-    setValue,
-    setOpen,
-    clearValue,
-    setValueToToday,
-    acceptValueChanges,
-    cancelValueChanges
-  }), [setValue, setOpen, clearValue, setValueToToday, acceptValueChanges, cancelValueChanges]);
-  const contextValue = React.useMemo(() => _extends({}, actionsContextValue, {
-    value: dateState.draft,
-    timezone,
-    open
-  }), [actionsContextValue, timezone, open, dateState.draft]);
-  const privateContextValue = React.useMemo(() => ({
-    dismissViews
-  }), [dismissViews]);
-  const providerParams = {
-    value: dateState.draft,
-    contextValue,
-    actionsContextValue,
-    privateContextValue,
-    isValidContextValue: isValid
-  };
-  return {
-    viewProps: viewResponse,
-    provider: providerParams
-  };
-};

package/modern/internals/hooks/usePicker/usePickerValue.types.d.ts

@@ -1,327 +0,0 @@
-import * as React from 'react';
-import { UseFieldInternalProps } from "../useField/index.js";
-import { Validator } from "../../../validation/index.js";
-import { TimezoneProps, MuiPickersAdapter, PickersTimezone, PickerChangeHandlerContext, PickerValidDate, OnErrorProps, InferError, PickerValueType, PickerChangeImportance } from "../../../models/index.js";
-import { GetDefaultReferenceDateProps } from "../../utils/getDefaultReferenceDate.js";
-import type { PickersShortcutsItemContext } from '../../../PickersShortcuts';
-import { InferNonNullablePickerValue, PickerValidValue } from "../../models/index.js";
-export interface PickerValueManager<TValue extends PickerValidValue, TError> {
-  /**
-   * Determines if two values are equal.
-   * @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 {MuiPickersAdapter} utils The adapter.
-   * @param {TValue} valueLeft The first value to compare.
-   * @param {TValue} valueRight The second value to compare.
-   * @returns {boolean} A boolean indicating if the two values are equal.
-   */
-  areValuesEqual: (utils: MuiPickersAdapter, valueLeft: TValue, valueRight: TValue) => boolean;
-  /**
-   * Value to set when clicking the "Clear" button.
-   */
-  emptyValue: TValue;
-  /**
-   * Method returning the value to set when clicking the "Today" button
-   * @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 {MuiPickersAdapter} utils The adapter.
-   * @param {PickersTimezone} timezone The current timezone.
-   * @param {PickerValueType} valueType The type of the value being edited.
-   * @returns {TValue} The value to set when clicking the "Today" button.
-   */
-  getTodayValue: (utils: MuiPickersAdapter, timezone: PickersTimezone, valueType: PickerValueType) => TValue;
-  /**
-   * @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.
-   * Method returning the reference value to use when mounting the component.
-   * @param {object} params The params of the method.
-   * @param {PickerValidDate | undefined} params.referenceDate The referenceDate provided by the user.
-   * @param {TValue} params.value The value provided by the user.
-   * @param {GetDefaultReferenceDateProps} params.props The validation props needed to compute the reference value.
-   * @param {MuiPickersAdapter} params.utils The adapter.
-   * @param {number} params.granularity The granularity of the selection possible on this component.
-   * @param {PickersTimezone} params.timezone The current timezone.
-   * @param {() => PickerValidDate} params.getTodayDate The reference date to use if no reference date is passed to the component.
-   * @returns {TValue} The reference value to use for non-provided dates.
-   */
-  getInitialReferenceValue: (params: {
-    referenceDate: PickerValidDate | undefined;
-    value: TValue;
-    props: GetDefaultReferenceDateProps;
-    utils: MuiPickersAdapter;
-    granularity: number;
-    timezone: PickersTimezone;
-    getTodayDate?: () => PickerValidDate;
-  }) => InferNonNullablePickerValue<TValue>;
-  /**
-   * Method parsing the input value to replace all invalid dates by `null`.
-   * @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 {MuiPickersAdapter} utils The adapter.
-   * @param {TValue} value The value to parse.
-   * @returns {TValue} The value without invalid date.
-   */
-  cleanValue: (utils: MuiPickersAdapter, value: TValue) => TValue;
-  /**
-   * Generates the new value, given the previous value and the new proposed 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 {MuiPickersAdapter} utils The adapter.
-   * @param {TValue} lastValidDateValue The last valid value.
-   * @param {TValue} value The proposed value.
-   * @returns {TValue} The new value.
-   */
-  valueReducer?: (utils: MuiPickersAdapter, lastValidDateValue: TValue, value: TValue) => TValue;
-  /**
-   * Compare two errors to know if they are equal.
-   * @template TError
-   * @param {TError} error The new error
-   * @param {TError | null} prevError The previous error
-   * @returns {boolean} `true` if the new error is different from the previous one.
-   */
-  isSameError: (error: TError, prevError: TError | null) => boolean;
-  /**
-   * Checks if the current error is empty or not.
-   * @template TError
-   * @param {TError} error The current error.
-   * @returns {boolean} `true` if the current error is not empty.
-   */
-  hasError: (error: TError) => boolean;
-  /**
-   * The value identifying no error, used to initialise the error state.
-   */
-  defaultErrorState: TError;
-  /**
-   * Return the timezone of the date inside a value.
-   * Throw an error on range picker if both values don't have the same timezone.
-   * @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 {MuiPickersAdapter} utils The utils to manipulate the date.
-   @param {TValue} value The current value.
-   @returns {string | null} The timezone of the current value.
-   */
-  getTimezone: (utils: MuiPickersAdapter, value: TValue) => string | null;
-  /**
-   * Change the timezone of the dates inside a 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 {MuiPickersAdapter} utils The utils to manipulate the date.
-   @param {PickersTimezone} timezone The current timezone.
-   @param {TValue} value The value to convert.
-   @returns {TValue} The value with the new dates in the new timezone.
-   */
-  setTimezone: (utils: MuiPickersAdapter, timezone: PickersTimezone, value: TValue) => TValue;
-}
-export type PickerSelectionState = 'partial' | 'shallow' | 'finish';
-export interface UsePickerValueState<TValue extends PickerValidValue> {
-  /**
-   * Date displayed on the views and the field.
-   * It is updated whenever the user modifies something.
-   */
-  draft: TValue;
-  /**
-   * Last value published (the last value for which `shouldPublishValue` returned `true`).
-   * If `onChange` is defined, it's the value that was passed on the last call to this callback.
-   */
-  lastPublishedValue: TValue;
-  /**
-   * Last value committed (the last value for which `shouldCommitValue` returned `true`).
-   * If `onAccept` is defined, it's the value that was passed on the last call to this callback.
-   */
-  lastCommittedValue: TValue;
-  /**
-   * Last value passed to `props.value`.
-   * Used to update the `draft` value whenever the `value` prop changes.
-   */
-  lastControlledValue: TValue | undefined;
-  /**
-   * If we never modified the value since the mount of the component,
-   * Then we might want to apply some custom logic.
-   *
-   * For example, when the component is not controlled and `defaultValue` is defined.
-   * Then clicking on "Accept", "Today" or "Clear" should fire `onAccept` with `defaultValue`, but clicking on "Cancel" or dismissing the picker should not.
-   */
-  hasBeenModifiedSinceMount: boolean;
-}
-/**
- * Props used to handle the value that are common to all pickers.
- */
-export interface UsePickerValueBaseProps<TValue extends PickerValidValue, TError> extends OnErrorProps<TValue, TError> {
-  /**
-   * The selected value.
-   * Used when the component is controlled.
-   */
-  value?: TValue;
-  /**
-   * The default value.
-   * Used when the component is not controlled.
-   */
-  defaultValue?: TValue;
-  /**
-   * 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?: (value: TValue, context: PickerChangeHandlerContext<TError>) => void;
-  /**
-   * 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?: (value: TValue, context: PickerChangeHandlerContext<TError>) => void;
-}
-/**
- * Props used to handle the value of non-static pickers.
- */
-export interface UsePickerValueNonStaticProps {
-  /**
-   * If `true`, the Picker will close after submitting the full date.
-   * @default false
-   */
-  closeOnSelect?: boolean;
-  /**
-   * Control the popup or dialog open state.
-   * @default false
-   */
-  open?: boolean;
-  /**
-   * Callback fired when the popup requests to be closed.
-   * Use in controlled mode (see `open`).
-   */
-  onClose?: () => void;
-  /**
-   * Callback fired when the popup requests to be opened.
-   * Use in controlled mode (see `open`).
-   */
-  onOpen?: () => void;
-}
-/**
- * Props used to handle the value of the pickers.
- */
-export interface UsePickerValueProps<TValue extends PickerValidValue, TError> extends UsePickerValueBaseProps<TValue, TError>, UsePickerValueNonStaticProps, TimezoneProps {
-  referenceDate?: PickerValidDate;
-}
-export interface UsePickerValueParams<TValue extends PickerValidValue, TExternalProps extends UsePickerValueProps<TValue, any>> {
-  props: TExternalProps;
-  valueManager: PickerValueManager<TValue, InferError<TExternalProps>>;
-  valueType: PickerValueType;
-  validator: Validator<TValue, InferError<TExternalProps>, TExternalProps>;
-}
-export type UsePickerValueFieldResponse<TValue extends PickerValidValue, TError> = Required<Pick<UseFieldInternalProps<TValue, any, TError>, 'value' | 'onChange'>>;
-/**
- * Props passed to `usePickerViews`.
- */
-export interface UsePickerValueViewsResponse<TValue extends PickerValidValue> {
-  value: TValue;
-  onChange: (value: TValue, selectionState?: PickerSelectionState) => void;
-  open: boolean;
-  setOpen: React.Dispatch<React.SetStateAction<boolean>>;
-}
-/**
- * Params passed to `usePickerProvider`.
- */
-export interface UsePickerValueProviderParams<TValue extends PickerValidValue, TError> {
-  value: TValue;
-  contextValue: UsePickerValueContextValue<TValue, TError>;
-  actionsContextValue: UsePickerValueActionsContextValue<TValue, TError>;
-  privateContextValue: UsePickerValuePrivateContextValue;
-  isValidContextValue: (value: TValue) => boolean;
-}
-export interface UsePickerValueResponse<TValue extends PickerValidValue, TError> {
-  viewProps: UsePickerValueViewsResponse<TValue>;
-  provider: UsePickerValueProviderParams<TValue, TError>;
-}
-export interface UsePickerValueContextValue<TValue extends PickerValidValue, TError> extends UsePickerValueActionsContextValue<TValue, TError> {
-  /**
-   * The current value of the picker.
-   */
-  value: TValue;
-  /**
-   * The timezone to use when rendering the dates.
-   * If a `timezone` prop is provided, it will be used.
-   * If the `value` prop contains a valid date, its timezone will be used.
-   * If no `value` prop is provided, but the `defaultValue` contains a valid date, its timezone will be used.
-   * If no `value` or `defaultValue` is provided, but the `referenceDate` is provided, its timezone will be used.
-   * Otherwise, the timezone will be the default one of your date library.
-   */
-  timezone: PickersTimezone;
-  /**
-   * Whether the picker is open.
-   */
-  open: boolean;
-}
-export interface UsePickerValueActionsContextValue<TValue extends PickerValidValue, TError> {
-  /**
-   * Set the current value of the picker.
-   * @param {TValue} value The new value of the picker.
-   * @param {SetValueActionOptions<TError>} options The options to customize the behavior of this update.
-   */
-  setValue: (value: TValue, options?: SetValueActionOptions<TError>) => void;
-  /**
-   * Set the current open state of the Picker.
-   * ```ts
-   * setOpen(true); // Opens the picker.
-   * setOpen(false); // Closes the picker.
-   * setOpen((prevOpen) => !prevOpen); // Toggles the open state.
-   * ```
-   * @param {React.SetStateAction<boolean>} action The new open state of the Picker.
-   * It can be a function that will receive the current open state.
-   */
-  setOpen: React.Dispatch<React.SetStateAction<boolean>>;
-  /**
-   * Set the current value of the picker to be empty.
-   * The value will be `null` on single pickers and `[null, null]` on range pickers.
-   */
-  clearValue: () => void;
-  /**
-   * Set the current value of the picker to be the current date.
-   * The value will be `today` on single pickers and `[today, today]` on range pickers.
-   * With `today` being the current date, with its time set to `00:00:00` on Date Pickers and its time set to the current time on Time and Date Pickers.
-   */
-  setValueToToday: () => void;
-  /**
-   * Accept the current value of the picker.
-   * Will call `onAccept` if defined.
-   * If the picker is re-opened, this value will be the one used to initialize the views.
-   */
-  acceptValueChanges: () => void;
-  /**
-   * Cancel the changes made to the current value of the picker.
-   * The value will be reset to the last accepted value.
-   */
-  cancelValueChanges: () => void;
-}
-export interface UsePickerValuePrivateContextValue {
-  /**
-   * Close the picker and accepts the current value if it is not equal to the last accepted value.
-   */
-  dismissViews: () => void;
-}
-export interface SetValueActionOptions<TError = string | null> {
-  /**
-   * The importance of the change when picking a value:
-   * - "accept": fires `onChange`, fires `onAccept` and closes the picker.
-   * - "set": fires `onChange` but do not fire `onAccept` and does not close the picker.
-   * @default "accept"
-   */
-  changeImportance?: PickerChangeImportance;
-  /**
-   * The validation error associated to the current value.
-   * If not defined, the validation will be computed by the picker.
-   */
-  validationError?: TError;
-  /**
-   * The shortcut that triggered this change.
-   * It should not be defined if the change does not come from a shortcut.
-   */
-  shortcut?: PickersShortcutsItemContext;
-  /**
-   * Whether the value should call `onChange` and `onAccept` when the value is not controlled and has never been modified.
-   * If `true`, the `onChange` and `onAccept` callback will only be fired if the value has been modified (and is not equal to the last published value).
-   * If `false`, the `onChange` and `onAccept` callback will be fired when the value has never been modified (`onAccept` only if `changeImportance` is set to "accept").
-   * @default false
-   */
-  skipPublicationIfPristine?: boolean;
-  /**
-   * Whether the picker should close.
-   * @default changeImportance === "accept"
-   */
-  shouldClose?: boolean;
-}

package/modern/internals/hooks/usePicker/usePickerValue.types.js

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