@mui/x-tree-view 8.0.0-alpha.11 → 8.0.0-alpha.13

package/{node → esm}/internals/plugins/useTreeViewFocus/useTreeViewFocus.selectors.js

@@ -1,10 +1,4 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.selectorIsItemTheDefaultFocusableItem = exports.selectorIsItemFocused = exports.selectorFocusedItemId = exports.selectorDefaultFocusableItemId = void 0;
-var _selectors = require("../../utils/selectors");
+import { createSelector } from "../../utils/selectors.js";
 const selectorTreeViewFocusState = state => state.focus;
 
 /**
@@ -14,7 +8,7 @@ const selectorTreeViewFocusState = state => state.focus;
  * @param {TreeViewState<[UseTreeViewFocusSignature]>} state The state of the tree view.
  * @returns {TreeViewItemId | null} The id of the item that should be sequentially focusable.
  */
-const selectorDefaultFocusableItemId = exports.selectorDefaultFocusableItemId = (0, _selectors.createSelector)(selectorTreeViewFocusState, focus => focus.defaultFocusableItemId);
+export const selectorDefaultFocusableItemId = createSelector(selectorTreeViewFocusState, focus => focus.defaultFocusableItemId);
 
 /**
  * Check if an item is the default focusable item.
@@ -22,14 +16,14 @@ const selectorDefaultFocusableItemId = exports.selectorDefaultFocusableItemId =
  * @param {TreeViewItemId} itemId The id of the item to check.
  * @returns {boolean} `true` if the item is the default focusable item, `false` otherwise.
  */
-const selectorIsItemTheDefaultFocusableItem = exports.selectorIsItemTheDefaultFocusableItem = (0, _selectors.createSelector)([selectorDefaultFocusableItemId, (_, itemId) => itemId], (defaultFocusableItemId, itemId) => defaultFocusableItemId === itemId);
+export const selectorIsItemTheDefaultFocusableItem = createSelector([selectorDefaultFocusableItemId, (_, itemId) => itemId], (defaultFocusableItemId, itemId) => defaultFocusableItemId === itemId);
 
 /**
  * Get the id of the item that is currently focused.
  * @param {TreeViewState<[UseTreeViewFocusSignature]>} state The state of the tree view.
  * @returns {TreeViewItemId | null} The id of the item that is currently focused.
  */
-const selectorFocusedItemId = exports.selectorFocusedItemId = (0, _selectors.createSelector)(selectorTreeViewFocusState, focus => focus.focusedItemId);
+export const selectorFocusedItemId = createSelector(selectorTreeViewFocusState, focus => focus.focusedItemId);
 
 /**
  * Check if an item is focused.
@@ -37,4 +31,4 @@ const selectorFocusedItemId = exports.selectorFocusedItemId = (0, _selectors.cre
  * @param {TreeViewItemId} itemId The id of the item to check.
  * @returns {boolean} `true` if the item is focused, `false` otherwise.
  */
-const selectorIsItemFocused = exports.selectorIsItemFocused = (0, _selectors.createSelector)([selectorFocusedItemId, (_, itemId) => itemId], (focusedItemId, itemId) => focusedItemId === itemId);
+export const selectorIsItemFocused = createSelector([selectorFocusedItemId, (_, itemId) => itemId], (focusedItemId, itemId) => focusedItemId === itemId);

package/esm/internals/plugins/useTreeViewFocus/useTreeViewFocus.types.d.ts

