@mui/utils 7.0.1 → 7.1.0

package/modern/useId/useId.js

@@ -1,45 +0,0 @@
-'use client';
-
-import * as React from 'react';
-let globalId = 0;
-
-// TODO React 17: Remove `useGlobalId` once React 17 support is removed
-function useGlobalId(idOverride) {
-  const [defaultId, setDefaultId] = React.useState(idOverride);
-  const id = idOverride || defaultId;
-  React.useEffect(() => {
-    if (defaultId == null) {
-      // Fallback to this default id when possible.
-      // Use the incrementing value for client-side rendering only.
-      // We can't use it server-side.
-      // If you want to use random values please consider the Birthday Problem: https://en.wikipedia.org/wiki/Birthday_problem
-      globalId += 1;
-      setDefaultId(`mui-${globalId}`);
-    }
-  }, [defaultId]);
-  return id;
-}
-
-// See https://github.com/mui/material-ui/issues/41190#issuecomment-2040873379 for why
-const safeReact = {
-  ...React
-};
-const maybeReactUseId = safeReact.useId;
-
-/**
- *
- * @example <div id={useId()} />
- * @param idOverride
- * @returns {string}
- */
-export default function useId(idOverride) {
-  // React.useId() is only available from React 17.0.0.
-  if (maybeReactUseId !== undefined) {
-    const reactId = maybeReactUseId();
-    return idOverride ?? reactId;
-  }
-
-  // TODO: uncomment once we enable eslint-plugin-react-compiler // eslint-disable-next-line react-compiler/react-compiler
-  // eslint-disable-next-line react-hooks/rules-of-hooks -- `React.useId` is invariant at runtime.
-  return useGlobalId(idOverride);
-}

package/modern/useIsFocusVisible/index.d.ts

@@ -1,2 +0,0 @@
-export { default } from "./useIsFocusVisible.js";
-export * from "./useIsFocusVisible.js";

package/modern/useIsFocusVisible/index.js

@@ -1,2 +0,0 @@
-export { default } from "./useIsFocusVisible.js";
-export * from "./useIsFocusVisible.js";

package/modern/useIsFocusVisible/useIsFocusVisible.d.ts

@@ -1,9 +0,0 @@
-import * as React from 'react';
-export declare function teardown(doc: Document): void;
-export interface UseIsFocusVisibleResult {
-  isFocusVisibleRef: React.MutableRefObject<boolean>;
-  onBlur: (event: React.FocusEvent<any>) => void;
-  onFocus: (event: React.FocusEvent<any>) => void;
-  ref: React.RefCallback<Element>;
-}
-export default function useIsFocusVisible(): UseIsFocusVisibleResult;

package/modern/useIsFocusVisible/useIsFocusVisible.js

