@mui/x-tree-view 8.22.0 → 8.24.0

package/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.js

@@ -1,312 +0,0 @@
-"use strict";
-'use client';
-
-var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useTreeViewKeyboardNavigation = void 0;
-var React = _interopRequireWildcard(require("react"));
-var _store = require("@mui/x-internals/store");
-var _RtlProvider = require("@mui/system/RtlProvider");
-var _useTimeout = require("@base-ui-components/utils/useTimeout");
-var _useEventCallback = require("@base-ui-components/utils/useEventCallback");
-var _tree = require("../../utils/tree");
-var _plugins = require("../../utils/plugins");
-var _useTreeViewLabel = require("../useTreeViewLabel");
-var _useTreeViewItems = require("../useTreeViewItems/useTreeViewItems.selectors");
-var _useTreeViewLabel2 = require("../useTreeViewLabel/useTreeViewLabel.selectors");
-var _useTreeViewSelection = require("../useTreeViewSelection/useTreeViewSelection.selectors");
-var _useTreeViewExpansion = require("../useTreeViewExpansion/useTreeViewExpansion.selectors");
-function isPrintableKey(string) {
-  return !!string && string.length === 1 && !!string.match(/\S/);
-}
-const TYPEAHEAD_TIMEOUT = 500;
-const useTreeViewKeyboardNavigation = ({
-  instance,
-  store,
-  params
-}) => {
-  const isRtl = (0, _RtlProvider.useRtl)();
-  const labelMap = React.useRef({});
-  const typeaheadQueryRef = React.useRef('');
-  const typeaheadTimeout = (0, _useTimeout.useTimeout)();
-  const updateLabelMap = (0, _useEventCallback.useEventCallback)(callback => {
-    labelMap.current = callback(labelMap.current);
-  });
-  const itemMetaLookup = (0, _store.useStore)(store, _useTreeViewItems.itemsSelectors.itemMetaLookup);
-  React.useEffect(() => {
-    if (instance.areItemUpdatesPrevented()) {
-      return;
-    }
-    const newLabelMap = {};
-    const processItem = item => {
-      newLabelMap[item.id] = item.label.toLowerCase();
-    };
-    Object.values(itemMetaLookup).forEach(processItem);
-    labelMap.current = newLabelMap;
-  }, [itemMetaLookup, params.getItemId, instance]);
-  const getNextItem = itemIdToCheck => {
-    const nextItemId = (0, _tree.getNextNavigableItem)(store.state, itemIdToCheck);
-    // We reached the end of the tree, check from the beginning
-    if (nextItemId === null) {
-      return (0, _tree.getFirstNavigableItem)(store.state);
-    }
-    return nextItemId;
-  };
-  const getNextMatchingItemId = (itemId, query) => {
-    let matchingItemId = null;
-    const checkedItems = {};
-    // If query length > 1, first check if current item matches
-    let currentItemId = query.length > 1 ? itemId : getNextItem(itemId);
-    // The "!checkedItems[currentItemId]" condition avoids an infinite loop when there is no matching item.
-    while (matchingItemId == null && !checkedItems[currentItemId]) {
-      const itemLabel = labelMap.current[currentItemId];
-      if (itemLabel?.startsWith(query)) {
-        matchingItemId = currentItemId;
-      } else {
-        checkedItems[currentItemId] = true;
-        currentItemId = getNextItem(currentItemId);
-      }
-    }
-    return matchingItemId;
-  };
-  const getFirstMatchingItem = (itemId, newKey) => {
-    const cleanNewKey = newKey.toLowerCase();
-
-    // Try matching with accumulated query + new key
-    const concatenatedQuery = `${typeaheadQueryRef.current}${cleanNewKey}`;
-
-    // check if the entire typed query matches an item
-    const concatenatedQueryMatchingItemId = getNextMatchingItemId(itemId, concatenatedQuery);
-    if (concatenatedQueryMatchingItemId != null) {
-      typeaheadQueryRef.current = concatenatedQuery;
-      return concatenatedQueryMatchingItemId;
-    }
-    const newKeyMatchingItemId = getNextMatchingItemId(itemId, cleanNewKey);
-    if (newKeyMatchingItemId != null) {
-      typeaheadQueryRef.current = cleanNewKey;
-      return newKeyMatchingItemId;
-    }
-    typeaheadQueryRef.current = '';
-    return null;
-  };
-  const canToggleItemSelection = itemId => _useTreeViewSelection.selectionSelectors.enabled(store.state) && !_useTreeViewItems.itemsSelectors.isItemDisabled(store.state, itemId);
-  const canToggleItemExpansion = itemId => {
-    return !_useTreeViewItems.itemsSelectors.isItemDisabled(store.state, itemId) && _useTreeViewExpansion.expansionSelectors.isItemExpandable(store.state, itemId);
-  };
-
-  // ARIA specification: https://www.w3.org/WAI/ARIA/apg/patterns/treeview/#keyboardinteraction
-  const handleItemKeyDown = async (event, itemId) => {
-    if (event.defaultMuiPrevented) {
-      return;
-    }
-    if (event.altKey || (0, _tree.isTargetInDescendants)(event.target, event.currentTarget)) {
-      return;
-    }
-    const ctrlPressed = event.ctrlKey || event.metaKey;
-    const key = event.key;
-    const isMultiSelectEnabled = _useTreeViewSelection.selectionSelectors.isMultiSelectEnabled(store.state);
-
-    // eslint-disable-next-line default-case
-    switch (true) {
-      // Select the item when pressing "Space"
-      case key === ' ' && canToggleItemSelection(itemId):
-        {
-          event.preventDefault();
-          if (isMultiSelectEnabled && event.shiftKey) {
-            instance.expandSelectionRange(event, itemId);
-          } else {
-            instance.setItemSelection({
-              event,
-              itemId,
-              keepExistingSelection: isMultiSelectEnabled,
-              shouldBeSelected: undefined
-            });
-          }
-          break;
-        }
-
-      // If the focused item has children, we expand it.
-      // If the focused item has no children, we select it.
-      case key === 'Enter':
-        {
-          if ((0, _plugins.hasPlugin)(instance, _useTreeViewLabel.useTreeViewLabel) && _useTreeViewLabel2.labelSelectors.isItemEditable(store.state, itemId) && !_useTreeViewLabel2.labelSelectors.isItemBeingEdited(store.state, itemId)) {
-            instance.setEditedItem(itemId);
-          } else if (canToggleItemExpansion(itemId)) {
-            instance.setItemExpansion({
-              event,
-              itemId
-            });
-            event.preventDefault();
-          } else if (canToggleItemSelection(itemId)) {
-            if (isMultiSelectEnabled) {
-              event.preventDefault();
-              instance.setItemSelection({
-                event,
-                itemId,
-                keepExistingSelection: true
-              });
-            } else if (!_useTreeViewSelection.selectionSelectors.isItemSelected(store.state, itemId)) {
-              instance.setItemSelection({
-                event,
-                itemId
-              });
-              event.preventDefault();
-            }
-          }
-          break;
-        }
-
-      // Focus the next focusable item
-      case key === 'ArrowDown':
-        {
-          const nextItem = (0, _tree.getNextNavigableItem)(store.state, itemId);
-          if (nextItem) {
-            event.preventDefault();
-            instance.focusItem(event, nextItem);
-
-            // Multi select behavior when pressing Shift + ArrowDown
-            // Toggles the selection state of the next item
-            if (isMultiSelectEnabled && event.shiftKey && canToggleItemSelection(nextItem)) {
-              instance.selectItemFromArrowNavigation(event, itemId, nextItem);
-            }
-          }
-          break;
-        }
-
-      // Focuses the previous focusable item
-      case key === 'ArrowUp':
-        {
-          const previousItem = (0, _tree.getPreviousNavigableItem)(store.state, itemId);
-          if (previousItem) {
-            event.preventDefault();
-            instance.focusItem(event, previousItem);
-
-            // Multi select behavior when pressing Shift + ArrowUp
-            // Toggles the selection state of the previous item
-            if (isMultiSelectEnabled && event.shiftKey && canToggleItemSelection(previousItem)) {
-              instance.selectItemFromArrowNavigation(event, itemId, previousItem);
-            }
-          }
-          break;
-        }
-
-      // If the focused item is expanded, we move the focus to its first child
-      // If the focused item is collapsed and has children, we expand it
-      case key === 'ArrowRight' && !isRtl || key === 'ArrowLeft' && isRtl:
-        {
-          if (ctrlPressed) {
-            return;
-          }
-          if (_useTreeViewExpansion.expansionSelectors.isItemExpanded(store.state, itemId)) {
-            const nextItemId = (0, _tree.getNextNavigableItem)(store.state, itemId);
-            if (nextItemId) {
-              instance.focusItem(event, nextItemId);
-              event.preventDefault();
-            }
-          } else if (canToggleItemExpansion(itemId)) {
-            instance.setItemExpansion({
-              event,
-              itemId
-            });
-            event.preventDefault();
-          }
-          break;
-        }
-
-      // If the focused item is expanded, we collapse it
-      // If the focused item is collapsed and has a parent, we move the focus to this parent
-      case key === 'ArrowLeft' && !isRtl || key === 'ArrowRight' && isRtl:
-        {
-          if (ctrlPressed) {
-            return;
-          }
-          if (canToggleItemExpansion(itemId) && _useTreeViewExpansion.expansionSelectors.isItemExpanded(store.state, itemId)) {
-            instance.setItemExpansion({
-              event,
-              itemId
-            });
-            event.preventDefault();
-          } else {
-            const parent = _useTreeViewItems.itemsSelectors.itemParentId(store.state, itemId);
-            if (parent) {
-              instance.focusItem(event, parent);
-              event.preventDefault();
-            }
-          }
-          break;
-        }
-
-      // Focuses the first item in the tree
-      case key === 'Home':
-        {
-          // Multi select behavior when pressing Ctrl + Shift + Home
-          // Selects the focused item and all items up to the first item.
-          if (canToggleItemSelection(itemId) && isMultiSelectEnabled && ctrlPressed && event.shiftKey) {
-            instance.selectRangeFromStartToItem(event, itemId);
-          } else {
-            instance.focusItem(event, (0, _tree.getFirstNavigableItem)(store.state));
-          }
-          event.preventDefault();
-          break;
-        }
-
-      // Focuses the last item in the tree
-      case key === 'End':
-        {
-          // Multi select behavior when pressing Ctrl + Shirt + End
-          // Selects the focused item and all the items down to the last item.
-          if (canToggleItemSelection(itemId) && isMultiSelectEnabled && ctrlPressed && event.shiftKey) {
-            instance.selectRangeFromItemToEnd(event, itemId);
-          } else {
-            instance.focusItem(event, (0, _tree.getLastNavigableItem)(store.state));
-          }
-          event.preventDefault();
-          break;
-        }
-
-      // Expand all siblings that are at the same level as the focused item
-      case key === '*':
-        {
-          instance.expandAllSiblings(event, itemId);
-          event.preventDefault();
-          break;
-        }
-
-      // Multi select behavior when pressing Ctrl + a
-      // Selects all the items
-      case String.fromCharCode(event.keyCode) === 'A' && ctrlPressed && isMultiSelectEnabled && _useTreeViewSelection.selectionSelectors.enabled(store.state):
-        {
-          instance.selectAllNavigableItems(event);
-          event.preventDefault();
-          break;
-        }
-
-      // Type-ahead
-      case !ctrlPressed && !event.shiftKey && isPrintableKey(key):
-        {
-          typeaheadTimeout.clear();
-          const matchingItem = getFirstMatchingItem(itemId, key);
-          if (matchingItem != null) {
-            instance.focusItem(event, matchingItem);
-            event.preventDefault();
-          } else {
-            typeaheadQueryRef.current = '';
-          }
-          typeaheadTimeout.start(TYPEAHEAD_TIMEOUT, () => {
-            typeaheadQueryRef.current = '';
-          });
-          break;
-        }
-    }
-  };
-  return {
-    instance: {
-      updateLabelMap,
-      handleItemKeyDown
-    }
-  };
-};
-exports.useTreeViewKeyboardNavigation = useTreeViewKeyboardNavigation;
-useTreeViewKeyboardNavigation.params = {};