@@ -0,0 +1,45 @@
+import * as React from 'react';
+import { TreeViewPluginSignature } from "../../models/index.js";
+import type { UseTreeViewItemsSignature } from '../useTreeViewItems';
+import type { UseTreeViewSelectionSignature } from '../useTreeViewSelection';
+import { UseTreeViewExpansionSignature } from "../useTreeViewExpansion/index.js";
+export interface UseTreeViewFocusPublicAPI {
+  /**
+   * Focus the item with the given id.
+   *
+   * If the item is the child of a collapsed item, then this method will do nothing.
+   * Make sure to expand the ancestors of the item before calling this method if needed.
+   * @param {React.SyntheticEvent} event The DOM event that triggered the change.
+   * @param {TreeViewItemId} itemId The id of the item to focus.
+   */
+  focusItem: (event: React.SyntheticEvent, itemId: string) => void;
+}
+export interface UseTreeViewFocusInstance extends UseTreeViewFocusPublicAPI {
+  /**
+   * Remove the focus from the currently focused item (both from the internal state and the DOM).
+   */
+  removeFocusedItem: () => void;
+}
+export interface UseTreeViewFocusParameters {
+  /**
+   * Callback fired when a given Tree Item is focused.
+   * @param {React.SyntheticEvent | null} event The DOM event that triggered the change. **Warning**: This is a generic event not a focus event.
+   * @param {string} itemId The id of the focused item.
+   */
+  onItemFocus?: (event: React.SyntheticEvent | null, itemId: string) => void;
+}
+export type UseTreeViewFocusDefaultizedParameters = UseTreeViewFocusParameters;
+export interface UseTreeViewFocusState {
+  focus: {
+    focusedItemId: string | null;
+    defaultFocusableItemId: string | null;
+  };
+}
+export type UseTreeViewFocusSignature = TreeViewPluginSignature<{
+  params: UseTreeViewFocusParameters;
+  defaultizedParams: UseTreeViewFocusDefaultizedParameters;
+  instance: UseTreeViewFocusInstance;
+  publicAPI: UseTreeViewFocusPublicAPI;
+  state: UseTreeViewFocusState;
+  dependencies: [UseTreeViewItemsSignature, UseTreeViewSelectionSignature, UseTreeViewExpansionSignature];
+}>;

package/esm/internals/plugins/useTreeViewFocus/useTreeViewFocus.types.js

@@ -0,0 +1 @@
+export {};

package/esm/internals/plugins/useTreeViewIcons/index.d.ts

@@ -0,0 +1,2 @@
+export { useTreeViewIcons } from "./useTreeViewIcons.js";
+export type { UseTreeViewIconsSignature, UseTreeViewIconsParameters, UseTreeViewIconsDefaultizedParameters } from './useTreeViewIcons.types';

package/esm/internals/plugins/useTreeViewIcons/index.js

@@ -0,0 +1 @@
+export { useTreeViewIcons } from "./useTreeViewIcons.js";

package/esm/internals/plugins/useTreeViewIcons/useTreeViewIcons.d.ts

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

package/{node → esm}/internals/plugins/useTreeViewIcons/useTreeViewIcons.js

