@mui/x-tree-view 8.23.0 → 8.24.0

package/internals/useTreeView/useExtractPluginParamsFromProps.js

@@ -1,60 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useExtractPluginParamsFromProps = void 0;
-var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));
-var React = _interopRequireWildcard(require("react"));
-const _excluded = ["apiRef"];
-const useExtractPluginParamsFromProps = _ref => {
-  let {
-      props: {
-        apiRef
-      },
-      plugins
-    } = _ref,
-    props = (0, _objectWithoutPropertiesLoose2.default)(_ref.props, _excluded);
-  const paramsLookup = React.useMemo(() => {
-    const tempParamsLookup = {};
-    plugins.forEach(plugin => {
-      Object.assign(tempParamsLookup, plugin.params);
-    });
-    return tempParamsLookup;
-  }, [plugins]);
-  const {
-    forwardedProps,
-    pluginParams
-  } = React.useMemo(() => {
-    const tempPluginParams = {};
-    const tempForwardedProps = {};
-    Object.keys(props).forEach(propName => {
-      const prop = props[propName];
-      if (paramsLookup[propName]) {
-        tempPluginParams[propName] = prop;
-      } else {
-        tempForwardedProps[propName] = prop;
-      }
-    });
-    const pluginParamsWithDefaults = plugins.reduce((acc, plugin) => {
-      if (plugin.applyDefaultValuesToParams) {
-        return plugin.applyDefaultValuesToParams({
-          params: acc
-        });
-      }
-      return acc;
-    }, tempPluginParams);
-    return {
-      forwardedProps: tempForwardedProps,
-      pluginParams: pluginParamsWithDefaults
-    };
-  }, [plugins, props, paramsLookup]);
-  return {
-    forwardedProps,
-    pluginParams,
-    apiRef
-  };
-};
-exports.useExtractPluginParamsFromProps = useExtractPluginParamsFromProps;

package/internals/useTreeView/useTreeView.d.ts

@@ -1,18 +0,0 @@
-import * as React from 'react';
-import { TreeViewAnyPluginSignature } from "../models/index.js";
-import { UseTreeViewBaseProps, UseTreeViewParameters, UseTreeViewReturnValue } from "./useTreeView.types.js";
-export declare function useTreeViewApiInitialization<T>(inputApiRef: React.RefObject<Partial<T> | undefined> | undefined): React.RefObject<T>;
-/**
- * This is the main hook that sets the plugin system up for the tree-view.
- *
- * It manages the data used to create the tree-view.
- *
- * @param plugins All the plugins that will be used in the tree-view.
- * @param props The props passed to the tree-view.
- * @param rootRef The ref of the root element.
- */
-export declare const useTreeView: <TSignatures extends readonly TreeViewAnyPluginSignature[], TProps extends Partial<UseTreeViewBaseProps<TSignatures>>>({
-  plugins: inPlugins,
-  rootRef,
-  props
-}: UseTreeViewParameters<TSignatures, TProps>) => UseTreeViewReturnValue<TSignatures>;

package/internals/useTreeView/useTreeView.js