@@ -1,163 +0,0 @@
-'use client';
-
-// based on https://github.com/WICG/focus-visible/blob/v4.1.5/src/focus-visible.js
-import * as React from 'react';
-import { Timeout } from "../useTimeout/useTimeout.js";
-let hadKeyboardEvent = true;
-let hadFocusVisibleRecently = false;
-const hadFocusVisibleRecentlyTimeout = new Timeout();
-const inputTypesWhitelist = {
-  text: true,
-  search: true,
-  url: true,
-  tel: true,
-  email: true,
-  password: true,
-  number: true,
-  date: true,
-  month: true,
-  week: true,
-  time: true,
-  datetime: true,
-  'datetime-local': true
-};
-
-/**
- * Computes whether the given element should automatically trigger the
- * `focus-visible` class being added, i.e. whether it should always match
- * `:focus-visible` when focused.
- * @param {Element} node
- * @returns {boolean}
- */
-function focusTriggersKeyboardModality(node) {
-  const {
-    type,
-    tagName
-  } = node;
-  if (tagName === 'INPUT' && inputTypesWhitelist[type] && !node.readOnly) {
-    return true;
-  }
-  if (tagName === 'TEXTAREA' && !node.readOnly) {
-    return true;
-  }
-  if (node.isContentEditable) {
-    return true;
-  }
-  return false;
-}
-
-/**
- * Keep track of our keyboard modality state with `hadKeyboardEvent`.
- * If the most recent user interaction was via the keyboard;
- * and the key press did not include a meta, alt/option, or control key;
- * then the modality is keyboard. Otherwise, the modality is not keyboard.
- * @param {KeyboardEvent} event
- */
-function handleKeyDown(event) {
-  if (event.metaKey || event.altKey || event.ctrlKey) {
-    return;
-  }
-  hadKeyboardEvent = true;
-}
-
-/**
- * If at any point a user clicks with a pointing device, ensure that we change
- * the modality away from keyboard.
- * This avoids the situation where a user presses a key on an already focused
- * element, and then clicks on a different element, focusing it with a
- * pointing device, while we still think we're in keyboard modality.
- */
-function handlePointerDown() {
-  hadKeyboardEvent = false;
-}
-function handleVisibilityChange() {
-  if (this.visibilityState === 'hidden') {
-    // If the tab becomes active again, the browser will handle calling focus
-    // on the element (Safari actually calls it twice).
-    // If this tab change caused a blur on an element with focus-visible,
-    // re-apply the class when the user switches back to the tab.
-    if (hadFocusVisibleRecently) {
-      hadKeyboardEvent = true;
-    }
-  }
-}
-function prepare(doc) {
-  doc.addEventListener('keydown', handleKeyDown, true);
-  doc.addEventListener('mousedown', handlePointerDown, true);
-  doc.addEventListener('pointerdown', handlePointerDown, true);
-  doc.addEventListener('touchstart', handlePointerDown, true);
-  doc.addEventListener('visibilitychange', handleVisibilityChange, true);
-}
-export function teardown(doc) {
-  doc.removeEventListener('keydown', handleKeyDown, true);
-  doc.removeEventListener('mousedown', handlePointerDown, true);
-  doc.removeEventListener('pointerdown', handlePointerDown, true);
-  doc.removeEventListener('touchstart', handlePointerDown, true);
-  doc.removeEventListener('visibilitychange', handleVisibilityChange, true);
-}
-function isFocusVisible(event) {
-  const {
-    target
-  } = event;
-  try {
-    return target.matches(':focus-visible');
-  } catch (error) {
-    // Browsers not implementing :focus-visible will throw a SyntaxError.
-    // We use our own heuristic for those browsers.
-    // Rethrow might be better if it's not the expected error but do we really
-    // want to crash if focus-visible malfunctioned?
-  }
-
-  // No need for validFocusTarget check. The user does that by attaching it to
-  // focusable events only.
-  return hadKeyboardEvent || focusTriggersKeyboardModality(target);
-}
-export default function useIsFocusVisible() {
-  const ref = React.useCallback(node => {
-    if (node != null) {
-      prepare(node.ownerDocument);
-    }
-  }, []);
-  const isFocusVisibleRef = React.useRef(false);
-
-  /**
-   * Should be called if a blur event is fired
-   */
-  function handleBlurVisible() {
-    // checking against potential state variable does not suffice if we focus and blur synchronously.
-    // React wouldn't have time to trigger a re-render so `focusVisible` would be stale.
-    // Ideally we would adjust `isFocusVisible(event)` to look at `relatedTarget` for blur events.
-    // This doesn't work in IE11 due to https://github.com/facebook/react/issues/3751
-    // TODO: check again if React releases their internal changes to focus event handling (https://github.com/facebook/react/pull/19186).
-    if (isFocusVisibleRef.current) {
-      // To detect a tab/window switch, we look for a blur event followed
-      // rapidly by a visibility change.
-      // If we don't see a visibility change within 100ms, it's probably a
-      // regular focus change.
-      hadFocusVisibleRecently = true;
-      hadFocusVisibleRecentlyTimeout.start(100, () => {
-        hadFocusVisibleRecently = false;
-      });
-      isFocusVisibleRef.current = false;
-      return true;
-    }
-    return false;
-  }
-
-  /**
-   * Should be called if a blur event is fired
-   */
-  function handleFocusVisible(event) {
-    if (isFocusVisible(event)) {
-      isFocusVisibleRef.current = true;
-      return true;
-    }
-    return false;
-  }
-  return {
-    isFocusVisibleRef,
-    onFocus: handleFocusVisible,
-    onBlur: handleBlurVisible,
-    ref
-  };
-}

package/modern/useLazyRef/index.d.ts

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

package/modern/useLazyRef/index.js

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

package/modern/useLazyRef/useLazyRef.d.ts

@@ -1,9 +0,0 @@
-import * as React from 'react';
-/**
- * A React.useRef() that is initialized lazily with a function. Note that it accepts an optional
- * initialization argument, so the initialization function doesn't need to be an inline closure.
- *
- * @usage
- *   const ref = useLazyRef(sortColumns, columns)
- */
-export default function useLazyRef<T, U>(init: (arg?: U) => T, initArg?: U): React.RefObject<T>;

package/modern/useLazyRef/useLazyRef.js

