@mui/x-tree-view 7.12.1 → 7.13.0

package/useTreeItem2/useTreeItem2.types.d.ts

@@ -5,6 +5,7 @@ import { UseTreeViewSelectionSignature } from '../internals/plugins/useTreeViewS
 import { UseTreeViewItemsSignature } from '../internals/plugins/useTreeViewItems';
 import { UseTreeViewFocusSignature } from '../internals/plugins/useTreeViewFocus';
 import { UseTreeViewKeyboardNavigationSignature } from '../internals/plugins/useTreeViewKeyboardNavigation';
+import { UseTreeViewLabelSignature } from '../internals/plugins/useTreeViewLabel';
 import { UseTreeViewExpansionSignature } from '../internals/plugins/useTreeViewExpansion';
 export interface UseTreeItem2Parameters {
     /**
@@ -69,8 +70,18 @@ export interface UseTreeItem2IconContainerSlotOwnProps {
 export type UseTreeItemIconContainerSlotProps<ExternalProps = {}> = ExternalProps & UseTreeItem2IconContainerSlotOwnProps;
 export interface UseTreeItem2LabelSlotOwnProps {
     children: React.ReactNode;
+    onDoubleClick: MuiCancellableEventHandler<React.MouseEvent>;
+    /**
+     * Only defined when the `isItemEditable` experimental feature is enabled.
+     */
+    editable?: boolean;
 }
 export type UseTreeItem2LabelSlotProps<ExternalProps = {}> = ExternalProps & UseTreeItem2LabelSlotOwnProps;