@@ -1,112 +0,0 @@
-"use strict";
-
-var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useTreeView = void 0;
-exports.useTreeViewApiInitialization = useTreeViewApiInitialization;
-var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
-var React = _interopRequireWildcard(require("react"));
-var _useRefWithInit = require("@base-ui/utils/useRefWithInit");
-var _store = require("@mui/x-internals/store");
-var _useMergedRefs = require("@base-ui/utils/useMergedRefs");
-var _corePlugins = require("../corePlugins");
-var _useExtractPluginParamsFromProps = require("./useExtractPluginParamsFromProps");
-var _useTreeViewBuildContext = require("./useTreeViewBuildContext");
-function initializeInputApiRef(inputApiRef) {
-  if (inputApiRef.current == null) {
-    inputApiRef.current = {};
-  }
-  return inputApiRef;
-}
-function useTreeViewApiInitialization(inputApiRef) {
-  const fallbackPublicApiRef = React.useRef({});
-  if (inputApiRef) {
-    return initializeInputApiRef(inputApiRef);
-  }
-  return fallbackPublicApiRef;
-}
-
-/**
- * This is the main hook that sets the plugin system up for the tree-view.
- *
- * It manages the data used to create the tree-view.
- *
- * @param plugins All the plugins that will be used in the tree-view.
- * @param props The props passed to the tree-view.
- * @param rootRef The ref of the root element.
- */
-const useTreeView = ({
-  plugins: inPlugins,
-  rootRef,
-  props
-}) => {
-  const plugins = React.useMemo(() => [..._corePlugins.TREE_VIEW_CORE_PLUGINS, ...inPlugins], [inPlugins]);
-  const {
-    pluginParams,
-    forwardedProps,
-    apiRef
-  } = (0, _useExtractPluginParamsFromProps.useExtractPluginParamsFromProps)({
-    plugins,
-    props
-  });
-  const instance = (0, _useRefWithInit.useRefWithInit)(() => ({})).current;
-  const publicAPI = useTreeViewApiInitialization(apiRef);
-  const innerRootRef = React.useRef(null);
-  const handleRootRef = (0, _useMergedRefs.useMergedRefs)(innerRootRef, rootRef);
-  const store = (0, _useRefWithInit.useRefWithInit)(() => {
-    const initialState = {};
-    for (const plugin of plugins) {
-      if (plugin.getInitialState) {
-        Object.assign(initialState, plugin.getInitialState(pluginParams));
-      }
-    }
-    return new _store.Store(initialState);
-  }).current;
-  const contextValue = (0, _useTreeViewBuildContext.useTreeViewBuildContext)({
-    plugins,
-    instance,
-    publicAPI: publicAPI.current,
-    store,
-    rootRef: innerRootRef
-  });
-  const rootPropsGetters = [];
-  const runPlugin = plugin => {
-    const pluginResponse = plugin({
-      instance,
-      params: pluginParams,
-      rootRef: innerRootRef,
-      plugins,
-      store
-    });
-    if (pluginResponse.getRootProps) {
-      rootPropsGetters.push(pluginResponse.getRootProps);
-    }
-    if (pluginResponse.publicAPI) {
-      Object.assign(publicAPI.current, pluginResponse.publicAPI);
-    }
-    if (pluginResponse.instance) {
-      Object.assign(instance, pluginResponse.instance);
-    }
-  };
-  plugins.forEach(runPlugin);
-  const getRootProps = (otherHandlers = {}) => {
-    const rootProps = (0, _extends2.default)({
-      role: 'tree'
-    }, forwardedProps, otherHandlers, {
-      ref: handleRootRef
-    });
-    rootPropsGetters.forEach(rootPropsGetter => {
-      Object.assign(rootProps, rootPropsGetter(otherHandlers));
-    });
-    return rootProps;
-  };
-  return {
-    getRootProps,
-    rootRef: handleRootRef,
-    contextValue
-  };
-};
-exports.useTreeView = useTreeView;

package/internals/useTreeView/useTreeView.types.d.ts

@@ -1,20 +0,0 @@
-import * as React from 'react';
-import { EventHandlers } from '@mui/utils/types';
-import type { TreeViewContextValue } from "../TreeViewProvider/index.js";
-import { TreeViewAnyPluginSignature, ConvertSignaturesIntoPlugins, TreeViewPublicAPI } from "../models/index.js";
-export interface UseTreeViewParameters<TSignatures extends readonly TreeViewAnyPluginSignature[], TProps extends Partial<UseTreeViewBaseProps<TSignatures>>> {
-  plugins: ConvertSignaturesIntoPlugins<TSignatures>;
-  rootRef?: React.Ref<HTMLUListElement> | undefined;
-  props: TProps;
-}
-export interface UseTreeViewBaseProps<TSignatures extends readonly TreeViewAnyPluginSignature[]> {
-  apiRef: React.RefObject<Partial<TreeViewPublicAPI<TSignatures>> | undefined> | undefined;
-}
-export interface UseTreeViewRootSlotProps extends Pick<React.HTMLAttributes<HTMLUListElement>, 'onFocus' | 'onBlur' | 'onKeyDown' | 'id' | 'aria-multiselectable' | 'role' | 'tabIndex'> {
-  ref: React.Ref<HTMLUListElement>;
-}
-export interface UseTreeViewReturnValue<TSignatures extends readonly TreeViewAnyPluginSignature[]> {
-  getRootProps: <TOther extends EventHandlers = {}>(otherHandlers?: TOther) => UseTreeViewRootSlotProps;
-  rootRef: React.RefCallback<HTMLUListElement> | null;
-  contextValue: TreeViewContextValue<TSignatures>;
-}