package/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.types.d.ts

@@ -1,32 +0,0 @@
-import * as React from 'react';
-import { TreeViewPluginSignature } from "../../models/index.js";
-import { UseTreeViewItemsSignature } from "../useTreeViewItems/index.js";
-import { UseTreeViewSelectionSignature } from "../useTreeViewSelection/index.js";
-import { UseTreeViewFocusSignature } from "../useTreeViewFocus/index.js";
-import { UseTreeViewExpansionSignature } from "../useTreeViewExpansion/index.js";
-import { UseTreeViewLabelSignature } from "../useTreeViewLabel/index.js";
-import { TreeViewItemId, TreeViewCancellableEvent } from "../../../models/index.js";
-export interface UseTreeViewKeyboardNavigationInstance {
-  /**
-   * Updates the `labelMap` to add/remove the first character of some item's labels.
-   * This map is used to navigate the tree using type-ahead search.
-   * This method is only used by the `useTreeViewJSXItems` plugin, otherwise the updates are handled internally.
-   * @param {(map: TreeViewLabelMap) => TreeViewLabelMap} updater The function to update the map.
-   */
-  updateLabelMap: (updater: (map: TreeViewLabelMap) => TreeViewLabelMap) => void;
-  /**
-   * Callback fired when a key is pressed on an item.
-   * Handles all the keyboard navigation logic.
-   * @param {React.KeyboardEvent<HTMLElement> & TreeViewCancellableEvent} event The keyboard event that triggered the callback.
-   * @param {TreeViewItemId} itemId The id of the item that the event was triggered on.
-   */
-  handleItemKeyDown: (event: React.KeyboardEvent<HTMLElement> & TreeViewCancellableEvent, itemId: TreeViewItemId) => void;
-}
-export type UseTreeViewKeyboardNavigationSignature = TreeViewPluginSignature<{
-  instance: UseTreeViewKeyboardNavigationInstance;
-  dependencies: [UseTreeViewItemsSignature, UseTreeViewSelectionSignature, UseTreeViewFocusSignature, UseTreeViewExpansionSignature];
-  optionalDependencies: [UseTreeViewLabelSignature];
-}>;
-export type TreeViewLabelMap = {
-  [itemId: string]: string;
-};

