@mui/x-tree-view/SimpleTreeView/SimpleTreeView.types.d.ts

The community edition of the MUI X Tree View components.

import type * as React from 'react';
import type { Theme } from '@mui/material/styles';
import type { SlotComponentProps } from '@mui/utils/types';
import type { SxProps } from '@mui/system/styleFunctionSx';
import type { SimpleTreeViewClasses } from "./simpleTreeViewClasses.js";
import type { TreeViewSlotProps, TreeViewSlots } from "../internals/TreeViewProvider/TreeViewStyleContext.js";
import type { SimpleTreeViewStore } from "../internals/SimpleTreeViewStore/index.js";
import type { UseTreeViewStoreParameters } from "../internals/hooks/useTreeViewStore.js";
import type { TreeViewPublicAPI } from "../internals/models/index.js";
export interface SimpleTreeViewSlots extends TreeViewSlots {
  /**
   * Element rendered at the root.
   * @default SimpleTreeViewRoot
   */
  root?: React.ElementType;
}
export interface SimpleTreeViewSlotProps extends TreeViewSlotProps {
  root?: SlotComponentProps<'ul', {}, {}>;
}
export type SimpleTreeViewApiRef<Multiple extends boolean | undefined = any> = React.RefObject<Partial<TreeViewPublicAPI<SimpleTreeViewStore<Multiple>>> | undefined>;
export interface SimpleTreeViewProps<Multiple extends boolean | undefined> extends UseTreeViewStoreParameters<SimpleTreeViewStore<Multiple>>, React.HTMLAttributes<HTMLUListElement> {
  /**
   * The content of the component.
   */
  children?: React.ReactNode;
  /**
   * Overridable component slots.
   */
  slots?: SimpleTreeViewSlots;
  /**
   * The props used for each component slot.
   */
  slotProps?: SimpleTreeViewSlotProps;
  className?: string;
  /**
   * Override or extend the styles applied to the component.
   */
  classes?: Partial<SimpleTreeViewClasses>;
  /**
   * The system prop that allows defining system overrides as well as additional CSS styles.
   */
  sx?: SxProps<Theme>;
  /**
   * The ref object that allows Tree View manipulation. Can be instantiated with `useSimpleTreeViewApiRef()`.
   */
  apiRef?: SimpleTreeViewApiRef;
}