@@ -1,19 +0,0 @@
-'use client';
-
-import * as React from 'react';
-const UNINITIALIZED = {};
-
-/**
- * A React.useRef() that is initialized lazily with a function. Note that it accepts an optional
- * initialization argument, so the initialization function doesn't need to be an inline closure.
- *
- * @usage
- *   const ref = useLazyRef(sortColumns, columns)
- */
-export default function useLazyRef(init, initArg) {
-  const ref = React.useRef(UNINITIALIZED);
-  if (ref.current === UNINITIALIZED) {
-    ref.current = init(initArg);
-  }
-  return ref;
-}

package/modern/useLocalStorageState/index.d.ts

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

package/modern/useLocalStorageState/index.js

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

package/modern/useLocalStorageState/useLocalStorageState.d.ts

@@ -1,14 +0,0 @@
-import * as React from 'react';
-type Initializer = () => string | null;
-type UseStorageStateHookResult = [string | null, React.Dispatch<React.SetStateAction<string | null>>];
-/**
- * Sync state to local storage so that it persists through a page refresh. Usage is
- * similar to useState except we pass in a storage key so that we can default
- * to that value on page load instead of the specified initial value.
- *
- * Since the storage API isn't available in server-rendering environments, we
- * return null during SSR and hydration.
- */
-declare function useLocalStorageStateBrowser(key: string | null, initializer?: string | null | Initializer): UseStorageStateHookResult;
-declare const _default: typeof useLocalStorageStateBrowser;
-export default _default;

package/modern/useLocalStorageState/useLocalStorageState.js

@@ -1,108 +0,0 @@
-'use client';
-
-import * as React from 'react';
-
-// storage events only work across tabs, we'll use an event emitter to announce within the current tab
-const currentTabChangeListeners = new Map();
-function onCurrentTabStorageChange(key, handler) {
-  let listeners = currentTabChangeListeners.get(key);
-  if (!listeners) {
-    listeners = new Set();
-    currentTabChangeListeners.set(key, listeners);
-  }
-  listeners.add(handler);
-}
-function offCurrentTabStorageChange(key, handler) {
-  const listeners = currentTabChangeListeners.get(key);
-  if (!listeners) {
-    return;
-  }
-  listeners.delete(handler);
-  if (listeners.size === 0) {
-    currentTabChangeListeners.delete(key);
-  }
-}
-function emitCurrentTabStorageChange(key) {
-  const listeners = currentTabChangeListeners.get(key);
-  if (listeners) {
-    listeners.forEach(listener => listener());
-  }
-}
-function subscribe(area, key, callback) {
-  if (!key) {
-    return () => {};
-  }
-  const storageHandler = event => {
-    if (event.storageArea === area && event.key === key) {
-      callback();
-    }
-  };
-  window.addEventListener('storage', storageHandler);
-  onCurrentTabStorageChange(key, callback);
-  return () => {
-    window.removeEventListener('storage', storageHandler);
-    offCurrentTabStorageChange(key, callback);
-  };
-}
-function getSnapshot(area, key) {
-  if (!key) {
-    return null;
-  }
-  try {
-    return area.getItem(key);
-  } catch {
-    // ignore
-    // See https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API/Using_the_Web_Storage_API#feature-detecting_localstorage
-    return null;
-  }
-}
-function setValue(area, key, value) {
-  if (!key) {
-    return;
-  }
-  try {
-    if (value === null) {
-      area.removeItem(key);
-    } else {
-      area.setItem(key, String(value));
-    }
-  } catch {
-    // ignore
-    // See https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API/Using_the_Web_Storage_API#feature-detecting_localstorage
-    return;
-  }
-  emitCurrentTabStorageChange(key);
-}
-const serverValue = [null, () => {}];
-function useLocalStorageStateServer() {
-  return serverValue;
-}
-
-/**
- * Sync state to local storage so that it persists through a page refresh. Usage is
- * similar to useState except we pass in a storage key so that we can default
- * to that value on page load instead of the specified initial value.
- *
- * Since the storage API isn't available in server-rendering environments, we
- * return null during SSR and hydration.
- */
-function useLocalStorageStateBrowser(key, initializer = null) {
-  const [initialValue] = React.useState(initializer);
-  const area = window.localStorage;
-  const subscribeKey = React.useCallback(callback => subscribe(area, key, callback), [area, key]);
-  const getKeySnapshot = React.useCallback(() => getSnapshot(area, key) ?? initialValue, [area, initialValue, key]);
-
-  // Start with null for the hydration, and then switch to the actual value.
-  const getKeyServerSnapshot = () => null;
-  const storedValue = React.useSyncExternalStore(subscribeKey, getKeySnapshot, getKeyServerSnapshot);
-  const setStoredValue = React.useCallback(value => {
-    const valueToStore = value instanceof Function ? value(storedValue) : value;
-    setValue(area, key, valueToStore);
-  }, [area, key, storedValue]);
-  const [nonStoredValue, setNonStoredValue] = React.useState(initialValue);
-  if (!key) {
-    return [nonStoredValue, setNonStoredValue];
-  }
-  return [storedValue, setStoredValue];
-}
-export default typeof window === 'undefined' ? useLocalStorageStateServer : useLocalStorageStateBrowser;