package/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.types.js

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

package/internals/plugins/useTreeViewLabel/index.d.ts

@@ -1,3 +0,0 @@
-export { useTreeViewLabel } from "./useTreeViewLabel.js";
-export type { UseTreeViewLabelSignature, UseTreeViewLabelParameters } from "./useTreeViewLabel.types.js";
-export { labelSelectors } from "./useTreeViewLabel.selectors.js";

package/internals/plugins/useTreeViewLabel/index.js

@@ -1,19 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "labelSelectors", {
-  enumerable: true,
-  get: function () {
-    return _useTreeViewLabel2.labelSelectors;
-  }
-});
-Object.defineProperty(exports, "useTreeViewLabel", {
-  enumerable: true,
-  get: function () {
-    return _useTreeViewLabel.useTreeViewLabel;
-  }
-});
-var _useTreeViewLabel = require("./useTreeViewLabel");
-var _useTreeViewLabel2 = require("./useTreeViewLabel.selectors");

package/internals/plugins/useTreeViewLabel/useTreeViewLabel.d.ts

@@ -1,3 +0,0 @@
-import { TreeViewPlugin } from "../../models/index.js";
-import { UseTreeViewLabelSignature } from "./useTreeViewLabel.types.js";
-export declare const useTreeViewLabel: TreeViewPlugin<UseTreeViewLabelSignature>;