@@ -1,12 +1,5 @@
-"use strict";
-
-var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useTreeViewIcons = void 0;
-var React = _interopRequireWildcard(require("react"));
-const useTreeViewIcons = ({
+import * as React from 'react';
+export const useTreeViewIcons = ({
   slots,
   slotProps
 }) => {
@@ -28,5 +21,4 @@ const useTreeViewIcons = ({
     contextValue: pluginContextValue
   };
 };
-exports.useTreeViewIcons = useTreeViewIcons;
 useTreeViewIcons.params = {};

package/esm/internals/plugins/useTreeViewIcons/useTreeViewIcons.types.d.ts

@@ -0,0 +1,42 @@
+import * as React from 'react';
+import { SlotComponentProps } from '@mui/utils/types';
+import { TreeViewPluginSignature } from "../../models/index.js";
+import { UseTreeViewItemsSignature } from "../useTreeViewItems/index.js";
+import { UseTreeViewSelectionSignature } from "../useTreeViewSelection/index.js";
+export interface UseTreeViewIconsParameters {}
+export type UseTreeViewIconsDefaultizedParameters = UseTreeViewIconsParameters;
+interface UseTreeViewIconsSlots {
+  /**
+   * The default icon used to collapse the item.
+   */
+  collapseIcon?: React.ElementType;
+  /**
+   * The default icon used to expand the item.
+   */
+  expandIcon?: React.ElementType;
+  /**
+   * The default icon displayed next to an end item.
+   * This is applied to all Tree Items and can be overridden by the TreeItem `icon` slot prop.
+   */
+  endIcon?: React.ElementType;
+}
+interface UseTreeViewIconsSlotProps {
+  collapseIcon?: SlotComponentProps<'svg', {}, {}>;
+  expandIcon?: SlotComponentProps<'svg', {}, {}>;
+  endIcon?: SlotComponentProps<'svg', {}, {}>;
+}
+interface UseTreeViewIconsContextValue {
+  icons: {
+    slots: UseTreeViewIconsSlots;
+    slotProps: UseTreeViewIconsSlotProps;
+  };
+}
+export type UseTreeViewIconsSignature = TreeViewPluginSignature<{
+  params: UseTreeViewIconsParameters;
+  defaultizedParams: UseTreeViewIconsDefaultizedParameters;
+  contextValue: UseTreeViewIconsContextValue;
+  slots: UseTreeViewIconsSlots;
+  slotProps: UseTreeViewIconsSlotProps;
+  dependencies: [UseTreeViewItemsSignature, UseTreeViewSelectionSignature];
+}>;
+export {};

package/esm/internals/plugins/useTreeViewIcons/useTreeViewIcons.types.js

@@ -0,0 +1 @@
+export {};

package/esm/internals/plugins/useTreeViewItems/index.d.ts

@@ -0,0 +1,3 @@
+export { useTreeViewItems } from "./useTreeViewItems.js";
+export type { UseTreeViewItemsSignature, UseTreeViewItemsParameters, UseTreeViewItemsDefaultizedParameters, UseTreeViewItemsState } from './useTreeViewItems.types';
+export { buildSiblingIndexes, TREE_VIEW_ROOT_PARENT_ID } from "./useTreeViewItems.utils.js";

package/esm/internals/plugins/useTreeViewItems/index.js

@@ -0,0 +1,2 @@
+export { useTreeViewItems } from "./useTreeViewItems.js";
+export { buildSiblingIndexes, TREE_VIEW_ROOT_PARENT_ID } from "./useTreeViewItems.utils.js";

package/esm/internals/plugins/useTreeViewItems/useTreeViewItems.d.ts

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

package/{node → esm}/internals/plugins/useTreeViewItems/useTreeViewItems.js

@@ -1,21 +1,13 @@
-"use strict";
-
-var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useTreeViewItems = void 0;
-var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
-var React = _interopRequireWildcard(require("react"));
-var _useEventCallback = _interopRequireDefault(require("@mui/utils/useEventCallback"));
-var _publishTreeViewEvent = require("../../utils/publishTreeViewEvent");
-var _useTreeViewItems = require("./useTreeViewItems.utils");
-var _TreeViewItemDepthContext = require("../../TreeViewItemDepthContext");
-var _useTreeViewItems2 = require("./useTreeViewItems.selectors");
-var _useTreeViewId = require("../../corePlugins/useTreeViewId/useTreeViewId.selectors");
-var _useTreeViewId2 = require("../../corePlugins/useTreeViewId/useTreeViewId.utils");
-var _jsxRuntime = require("react/jsx-runtime");
+import _extends from "@babel/runtime/helpers/esm/extends";
+import * as React from 'react';
+import useEventCallback from '@mui/utils/useEventCallback';
+import { publishTreeViewEvent } from "../../utils/publishTreeViewEvent.js";
+import { buildSiblingIndexes, TREE_VIEW_ROOT_PARENT_ID } from "./useTreeViewItems.utils.js";
+import { TreeViewItemDepthContext } from "../../TreeViewItemDepthContext/index.js";
+import { selectorItemMeta, selectorItemOrderedChildrenIds, selectorItemModel, selectorItemDepth } from "./useTreeViewItems.selectors.js";
+import { selectorTreeViewId } from "../../corePlugins/useTreeViewId/useTreeViewId.selectors.js";
+import { generateTreeItemIdAttribute } from "../../corePlugins/useTreeViewId/useTreeViewId.utils.js";
+import { jsx as _jsx } from "react/jsx-runtime";
 const updateItemsState = ({
   disabledItemsFocusable,
   items,
@@ -26,7 +18,7 @@ const updateItemsState = ({
   const itemMetaLookup = {};
   const itemModelLookup = {};
   const itemOrderedChildrenIdsLookup = {
-    [_useTreeViewItems.TREE_VIEW_ROOT_PARENT_ID]: []
+    [TREE_VIEW_ROOT_PARENT_ID]: []
   };
   const processItem = (item, depth, parentId) => {
     const id = getItemId ? getItemId(item) : item.id;
@@ -50,7 +42,7 @@ const updateItemsState = ({
       depth
     };
     itemModelLookup[id] = item;
-    const parentIdWithDefault = parentId ?? _useTreeViewItems.TREE_VIEW_ROOT_PARENT_ID;
+    const parentIdWithDefault = parentId ?? TREE_VIEW_ROOT_PARENT_ID;
     if (!itemOrderedChildrenIdsLookup[parentIdWithDefault]) {
       itemOrderedChildrenIdsLookup[parentIdWithDefault] = [];
     }
@@ -60,7 +52,7 @@ const updateItemsState = ({
   items.forEach(item => processItem(item, 0, null));
   const itemChildrenIndexesLookup = {};
   Object.keys(itemOrderedChildrenIdsLookup).forEach(parentId => {
-    itemChildrenIndexesLookup[parentId] = (0, _useTreeViewItems.buildSiblingIndexes)(itemOrderedChildrenIdsLookup[parentId]);
+    itemChildrenIndexesLookup[parentId] = buildSiblingIndexes(itemOrderedChildrenIdsLookup[parentId]);
   });
   return {
     disabledItemsFocusable,
@@ -70,16 +62,16 @@ const updateItemsState = ({
     itemChildrenIndexesLookup
   };
 };
-const useTreeViewItems = ({
+export const useTreeViewItems = ({
   instance,
   params,
   store
 }) => {
-  const getItem = React.useCallback(itemId => (0, _useTreeViewItems2.selectorItemModel)(store.value, itemId), [store]);
+  const getItem = React.useCallback(itemId => selectorItemModel(store.value, itemId), [store]);
   const getItemTree = React.useCallback(() => {
     const getItemFromItemId = itemId => {
-      const item = (0, _useTreeViewItems2.selectorItemModel)(store.value, itemId);
-      const newChildren = (0, _useTreeViewItems2.selectorItemOrderedChildrenIds)(store.value, itemId);
+      const item = selectorItemModel(store.value, itemId);
+      const newChildren = selectorItemOrderedChildrenIds(store.value, itemId);
       if (newChildren.length > 0) {
         item.children = newChildren.map(getItemFromItemId);
       } else {
@@ -87,16 +79,16 @@ const useTreeViewItems = ({
       }
       return item;
     };
-    return (0, _useTreeViewItems2.selectorItemOrderedChildrenIds)(store.value, null).map(getItemFromItemId);
+    return selectorItemOrderedChildrenIds(store.value, null).map(getItemFromItemId);
   }, [store]);
-  const getItemOrderedChildrenIds = React.useCallback(itemId => (0, _useTreeViewItems2.selectorItemOrderedChildrenIds)(store.value, itemId), [store]);
+  const getItemOrderedChildrenIds = React.useCallback(itemId => selectorItemOrderedChildrenIds(store.value, itemId), [store]);
   const getItemDOMElement = itemId => {
-    const itemMeta = (0, _useTreeViewItems2.selectorItemMeta)(store.value, itemId);
+    const itemMeta = selectorItemMeta(store.value, itemId);
     if (itemMeta == null) {
       return null;
     }
-    const idAttribute = (0, _useTreeViewId2.generateTreeItemIdAttribute)({
-      treeId: (0, _useTreeViewId.selectorTreeViewId)(store.value),
+    const idAttribute = generateTreeItemIdAttribute({
+      treeId: selectorTreeViewId(store.value),
       itemId,
       id: itemMeta.idAttribute
     });
@@ -121,19 +113,19 @@ const useTreeViewItems = ({
       });
       Object.values(prevState.items.itemMetaLookup).forEach(item => {
         if (!newState.itemMetaLookup[item.id]) {
-          (0, _publishTreeViewEvent.publishTreeViewEvent)(instance, 'removeItem', {
+          publishTreeViewEvent(instance, 'removeItem', {
             id: item.id
           });
         }
       });
-      return (0, _extends2.default)({}, prevState, {
+      return _extends({}, prevState, {
         items: newState
       });
     });
   }, [instance, store, params.items, params.disabledItemsFocusable, params.isItemDisabled, params.getItemId, params.getItemLabel]);
 
   // Wrap `props.onItemClick` with `useEventCallback` to prevent unneeded context updates.
-  const handleItemClick = (0, _useEventCallback.default)((event, itemId) => {
+  const handleItemClick = useEventCallback((event, itemId) => {
     if (params.onItemClick) {
       params.onItemClick(event, itemId);
     }
@@ -163,7 +155,6 @@ const useTreeViewItems = ({
     contextValue: pluginContextValue
   };
 };
-exports.useTreeViewItems = useTreeViewItems;
 useTreeViewItems.getInitialState = params => ({
   items: updateItemsState({
     disabledItemsFocusable: params.disabledItemsFocusable,
@@ -175,15 +166,15 @@ useTreeViewItems.getInitialState = params => ({
 });
 useTreeViewItems.getDefaultizedParams = ({
   params
-}) => (0, _extends2.default)({}, params, {
+}) => _extends({}, params, {
   disabledItemsFocusable: params.disabledItemsFocusable ?? false,
   itemChildrenIndentation: params.itemChildrenIndentation ?? '12px'
 });
 useTreeViewItems.wrapRoot = ({
   children
 }) => {
-  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_TreeViewItemDepthContext.TreeViewItemDepthContext.Provider, {
-    value: _useTreeViewItems2.selectorItemDepth,
+  return /*#__PURE__*/_jsx(TreeViewItemDepthContext.Provider, {
+    value: selectorItemDepth,
     children: children
   });
 };