@mui/x-tree-view/internals/plugins/useTreeViewLazyLoading/useTreeViewLazyLoading.types.d.ts

The community edition of the MUI X Tree View components.

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];
}>;