@mui/x-tree-view 8.10.2 → 8.11.1

package/useTreeItem/useTreeItem.types.d.ts

@@ -7,6 +7,7 @@ import { UseTreeViewFocusSignature } from "../internals/plugins/useTreeViewFocus
 import { UseTreeViewKeyboardNavigationSignature } from "../internals/plugins/useTreeViewKeyboardNavigation/index.js";
 import { UseTreeViewLabelSignature } from "../internals/plugins/useTreeViewLabel/index.js";
 import { UseTreeViewExpansionSignature } from "../internals/plugins/useTreeViewExpansion/index.js";
+import { UseTreeViewLazyLoadingSignature } from "../internals/plugins/useTreeViewLazyLoading/index.js";
 export interface UseTreeItemParameters {
   /**
    * The id attribute of the item. If not provided, it will be generated.
@@ -199,4 +200,4 @@ export type UseTreeItemMinimalPlugins = readonly [UseTreeViewSelectionSignature,
 /**
  * Plugins that `UseTreeItem` can use if they are present, but are not required.
  */
-export type UseTreeItemOptionalPlugins = readonly [];
+export type UseTreeItemOptionalPlugins = readonly [UseTreeViewLazyLoadingSignature];

package/esm/internals/hooks/useSelector.d.ts

@@ -1,4 +0,0 @@
-import { TreeViewAnyPluginSignature, TreeViewState } from "../models/index.js";
-import { TreeViewStore } from "../utils/TreeViewStore.js";
-import { TreeViewSelector } from "../utils/selectors.js";
-export declare const useSelector: <TSignatures extends readonly TreeViewAnyPluginSignature[], TArgs, TValue>(store: TreeViewStore<TSignatures>, selector: TreeViewSelector<TreeViewState<TSignatures>, TArgs, TValue>, args?: TArgs, equals?: (a: TValue, b: TValue) => boolean) => TValue;

package/esm/internals/hooks/useSelector.js

@@ -1,8 +0,0 @@
-/* We need to import the shim because React 17 does not support the `useSyncExternalStore` API.
- * More info: https://github.com/mui/mui-x/issues/18303#issuecomment-2958392341 */
-import { useSyncExternalStoreWithSelector } from 'use-sync-external-store/shim/with-selector';
-const defaultCompare = Object.is;
-export const useSelector = (store, selector, args = undefined, equals = defaultCompare) => {
-  const selectorWithArgs = state => selector(state, args);
-  return useSyncExternalStoreWithSelector(store.subscribe, store.getSnapshot, store.getSnapshot, selectorWithArgs, equals);
-};

package/esm/internals/utils/TreeViewStore.d.ts

@@ -1,12 +0,0 @@
-import type { TreeViewAnyPluginSignature, TreeViewState } from "../models/index.js";
-type Listener<T> = (value: T) => void;
-export type StoreUpdater<TSignatures extends readonly TreeViewAnyPluginSignature[]> = (prevState: TreeViewState<TSignatures>) => TreeViewState<TSignatures>;
-export declare class TreeViewStore<TSignatures extends readonly TreeViewAnyPluginSignature[]> {
-  value: TreeViewState<TSignatures>;
-  private listeners;
-  constructor(value: TreeViewState<TSignatures>);
-  subscribe: (fn: Listener<TreeViewState<TSignatures>>) => () => void;
-  getSnapshot: () => TreeViewState<TSignatures>;
-  update: (updater: StoreUpdater<TSignatures>) => void;
-}
-export {};

package/esm/internals/utils/TreeViewStore.js

@@ -1,22 +0,0 @@
-export class TreeViewStore {
-  constructor(value) {
-    this.value = value;
-    this.listeners = new Set();
-  }
-  subscribe = fn => {
-    this.listeners.add(fn);
-    return () => {
-      this.listeners.delete(fn);
-    };
-  };
-  getSnapshot = () => {
-    return this.value;
-  };
-  update = updater => {
-    const newState = updater(this.value);
-    if (newState !== this.value) {
-      this.value = newState;
-      this.listeners.forEach(l => l(newState));
-    }
-  };
-}

package/esm/internals/utils/selectors.d.ts

@@ -1,21 +0,0 @@
-import { CreateSelectorFunction } from 'reselect';
-import { TreeViewAnyPluginSignature, TreeViewState } from "../models/index.js";
-/**
- * Type of a selector that take the whole tree view state as input and returns a value based on a required plugin.
- * @param {TreeViewState} state The state of the Tree View.
- * @returns {any | undefined} The value of the plugin state.
- */
-export type TreeViewRootSelector<TSignature extends TreeViewAnyPluginSignature, TIsOptional extends boolean = false> = <TSignatures extends (TIsOptional extends true ? [] : [TSignature]), TOptionalSignatures extends (TIsOptional extends true ? [TSignature] : [])>(state: TreeViewState<TSignatures, TOptionalSignatures>) => TIsOptional extends true ? TSignature['state'][keyof TSignature['state']] | undefined : TSignature['state'][keyof TSignature['state']];
-/**
- * Type of a selector that take the whole tree view state as input and returns a value based on an optional plugin.
- *
- * @param {TreeViewState} state The state of the Tree View.
- * @returns {any | undefined} The value of the plugin state or undefined if the plugin is not registered.
- */
-export type TreeViewRootSelectorForOptionalPlugin<TSignature extends TreeViewAnyPluginSignature> = <TSignatures extends [], TOptionalSignatures extends [TSignature]>(state: TreeViewState<TSignatures, TOptionalSignatures>) => TSignature['state'][keyof TSignature['state']] | undefined;
-export type TreeViewSelector<TState, TArgs, TResult> = (state: TState, args: TArgs) => TResult;
-/**
- * Method wrapping reselect's createSelector to provide caching for tree view instances.
- *
- */
-export declare const createSelector: CreateSelectorFunction;

package/esm/internals/utils/selectors.js

@@ -1,51 +0,0 @@
-import { lruMemoize, createSelectorCreator } from 'reselect';
-const reselectCreateSelector = createSelectorCreator({
-  memoize: lruMemoize,
-  memoizeOptions: {
-    maxSize: 1,
-    equalityCheck: Object.is
-  }
-});
-const cache = new WeakMap();
-
-/**
- * Type of a selector that take the whole tree view state as input and returns a value based on a required plugin.
- * @param {TreeViewState} state The state of the Tree View.
- * @returns {any | undefined} The value of the plugin state.
- */
-
-/**
- * Type of a selector that take the whole tree view state as input and returns a value based on an optional plugin.
- *
- * @param {TreeViewState} state The state of the Tree View.
- * @returns {any | undefined} The value of the plugin state or undefined if the plugin is not registered.
- */
-
-/**
- * Method wrapping reselect's createSelector to provide caching for tree view instances.
- *
- */
-export const createSelector = (...createSelectorArgs) => {
-  const selector = (state, selectorArgs) => {
-    const cacheKey = state.cacheKey;
-
-    // If there is no cache for the current tree view instance, create one.
-    let cacheForCurrentTreeViewInstance = cache.get(cacheKey);
-    if (!cacheForCurrentTreeViewInstance) {
-      cacheForCurrentTreeViewInstance = new Map();
-      cache.set(cacheKey, cacheForCurrentTreeViewInstance);
-    }
-
-    // If there is a cached selector, execute it.
-    const cachedSelector = cacheForCurrentTreeViewInstance.get(createSelectorArgs);
-    if (cachedSelector) {
-      return cachedSelector(state, selectorArgs);
-    }
-
-    // Otherwise, create a new selector and cache it and execute it.
-    const fn = reselectCreateSelector(...createSelectorArgs);
-    cacheForCurrentTreeViewInstance.set(createSelectorArgs, fn);
-    return fn(state, selectorArgs);
-  };
-  return selector;
-};

package/internals/hooks/useSelector.d.ts

@@ -1,4 +0,0 @@
-import { TreeViewAnyPluginSignature, TreeViewState } from "../models/index.js";
-import { TreeViewStore } from "../utils/TreeViewStore.js";
-import { TreeViewSelector } from "../utils/selectors.js";
-export declare const useSelector: <TSignatures extends readonly TreeViewAnyPluginSignature[], TArgs, TValue>(store: TreeViewStore<TSignatures>, selector: TreeViewSelector<TreeViewState<TSignatures>, TArgs, TValue>, args?: TArgs, equals?: (a: TValue, b: TValue) => boolean) => TValue;

package/internals/hooks/useSelector.js

@@ -1,16 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useSelector = void 0;
-var _withSelector = require("use-sync-external-store/shim/with-selector");
-/* We need to import the shim because React 17 does not support the `useSyncExternalStore` API.
- * More info: https://github.com/mui/mui-x/issues/18303#issuecomment-2958392341 */
-
-const defaultCompare = Object.is;
-const useSelector = (store, selector, args = undefined, equals = defaultCompare) => {
-  const selectorWithArgs = state => selector(state, args);
-  return (0, _withSelector.useSyncExternalStoreWithSelector)(store.subscribe, store.getSnapshot, store.getSnapshot, selectorWithArgs, equals);
-};
-exports.useSelector = useSelector;

package/internals/utils/TreeViewStore.d.ts

@@ -1,12 +0,0 @@
-import type { TreeViewAnyPluginSignature, TreeViewState } from "../models/index.js";
-type Listener<T> = (value: T) => void;
-export type StoreUpdater<TSignatures extends readonly TreeViewAnyPluginSignature[]> = (prevState: TreeViewState<TSignatures>) => TreeViewState<TSignatures>;
-export declare class TreeViewStore<TSignatures extends readonly TreeViewAnyPluginSignature[]> {
-  value: TreeViewState<TSignatures>;
-  private listeners;
-  constructor(value: TreeViewState<TSignatures>);
-  subscribe: (fn: Listener<TreeViewState<TSignatures>>) => () => void;
-  getSnapshot: () => TreeViewState<TSignatures>;
-  update: (updater: StoreUpdater<TSignatures>) => void;
-}
-export {};

package/internals/utils/TreeViewStore.js

@@ -1,29 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.TreeViewStore = void 0;
-class TreeViewStore {
-  constructor(value) {
-    this.value = value;
-    this.listeners = new Set();
-  }
-  subscribe = fn => {
-    this.listeners.add(fn);
-    return () => {
-      this.listeners.delete(fn);
-    };
-  };
-  getSnapshot = () => {
-    return this.value;
-  };
-  update = updater => {
-    const newState = updater(this.value);
-    if (newState !== this.value) {
-      this.value = newState;
-      this.listeners.forEach(l => l(newState));
-    }
-  };
-}
-exports.TreeViewStore = TreeViewStore;

package/internals/utils/selectors.d.ts

@@ -1,21 +0,0 @@
-import { CreateSelectorFunction } from 'reselect';
-import { TreeViewAnyPluginSignature, TreeViewState } from "../models/index.js";
-/**
- * Type of a selector that take the whole tree view state as input and returns a value based on a required plugin.
- * @param {TreeViewState} state The state of the Tree View.
- * @returns {any | undefined} The value of the plugin state.
- */
-export type TreeViewRootSelector<TSignature extends TreeViewAnyPluginSignature, TIsOptional extends boolean = false> = <TSignatures extends (TIsOptional extends true ? [] : [TSignature]), TOptionalSignatures extends (TIsOptional extends true ? [TSignature] : [])>(state: TreeViewState<TSignatures, TOptionalSignatures>) => TIsOptional extends true ? TSignature['state'][keyof TSignature['state']] | undefined : TSignature['state'][keyof TSignature['state']];
-/**
- * Type of a selector that take the whole tree view state as input and returns a value based on an optional plugin.
- *
- * @param {TreeViewState} state The state of the Tree View.
- * @returns {any | undefined} The value of the plugin state or undefined if the plugin is not registered.
- */
-export type TreeViewRootSelectorForOptionalPlugin<TSignature extends TreeViewAnyPluginSignature> = <TSignatures extends [], TOptionalSignatures extends [TSignature]>(state: TreeViewState<TSignatures, TOptionalSignatures>) => TSignature['state'][keyof TSignature['state']] | undefined;
-export type TreeViewSelector<TState, TArgs, TResult> = (state: TState, args: TArgs) => TResult;
-/**
- * Method wrapping reselect's createSelector to provide caching for tree view instances.
- *
- */
-export declare const createSelector: CreateSelectorFunction;

package/internals/utils/selectors.js

@@ -1,58 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createSelector = void 0;
-var _reselect = require("reselect");
-const reselectCreateSelector = (0, _reselect.createSelectorCreator)({
-  memoize: _reselect.lruMemoize,
-  memoizeOptions: {
-    maxSize: 1,
-    equalityCheck: Object.is
-  }
-});
-const cache = new WeakMap();
-
-/**
- * Type of a selector that take the whole tree view state as input and returns a value based on a required plugin.
- * @param {TreeViewState} state The state of the Tree View.
- * @returns {any | undefined} The value of the plugin state.
- */
-
-/**
- * Type of a selector that take the whole tree view state as input and returns a value based on an optional plugin.
- *
- * @param {TreeViewState} state The state of the Tree View.
- * @returns {any | undefined} The value of the plugin state or undefined if the plugin is not registered.
- */
-
-/**
- * Method wrapping reselect's createSelector to provide caching for tree view instances.
- *
- */
-const createSelector = (...createSelectorArgs) => {
-  const selector = (state, selectorArgs) => {
-    const cacheKey = state.cacheKey;
-
-    // If there is no cache for the current tree view instance, create one.
-    let cacheForCurrentTreeViewInstance = cache.get(cacheKey);
-    if (!cacheForCurrentTreeViewInstance) {
-      cacheForCurrentTreeViewInstance = new Map();
-      cache.set(cacheKey, cacheForCurrentTreeViewInstance);
-    }
-
-    // If there is a cached selector, execute it.
-    const cachedSelector = cacheForCurrentTreeViewInstance.get(createSelectorArgs);
-    if (cachedSelector) {
-      return cachedSelector(state, selectorArgs);
-    }
-
-    // Otherwise, create a new selector and cache it and execute it.
-    const fn = reselectCreateSelector(...createSelectorArgs);
-    cacheForCurrentTreeViewInstance.set(createSelectorArgs, fn);
-    return fn(state, selectorArgs);
-  };
-  return selector;
-};
-exports.createSelector = createSelector;