package/internals/useTreeView/useTreeView.types.js

@@ -1,5 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});

package/internals/useTreeView/useTreeViewBuildContext.d.ts

@@ -1,13 +0,0 @@
-import * as React from 'react';
-import { TreeViewContextValue } from "../TreeViewProvider/index.js";
-import { ConvertSignaturesIntoPlugins, TreeViewAnyPluginSignature, TreeViewInstance, TreeViewPublicAPI, TreeViewStore } from "../models/index.js";
-import { TreeViewCorePluginSignatures } from "../corePlugins/index.js";
-export declare const useTreeViewBuildContext: <TSignatures extends readonly TreeViewAnyPluginSignature[]>(parameters: UseTreeViewBuildContextParameters<TSignatures>) => TreeViewContextValue<TSignatures>;
-interface UseTreeViewBuildContextParameters<TSignatures extends readonly TreeViewAnyPluginSignature[]> {
-  plugins: ConvertSignaturesIntoPlugins<readonly [...TreeViewCorePluginSignatures, ...TSignatures]>;
-  instance: TreeViewInstance<TSignatures>;
-  publicAPI: TreeViewPublicAPI<TSignatures>;
-  store: TreeViewStore<readonly [...TreeViewCorePluginSignatures, ...TSignatures]>;
-  rootRef: React.RefObject<HTMLUListElement | null>;
-}
-export {};

package/internals/utils/cleanupTracking/CleanupTracking.d.ts

@@ -1,9 +0,0 @@
-export type UnregisterToken = {
-  cleanupToken: number;
-};
-export type UnsubscribeFn = () => void;
-export interface CleanupTracking {
-  register(object: any, unsubscribe: UnsubscribeFn, unregisterToken: UnregisterToken): void;
-  unregister(unregisterToken: UnregisterToken): void;
-  reset(): void;
-}

package/internals/utils/cleanupTracking/CleanupTracking.js

@@ -1,5 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});

package/internals/utils/cleanupTracking/FinalizationRegistryBasedCleanupTracking.d.ts

@@ -1,7 +0,0 @@
-import { CleanupTracking, UnsubscribeFn, UnregisterToken } from "./CleanupTracking.js";
-export declare class FinalizationRegistryBasedCleanupTracking implements CleanupTracking {
-  registry: FinalizationRegistry<UnsubscribeFn>;
-  register(object: any, unsubscribe: UnsubscribeFn, unregisterToken: UnregisterToken): void;
-  unregister(unregisterToken: UnregisterToken): void;
-  reset(): void;
-}

package/internals/utils/cleanupTracking/FinalizationRegistryBasedCleanupTracking.js

@@ -1,21 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.FinalizationRegistryBasedCleanupTracking = void 0;
-class FinalizationRegistryBasedCleanupTracking {
-  registry = new FinalizationRegistry(unsubscribe => {
-    if (typeof unsubscribe === 'function') {
-      unsubscribe();
-    }
-  });
-  register(object, unsubscribe, unregisterToken) {
-    this.registry.register(object, unsubscribe, unregisterToken);
-  }
-  unregister(unregisterToken) {
-    this.registry.unregister(unregisterToken);
-  }
-  reset() {}
-}
-exports.FinalizationRegistryBasedCleanupTracking = FinalizationRegistryBasedCleanupTracking;

package/internals/utils/cleanupTracking/TimerBasedCleanupTracking.d.ts

