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

The community edition of the MUI X Tree View components.

import { TreeViewDOMStructure, TreeViewItemId, TreeViewValidItem } from "../../models/index.js";
import { MinimalTreeViewParameters, MinimalTreeViewState } from "../MinimalTreeViewStore/index.js";
import { RichTreeViewLazyLoadedItemsStatus } from "../plugins/lazyLoading/index.js";
export interface RichTreeViewState<R extends TreeViewValidItem<R>, Multiple extends boolean | undefined> extends MinimalTreeViewState<R, Multiple> {
  /**
   * Determine if a given item can be edited.
   */
  isItemEditable: ((item: any) => boolean) | boolean;
  /**
   * The id of the item currently being edited.
   */
  editedItemId: string | null;
  /**
   * The status of the items loaded using lazy loading.
   * Is null if lazy loading is not enabled.
   */
  lazyLoadedItems: RichTreeViewLazyLoadedItemsStatus | null;
  /**
   * When equal to 'flat', the tree is rendered as a flat list (children are rendered as siblings of their parents).
   * When equal to 'nested', the tree is rendered with nested children (children are rendered inside the groupTransition slot of their children).
   * Nested DOM structure is not compatible with collapse / expansion animations.
   */
  domStructure: TreeViewDOMStructure;
}
export interface RichTreeViewStoreParameters<R extends TreeViewValidItem<R>, Multiple extends boolean | undefined> extends MinimalTreeViewParameters<R, Multiple> {
  /**
   * 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);
  /**
   * When equal to 'flat', the tree is rendered as a flat list (children are rendered as siblings of their parents).
   * When equal to 'nested', the tree is rendered with nested children (children are rendered inside the groupTransition slot of their children).
   * Nested DOM structure is not compatible with collapse / expansion animations.
   * @default 'nested'
   */
  domStructure?: TreeViewDOMStructure;
}