package/modern/useOnMount/index.d.ts

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

package/modern/useOnMount/index.js

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

package/modern/useOnMount/useOnMount.d.ts

@@ -1,5 +0,0 @@
-import * as React from 'react';
-/**
- * A React.useEffect equivalent that runs once, when the component is mounted.
- */
-export default function useOnMount(fn: React.EffectCallback): void;

package/modern/useOnMount/useOnMount.js

@@ -1,14 +0,0 @@
-'use client';
-
-import * as React from 'react';
-const EMPTY = [];
-
-/**
- * A React.useEffect equivalent that runs once, when the component is mounted.
- */
-export default function useOnMount(fn) {
-  // TODO: uncomment once we enable eslint-plugin-react-compiler // eslint-disable-next-line react-compiler/react-compiler -- no need to put `fn` in the dependency array
-  /* eslint-disable react-hooks/exhaustive-deps */
-  React.useEffect(fn, EMPTY);
-  /* eslint-enable react-hooks/exhaustive-deps */
-}

package/modern/usePreviousProps/index.d.ts

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

package/modern/usePreviousProps/index.js

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

package/modern/usePreviousProps/usePreviousProps.d.ts

@@ -1,2 +0,0 @@
-declare const usePreviousProps: <T>(value: T) => Partial<T>;
-export default usePreviousProps;

package/modern/usePreviousProps/usePreviousProps.js

@@ -1,11 +0,0 @@
-'use client';
-
-import * as React from 'react';
-const usePreviousProps = value => {
-  const ref = React.useRef({});
-  React.useEffect(() => {
-    ref.current = value;
-  });
-  return ref.current;
-};
-export default usePreviousProps;

package/modern/useSlotProps/index.d.ts

@@ -1,2 +0,0 @@
-export { default } from "./useSlotProps.js";
-export type { UseSlotPropsParameters, UseSlotPropsResult } from "./useSlotProps.js";

package/modern/useSlotProps/index.js

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

package/modern/useSlotProps/useSlotProps.d.ts

@@ -1,41 +0,0 @@
-import * as React from 'react';
-import { AppendOwnerStateReturnType } from "../appendOwnerState/index.js";
-import { MergeSlotPropsParameters, MergeSlotPropsResult, WithCommonProps } from "../mergeSlotProps/index.js";
-export type UseSlotPropsParameters<ElementType extends React.ElementType, SlotProps, ExternalForwardedProps, ExternalSlotProps, AdditionalProps, OwnerState> = Omit<MergeSlotPropsParameters<SlotProps, ExternalForwardedProps, ExternalSlotProps, AdditionalProps>, 'externalSlotProps'> & {
-  /**
-   * The type of the component used in the slot.
-   */
-  elementType: ElementType | undefined;
-  /**
-   * The `slotProps.*` of the Base UI component.
-   */
-  externalSlotProps: ExternalSlotProps | ((ownerState: OwnerState) => ExternalSlotProps) | undefined;
-  /**
-   * The ownerState of the Base UI component.
-   */
-  ownerState: OwnerState;
-  /**
-   * Set to true if the slotProps callback should receive more props.
-   */
-  skipResolvingSlotProps?: boolean;
-};
-export type UseSlotPropsResult<ElementType extends React.ElementType, SlotProps, AdditionalProps, OwnerState> = AppendOwnerStateReturnType<ElementType, MergeSlotPropsResult<SlotProps, object, object, AdditionalProps>['props'] & {
-  ref: ((instance: any | null) => void) | null;
-}, OwnerState>;
-/**
- * @ignore - do not document.
- * Builds the props to be passed into the slot of an unstyled component.
- * It merges the internal props of the component with the ones supplied by the user, allowing to customize the behavior.
- * If the slot component is not a host component, it also merges in the `ownerState`.
- *
- * @param parameters.getSlotProps - A function that returns the props to be passed to the slot component.
- */
-declare function useSlotProps<ElementType extends React.ElementType, SlotProps, AdditionalProps, OwnerState>(parameters: UseSlotPropsParameters<ElementType, SlotProps, object, WithCommonProps<Record<string, any>>, AdditionalProps, OwnerState>): import("@mui/types").Simplify<import("@mui/types").Simplify<SlotProps & object & AdditionalProps & {
-  className?: string;
-  style?: React.CSSProperties;
-}> & {
-  ref: ((instance: any | null) => void) | null;
-} & {
-  ownerState: ElementType extends React.ComponentType<any> ? OwnerState : ElementType extends keyof React.JSX.IntrinsicElements ? undefined : OwnerState | undefined;
-}>;
-export default useSlotProps;