@@ -1,9 +0,0 @@
-import { CleanupTracking, UnregisterToken, UnsubscribeFn } from "./CleanupTracking.js";
-export declare class TimerBasedCleanupTracking implements CleanupTracking {
-  timeouts?: Map<number, number> | undefined;
-  cleanupTimeout: number;
-  constructor(timeout?: number);
-  register(object: any, unsubscribe: UnsubscribeFn, unregisterToken: UnregisterToken): void;
-  unregister(unregisterToken: UnregisterToken): void;
-  reset(): void;
-}

package/internals/utils/cleanupTracking/TimerBasedCleanupTracking.js

@@ -1,45 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.TimerBasedCleanupTracking = void 0;
-// If no effect ran after this amount of time, we assume that the render was not committed by React
-const CLEANUP_TIMER_LOOP_MILLIS = 1000;
-class TimerBasedCleanupTracking {
-  timeouts = new Map();
-  cleanupTimeout = CLEANUP_TIMER_LOOP_MILLIS;
-  constructor(timeout = CLEANUP_TIMER_LOOP_MILLIS) {
-    this.cleanupTimeout = timeout;
-  }
-  register(object, unsubscribe, unregisterToken) {
-    if (!this.timeouts) {
-      this.timeouts = new Map();
-    }
-    const timeout = setTimeout(() => {
-      if (typeof unsubscribe === 'function') {
-        unsubscribe();
-      }
-      this.timeouts.delete(unregisterToken.cleanupToken);
-    }, this.cleanupTimeout);
-    this.timeouts.set(unregisterToken.cleanupToken, timeout);
-  }
-  unregister(unregisterToken) {
-    const timeout = this.timeouts.get(unregisterToken.cleanupToken);
-    if (timeout) {
-      this.timeouts.delete(unregisterToken.cleanupToken);
-      clearTimeout(timeout);
-    }
-  }
-  reset() {
-    if (this.timeouts) {
-      this.timeouts.forEach((value, key) => {
-        this.unregister({
-          cleanupToken: key
-        });
-      });
-      this.timeouts = undefined;
-    }
-  }
-}
-exports.TimerBasedCleanupTracking = TimerBasedCleanupTracking;

package/internals/utils/plugins.d.ts

@@ -1,2 +0,0 @@
-import { TreeViewAnyPluginSignature, TreeViewInstance, TreeViewPlugin } from "../models/index.js";
-export declare const hasPlugin: <TSignature extends TreeViewAnyPluginSignature, TInstance extends TreeViewInstance<[], [TSignature]>>(instance: TInstance, plugin: TreeViewPlugin<TSignature>) => instance is Omit<TInstance, keyof TSignature["instance"]> & TSignature["instance"];

package/internals/utils/plugins.js

@@ -1,11 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.hasPlugin = void 0;
-const hasPlugin = (instance, plugin) => {
-  const plugins = instance.getAvailablePlugins();
-  return plugins.has(plugin);
-};
-exports.hasPlugin = hasPlugin;

package/internals/utils/publishTreeViewEvent.d.ts

@@ -1,5 +0,0 @@
-import { UseTreeViewInstanceEventsInstance } from "../corePlugins/useTreeViewInstanceEvents/useTreeViewInstanceEvents.types.js";
-import { TreeViewAnyPluginSignature, TreeViewUsedEvents } from "../models/index.js";
-export declare const publishTreeViewEvent: <Instance extends UseTreeViewInstanceEventsInstance & {
-  $$signature: TreeViewAnyPluginSignature;
-}, E extends keyof TreeViewUsedEvents<Instance["$$signature"]>>(instance: Instance, eventName: E, params: TreeViewUsedEvents<Instance["$$signature"]>[E]["params"]) => void;

package/internals/utils/publishTreeViewEvent.js

@@ -1,10 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.publishTreeViewEvent = void 0;
-const publishTreeViewEvent = (instance, eventName, params) => {
-  instance.$$publishEvent(eventName, params);
-};
-exports.publishTreeViewEvent = publishTreeViewEvent;