package/internals/plugins/useTreeViewLabel/useTreeViewLabel.js

@@ -1,78 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useTreeViewLabel = void 0;
-var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
-var _useIsoLayoutEffect = require("@base-ui-components/utils/useIsoLayoutEffect");
-var _itemPlugin = require("./itemPlugin");
-var _useTreeViewLabel = require("./useTreeViewLabel.selectors");
-const useTreeViewLabel = ({
-  store,
-  params
-}) => {
-  const setEditedItem = editedItemId => {
-    if (editedItemId !== null) {
-      const isEditable = _useTreeViewLabel.labelSelectors.isItemEditable(store.state, editedItemId);
-      if (!isEditable) {
-        return;
-      }
-    }
-    store.set('label', (0, _extends2.default)({}, store.state.label, {
-      editedItemId
-    }));
-  };
-  const updateItemLabel = (itemId, label) => {
-    if (!label) {
-      throw new Error(['MUI X: The Tree View component requires all items to have a `label` property.', 'The label of an item cannot be empty.', itemId].join('\n'));
-    }
-    const item = store.state.items.itemMetaLookup[itemId];
-    if (item.label === label) {
-      return;
-    }
-    store.set('items', (0, _extends2.default)({}, store.state.items, {
-      itemMetaLookup: (0, _extends2.default)({}, store.state.items.itemMetaLookup, {
-        [itemId]: (0, _extends2.default)({}, item, {
-          label
-        })
-      })
-    }));
-    if (params.onItemLabelChange) {
-      params.onItemLabelChange(itemId, label);
-    }
-  };
-  (0, _useIsoLayoutEffect.useIsoLayoutEffect)(() => {
-    store.set('label', (0, _extends2.default)({}, store.state.label, {
-      isItemEditable: params.isItemEditable
-    }));
-  }, [store, params.isItemEditable]);
-  return {
-    instance: {
-      setEditedItem,
-      updateItemLabel
-    },
-    publicAPI: {
-      setEditedItem,
-      updateItemLabel
-    }
-  };
-};
-exports.useTreeViewLabel = useTreeViewLabel;
-useTreeViewLabel.itemPlugin = _itemPlugin.useTreeViewLabelItemPlugin;
-useTreeViewLabel.applyDefaultValuesToParams = ({
-  params
-}) => (0, _extends2.default)({}, params, {
-  isItemEditable: params.isItemEditable ?? false
-});
-useTreeViewLabel.getInitialState = params => ({
-  label: {
-    isItemEditable: params.isItemEditable,
-    editedItemId: null
-  }
-});
-useTreeViewLabel.params = {
-  onItemLabelChange: true,
-  isItemEditable: true
-};