package/modern/useSlotProps/useSlotProps.js

@@ -1,38 +0,0 @@
-'use client';
-
-import useForkRef from "../useForkRef/index.js";
-import appendOwnerState from "../appendOwnerState/index.js";
-import mergeSlotProps from "../mergeSlotProps/index.js";
-import resolveComponentProps from "../resolveComponentProps/index.js";
-/**
- * @ignore - do not document.
- * Builds the props to be passed into the slot of an unstyled component.
- * It merges the internal props of the component with the ones supplied by the user, allowing to customize the behavior.
- * If the slot component is not a host component, it also merges in the `ownerState`.
- *
- * @param parameters.getSlotProps - A function that returns the props to be passed to the slot component.
- */
-function useSlotProps(parameters) {
-  const {
-    elementType,
-    externalSlotProps,
-    ownerState,
-    skipResolvingSlotProps = false,
-    ...other
-  } = parameters;
-  const resolvedComponentsProps = skipResolvingSlotProps ? {} : resolveComponentProps(externalSlotProps, ownerState);
-  const {
-    props: mergedProps,
-    internalRef
-  } = mergeSlotProps({
-    ...other,
-    externalSlotProps: resolvedComponentsProps
-  });
-  const ref = useForkRef(internalRef, resolvedComponentsProps?.ref, parameters.additionalProps?.ref);
-  const props = appendOwnerState(elementType, {
-    ...mergedProps,
-    ref
-  }, ownerState);
-  return props;
-}
-export default useSlotProps;

package/modern/useTimeout/index.d.ts

@@ -1,2 +0,0 @@
-export { default } from "./useTimeout.js";
-export { Timeout } from "./useTimeout.js";

package/modern/useTimeout/index.js

@@ -1,2 +0,0 @@
-export { default } from "./useTimeout.js";
-export { Timeout } from "./useTimeout.js";

package/modern/useTimeout/useTimeout.d.ts

@@ -1,11 +0,0 @@
-export declare class Timeout {
-  static create(): Timeout;
-  currentId: ReturnType<typeof setTimeout> | null;
-  /**
-   * Executes `fn` after `delay`, clearing any previously scheduled call.
-   */
-  start(delay: number, fn: Function): void;
-  clear: () => void;
-  disposeEffect: () => () => void;
-}
-export default function useTimeout(): Timeout;

package/modern/useTimeout/useTimeout.js

@@ -1,35 +0,0 @@
-'use client';
-
-import useLazyRef from "../useLazyRef/useLazyRef.js";
-import useOnMount from "../useOnMount/useOnMount.js";
-export class Timeout {
-  static create() {
-    return new Timeout();
-  }
-  currentId = null;
-
-  /**
-   * Executes `fn` after `delay`, clearing any previously scheduled call.
-   */
-  start(delay, fn) {
-    this.clear();
-    this.currentId = setTimeout(() => {
-      this.currentId = null;
-      fn();
-    }, delay);
-  }
-  clear = () => {
-    if (this.currentId !== null) {
-      clearTimeout(this.currentId);
-      this.currentId = null;
-    }
-  };
-  disposeEffect = () => {
-    return this.clear;
-  };
-}
-export default function useTimeout() {
-  const timeout = useLazyRef(Timeout.create).current;
-  useOnMount(timeout.disposeEffect);
-  return timeout;
-}

package/modern/visuallyHidden/index.d.ts

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

package/modern/visuallyHidden/index.js

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

package/modern/visuallyHidden/visuallyHidden.d.ts

@@ -1,2 +0,0 @@
-declare const visuallyHidden: import('react').CSSProperties;
-export default visuallyHidden;

package/modern/visuallyHidden/visuallyHidden.js

@@ -1,12 +0,0 @@
-const visuallyHidden = {
-  border: 0,
-  clip: 'rect(0 0 0 0)',
-  height: '1px',
-  margin: '-1px',
-  overflow: 'hidden',
-  padding: 0,
-  position: 'absolute',
-  whiteSpace: 'nowrap',
-  width: '1px'
-};
-export default visuallyHidden;