+export type UseTreeItem2LabelInputSlotOwnProps = {
+    onBlur: MuiCancellableEventHandler<React.FocusEvent<HTMLInputElement>>;
+    onKeyDown: MuiCancellableEventHandler<React.KeyboardEvent<HTMLInputElement>>;
+};
+export type UseTreeItem2LabelInputSlotProps<ExternalProps = {}> = ExternalProps & UseTreeItem2LabelInputSlotOwnProps;
 export interface UseTreeItem2CheckboxSlotOwnProps {
     visible: boolean;
     checked: boolean;
@@ -101,49 +112,57 @@ export interface UseTreeItem2Status {
     focused: boolean;
     selected: boolean;
     disabled: boolean;
+    editing: boolean;
+    editable: boolean;
 }
 export interface UseTreeItem2ReturnValue<TSignatures extends UseTreeItem2MinimalPlugins, TOptionalSignatures extends UseTreeItem2OptionalPlugins> {
     /**
      * Resolver for the root slot's props.
-     * @param {ExternalProps} externalProps Additional props for the root slot
-     * @returns {UseTreeItem2RootSlotProps<ExternalProps>} Props that should be spread on the root slot
+     * @param {ExternalProps} externalProps Additional props for the root slot.
+     * @returns {UseTreeItem2RootSlotProps<ExternalProps>} Props that should be spread on the root slot.
      */
     getRootProps: <ExternalProps extends Record<string, any> = {}>(externalProps?: ExternalProps) => UseTreeItem2RootSlotProps<ExternalProps>;
     /**
      * Resolver for the content slot's props.
-     * @param {ExternalProps} externalProps Additional props for the content slot
-     * @returns {UseTreeItem2ContentSlotProps<ExternalProps>} Props that should be spread on the content slot
+     * @param {ExternalProps} externalProps Additional props for the content slot.
+     * @returns {UseTreeItem2ContentSlotProps<ExternalProps>} Props that should be spread on the content slot.
      */
     getContentProps: <ExternalProps extends Record<string, any> = {}>(externalProps?: ExternalProps) => UseTreeItem2ContentSlotProps<ExternalProps>;
     /**
      * Resolver for the label slot's props.
-     * @param {ExternalProps} externalProps Additional props for the label slot
-     * @returns {UseTreeItem2LabelSlotProps<ExternalProps>} Props that should be spread on the label slot
+     * @param {ExternalProps} externalProps Additional props for the label slot.
+     * @returns {UseTreeItem2LabelSlotProps<ExternalProps>} Props that should be spread on the label slot.
      */
     getLabelProps: <ExternalProps extends Record<string, any> = {}>(externalProps?: ExternalProps) => UseTreeItem2LabelSlotProps<ExternalProps>;
+    /**
+     * Resolver for the labelInput slot's props.
+     * @param {ExternalProps} externalProps Additional props for the labelInput slot.
+     * @returns {UseTreeItem2LabelInputSlotProps<ExternalProps>} Props that should be spread on the labelInput slot.
+     */
+    getLabelInputProps: <ExternalProps extends Record<string, any> = {}>(externalProps?: ExternalProps) => UseTreeItem2LabelInputSlotProps<ExternalProps>;
     /**
      * Resolver for the checkbox slot's props.
-     * @param {ExternalProps} externalProps Additional props for the checkbox slot
-     * @returns {UseTreeItem2CheckboxSlotProps<ExternalProps>} Props that should be spread on the checkbox slot
+     * @param {ExternalProps} externalProps Additional props for the checkbox slot.
+     * @returns {UseTreeItem2CheckboxSlotProps<ExternalProps>} Props that should be spread on the checkbox slot.
      */
     getCheckboxProps: <ExternalProps extends Record<string, any> = {}>(externalProps?: ExternalProps) => UseTreeItem2CheckboxSlotProps<ExternalProps>;
     /**
      * Resolver for the iconContainer slot's props.
-     * @param {ExternalProps} externalProps Additional props for the iconContainer slot
-     * @returns {UseTreeItemIconContainerSlotProps<ExternalProps>} Props that should be spread on the iconContainer slot
+     * @param {ExternalProps} externalProps Additional props for the iconContainer slot.
+     * @returns {UseTreeItemIconContainerSlotProps<ExternalProps>} Props that should be spread on the iconContainer slot.
      */
     getIconContainerProps: <ExternalProps extends Record<string, any> = {}>(externalProps?: ExternalProps) => UseTreeItemIconContainerSlotProps<ExternalProps>;
     /**
      * Resolver for the GroupTransition slot's props.
-     * @param {ExternalProps} externalProps Additional props for the GroupTransition slot
-     * @returns {UseTreeItem2GroupTransitionSlotProps<ExternalProps>} Props that should be spread on the GroupTransition slot
+     * @param {ExternalProps} externalProps Additional props for the GroupTransition slot.
+     * @returns {UseTreeItem2GroupTransitionSlotProps<ExternalProps>} Props that should be spread on the GroupTransition slot.
      */
     getGroupTransitionProps: <ExternalProps extends Record<string, any> = {}>(externalProps?: ExternalProps) => UseTreeItem2GroupTransitionSlotProps<ExternalProps>;
     /**
      * Resolver for the DragAndDropOverlay slot's props.
      * Warning: This slot is only useful when using the `RichTreeViewPro` component.
-     * @param {ExternalProps} externalProps Additional props for the DragAndDropOverlay slot
-     * @returns {UseTreeItem2DragAndDropOverlaySlotProps<ExternalProps>} Props that should be spread on the DragAndDropOverlay slot
+     * @param {ExternalProps} externalProps Additional props for the DragAndDropOverlay slot.
+     * @returns {UseTreeItem2DragAndDropOverlaySlotProps<ExternalProps>} Props that should be spread on the DragAndDropOverlay slot.
      */
     getDragAndDropOverlayProps: <ExternalProps extends Record<string, any> = {}>(externalProps?: ExternalProps) => UseTreeItem2DragAndDropOverlaySlotProps<ExternalProps>;
     /**
@@ -167,7 +186,8 @@ export type UseTreeItem2MinimalPlugins = readonly [
     UseTreeViewExpansionSignature,
     UseTreeViewItemsSignature,
     UseTreeViewFocusSignature,
-    UseTreeViewKeyboardNavigationSignature
+    UseTreeViewKeyboardNavigationSignature,
+    UseTreeViewLabelSignature
 ];
 /**
  * Plugins that `useTreeItem2` can use if they are present, but are not required.