package/internals/plugins/useTreeViewLabel/useTreeViewLabel.selectors.d.ts

@@ -1,16 +0,0 @@
-import { UseTreeViewLabelSignature } from "./useTreeViewLabel.types.js";
-import { TreeViewState } from "../../models/index.js";
-export declare const labelSelectors: {
-  /**
-   * Checks whether an item is editable.
-   */
-  isItemEditable: (args_0: import("../../corePlugins/useTreeViewId/useTreeViewId.types.js").UseTreeViewIdState & import("../useTreeViewItems/index.js").UseTreeViewItemsState<import("../../../index.js").TreeViewDefaultItemModelProperties> & Partial<{}>, _itemId: string) => boolean;
-  /**
-   * Checks whether an item is being edited.
-   */
-  isItemBeingEdited: (state: TreeViewState<[], [UseTreeViewLabelSignature]>, itemId: string | null) => boolean;
-  /**
-   * Checks whether any item is being edited.
-   */
-  isAnyItemBeingEdited: (state: TreeViewState<[], [UseTreeViewLabelSignature]>) => boolean;
-};

package/internals/plugins/useTreeViewLabel/useTreeViewLabel.types.d.ts

@@ -1,50 +0,0 @@
-import { DefaultizedProps } from '@mui/x-internals/types';
-import { TreeViewPluginSignature } from "../../models/index.js";
-import { TreeViewItemId } from "../../../models/index.js";
-import { UseTreeViewItemsSignature } from "../useTreeViewItems/index.js";
-export interface UseTreeViewLabelPublicAPI {
-  /**
-   * Used to update the label of an item.
-   * @param {TreeViewItemId} itemId The id of the item to update the label of.
-   * @param {string} newLabel The new label of the item.
-   */
-  updateItemLabel: (itemId: TreeViewItemId, newLabel: string) => void;
-  /**
-   * Set which item is currently being edited.
-   * You can pass `null` to exit editing mode.
-   * @param {TreeViewItemId | null} itemId The id of the item to edit, or `null` to exit editing mode.
-   */
-  setEditedItem: (itemId: TreeViewItemId | null) => void;
-}
-export interface UseTreeViewLabelInstance extends UseTreeViewLabelPublicAPI {}
-export interface UseTreeViewLabelParameters<R extends {}> {
-  /**
-   * Callback fired when the label of an item changes.
-   * @param {TreeViewItemId} itemId The id of the item that was edited.
-   * @param {string} newLabel The new label of the items.
-   */
-  onItemLabelChange?: (itemId: TreeViewItemId, newLabel: string) => void;
-  /**
-   * Determine if a given item can be edited.
-   * @template R
-   * @param {R} item The item to check.
-   * @returns {boolean} `true` if the item can be edited.
-   * @default () => false
-   */
-  isItemEditable?: boolean | ((item: R) => boolean);
-}
-export type UseTreeViewLabelParametersWithDefaults<R extends {}> = DefaultizedProps<UseTreeViewLabelParameters<R>, 'isItemEditable'>;
-export interface UseTreeViewLabelState {
-  label: {
-    isItemEditable: ((item: any) => boolean) | boolean;
-    editedItemId: TreeViewItemId | null;
-  };
-}
-export type UseTreeViewLabelSignature = TreeViewPluginSignature<{
-  params: UseTreeViewLabelParameters<any>;
-  paramsWithDefaults: UseTreeViewLabelParametersWithDefaults<any>;
-  publicAPI: UseTreeViewLabelPublicAPI;
-  instance: UseTreeViewLabelInstance;
-  state: UseTreeViewLabelState;
-  dependencies: [UseTreeViewItemsSignature];
-}>;

package/internals/plugins/useTreeViewLabel/useTreeViewLabel.types.js

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

package/internals/plugins/useTreeViewLazyLoading/index.d.ts

@@ -1,2 +0,0 @@
-export type { UseTreeViewLazyLoadingSignature, UseTreeViewLazyLoadingParameters, UseTreeViewLazyLoadingInstance, DataSource } from "./useTreeViewLazyLoading.types.js";
-export { lazyLoadingSelectors } from "./useTreeViewLazyLoading.selectors.js";

package/internals/plugins/useTreeViewLazyLoading/index.js

@@ -1,12 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "lazyLoadingSelectors", {
-  enumerable: true,
-  get: function () {
-    return _useTreeViewLazyLoading.lazyLoadingSelectors;
-  }
-});
-var _useTreeViewLazyLoading = require("./useTreeViewLazyLoading.selectors");

package/internals/plugins/useTreeViewLazyLoading/useTreeViewLazyLoading.selectors.d.ts

@@ -1,24 +0,0 @@
-import { TreeViewItemId } from "../../../models/index.js";
-import { UseTreeViewLazyLoadingSignature } from "./useTreeViewLazyLoading.types.js";
-import { TreeViewState } from "../../models/index.js";
-export declare const lazyLoadingSelectors: {
-  /**
-   * Gets the data source used to lazy load items.
-   */
-  dataSource: (state: TreeViewState<[], [UseTreeViewLazyLoadingSignature]>) => {
-    loading: Record<TreeViewItemId, boolean>;
-    errors: Record<TreeViewItemId, Error | null>;
-  } | undefined;
-  /**
-   * Checks whether an item is loading.
-   */
-  isItemLoading: (state: TreeViewState<[], [UseTreeViewLazyLoadingSignature]>, itemId: string | null) => boolean;
-  /**
-   * Checks whether an item has errors.
-   */
-  itemHasError: (state: TreeViewState<[], [UseTreeViewLazyLoadingSignature]>, itemId: string | null) => boolean;
-  /**
-   * Get an item error.
-   */
-  itemError: (state: TreeViewState<[], [UseTreeViewLazyLoadingSignature]>, itemId: string | null) => Error | null | undefined;
-};

package/internals/plugins/useTreeViewLazyLoading/useTreeViewLazyLoading.types.d.ts

@@ -1,100 +0,0 @@
-import { DefaultizedProps } from '@mui/x-internals/types';
-import { TreeViewPluginSignature } from "../../models/index.js";
-import { DataSourceCache } from "../../../utils/index.js";
-import { TreeViewItemId } from "../../../models/index.js";
-import { UseTreeViewItemsSignature } from "../useTreeViewItems/index.js";
-import { UseTreeViewExpansionSignature } from "../useTreeViewExpansion/index.js";
-import { UseTreeViewSelectionSignature } from "../useTreeViewSelection/index.js";
-export type DataSource<R extends {}> = {
-  /**
-   * Used to determine the number of children the item has.
-   * Only relevant for lazy-loaded trees.
-   *
-   * @template R
-   * @param {R} item The item to check.
-   * @returns {number} The number of children.
-   */
-  getChildrenCount: (item: R) => number;
-  /**
-   * Method used for fetching the items.
-   * Only relevant for lazy-loaded tree views.
-   *
-   * @template R
-   * @param {TreeViewItemId} parentId The id of the item the children belong to.
-   * @returns { Promise<R[]>} The children of the item.
-   */
-  getTreeItems: (parentId?: TreeViewItemId) => Promise<R[]>;
-};
-export interface UseTreeViewLazyLoadingPublicAPI {
-  /**
-   * Method used for updating an item's children.
-   * Only relevant for lazy-loaded tree views.
-   *
-   * @param {TreeViewItemId | null} itemId The id of the item to update the children of. If null is passed, it will update the root's children.
-   * @returns {Promise<void>} The promise resolved when the items are fetched.
-   */
-  updateItemChildren: (itemId: TreeViewItemId | null) => Promise<void>;
-}
-export interface UseTreeViewLazyLoadingInstance extends UseTreeViewLazyLoadingPublicAPI {
-  /**
-   * Method used for fetching multiple items concurrently.
-   * Only relevant for lazy-loaded tree views.
-   *
-   * @param {TreeViewItemId[]} parentIds The ids of the items to fetch the children of.
-   * @returns {Promise<void>} The promise resolved when the items are fetched.
-   */
-  fetchItems: (parentIds: TreeViewItemId[]) => Promise<void>;
-  /**
-   * Method used for fetching an item's children.
-   * Only relevant for lazy-loaded tree views.
-   *
-   * @param {object} parameters The parameters of the method.
-   * @param {TreeViewItemId} parameters.itemId The The id of the item to fetch the children of.
-   * @param {boolean} [parameters.forceRefresh] Whether to force a refresh of the children when the cache already contains some data.
-   * @returns {Promise<void>} The promise resolved when the items are fetched.
-   */
-  fetchItemChildren: (parameters: {
-    itemId: TreeViewItemId | null;
-    forceRefresh?: boolean;
-  }) => Promise<void>;
-  /**
-   * Set the loading state of an item.
-   * @param {TreeViewItemId} itemId The id of the item to set the loading state of. If `null` is passed, it will set the loading state of the root.
-   * @param {boolean} isLoading True if the item is loading.
-   */
-  setDataSourceLoading: (itemId: TreeViewItemId | null, isLoading: boolean) => void;
-  /**
-   * Set the error state of an item.
-   * @param {TreeViewItemId} itemId The id of the item to set the error state of. If `null` is passed, it will set the error state of the root.
-   * @param {Error | null} error The error caught on the item.
-   */
-  setDataSourceError: (itemId: TreeViewItemId | null, error: Error | null) => void;
-}
-export interface UseTreeViewLazyLoadingParameters<R extends {}> {
-  /**
-   * The data source object.
-   */
-  dataSource?: DataSource<R>;
-  /**
-   * The data source cache object.
-   */
-  dataSourceCache?: DataSourceCache;
-}
-export type UseTreeViewLazyLoadingParametersWithDefaults<R extends {}> = DefaultizedProps<UseTreeViewLazyLoadingParameters<R>, 'dataSource'>;
-export interface UseTreeViewLazyLoadingState {
-  lazyLoading: {
-    enabled: boolean;
-    dataSource: {
-      loading: Record<TreeViewItemId, boolean>;
-      errors: Record<TreeViewItemId, Error | null>;
-    };
-  };
-}
-export type UseTreeViewLazyLoadingSignature = TreeViewPluginSignature<{
-  params: UseTreeViewLazyLoadingParameters<any>;
-  paramsWithDefaults: UseTreeViewLazyLoadingParametersWithDefaults<any>;
-  publicAPI: UseTreeViewLazyLoadingPublicAPI;
-  instance: UseTreeViewLazyLoadingInstance;
-  state: UseTreeViewLazyLoadingState;
-  dependencies: [UseTreeViewItemsSignature, UseTreeViewExpansionSignature, UseTreeViewSelectionSignature];
-}>;