@mui/x-tree-view 7.18.0 → 7.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/CHANGELOG.md +110 -0
  2. package/RichTreeView/RichTreeView.plugins.d.ts +1 -1
  3. package/SimpleTreeView/SimpleTreeView.plugins.d.ts +1 -1
  4. package/TreeItem/TreeItem.js +7 -1
  5. package/TreeItem/TreeItemContent.js +1 -1
  6. package/TreeItem2/TreeItem2.d.ts +6 -6
  7. package/hooks/useTreeItem2Utils/useTreeItem2Utils.d.ts +24 -6
  8. package/hooks/useTreeItem2Utils/useTreeItem2Utils.js +10 -8
  9. package/index.js +1 -1
  10. package/internals/TreeViewProvider/TreeViewChildrenItemProvider.js +7 -1
  11. package/internals/TreeViewProvider/TreeViewProvider.js +2 -1
  12. package/internals/TreeViewProvider/TreeViewProvider.types.d.ts +2 -1
  13. package/internals/TreeViewProvider/useTreeViewContext.d.ts +1 -1
  14. package/internals/corePlugins/corePlugins.d.ts +1 -1
  15. package/internals/corePlugins/useTreeViewId/useTreeViewId.js +28 -7
  16. package/internals/corePlugins/useTreeViewId/useTreeViewId.types.d.ts +11 -13
  17. package/internals/corePlugins/useTreeViewId/useTreeViewId.utils.d.ts +17 -0
  18. package/internals/corePlugins/useTreeViewId/useTreeViewId.utils.js +26 -0
  19. package/internals/models/plugin.d.ts +4 -1
  20. package/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.js +3 -1
  21. package/internals/plugins/useTreeViewFocus/useTreeViewFocus.js +1 -1
  22. package/internals/plugins/useTreeViewItems/useTreeViewItems.js +9 -2
  23. package/internals/plugins/useTreeViewJSXItems/useTreeViewJSXItems.js +11 -5
  24. package/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.js +6 -0
  25. package/internals/plugins/useTreeViewLabel/useTreeViewLabel.js +16 -8
  26. package/internals/plugins/useTreeViewLabel/useTreeViewLabel.types.d.ts +3 -2
  27. package/internals/plugins/useTreeViewSelection/useTreeViewSelection.js +3 -1
  28. package/internals/useTreeView/extractPluginParamsFromProps.d.ts +1 -1
  29. package/internals/useTreeView/extractPluginParamsFromProps.js +7 -3
  30. package/modern/TreeItem/TreeItem.js +7 -1
  31. package/modern/TreeItem/TreeItemContent.js +1 -1
  32. package/modern/hooks/useTreeItem2Utils/useTreeItem2Utils.js +10 -8
  33. package/modern/index.js +1 -1
  34. package/modern/internals/TreeViewProvider/TreeViewChildrenItemProvider.js +7 -1
  35. package/modern/internals/TreeViewProvider/TreeViewProvider.js +2 -1
  36. package/modern/internals/corePlugins/useTreeViewId/useTreeViewId.js +28 -7
  37. package/modern/internals/corePlugins/useTreeViewId/useTreeViewId.utils.js +26 -0
  38. package/modern/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.js +3 -1
  39. package/modern/internals/plugins/useTreeViewFocus/useTreeViewFocus.js +1 -1
  40. package/modern/internals/plugins/useTreeViewItems/useTreeViewItems.js +9 -2
  41. package/modern/internals/plugins/useTreeViewJSXItems/useTreeViewJSXItems.js +11 -5
  42. package/modern/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.js +6 -0
  43. package/modern/internals/plugins/useTreeViewLabel/useTreeViewLabel.js +16 -8
  44. package/modern/internals/plugins/useTreeViewSelection/useTreeViewSelection.js +3 -1
  45. package/modern/internals/useTreeView/extractPluginParamsFromProps.js +7 -3
  46. package/modern/useTreeItem2/useTreeItem2.js +7 -1
  47. package/node/TreeItem/TreeItem.js +7 -1
  48. package/node/TreeItem/TreeItemContent.js +1 -1
  49. package/node/hooks/useTreeItem2Utils/useTreeItem2Utils.js +10 -9
  50. package/node/index.js +1 -1
  51. package/node/internals/TreeViewProvider/TreeViewChildrenItemProvider.js +7 -1
  52. package/node/internals/TreeViewProvider/TreeViewProvider.js +2 -1
  53. package/node/internals/corePlugins/useTreeViewId/useTreeViewId.js +29 -8
  54. package/node/internals/corePlugins/useTreeViewId/useTreeViewId.utils.js +34 -0
  55. package/node/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.js +3 -1
  56. package/node/internals/plugins/useTreeViewFocus/useTreeViewFocus.js +1 -1
  57. package/node/internals/plugins/useTreeViewItems/useTreeViewItems.js +9 -2
  58. package/node/internals/plugins/useTreeViewJSXItems/useTreeViewJSXItems.js +11 -5
  59. package/node/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.js +6 -0
  60. package/node/internals/plugins/useTreeViewLabel/useTreeViewLabel.js +16 -8
  61. package/node/internals/plugins/useTreeViewSelection/useTreeViewSelection.js +3 -1
  62. package/node/internals/useTreeView/extractPluginParamsFromProps.js +7 -3
  63. package/node/useTreeItem2/useTreeItem2.js +7 -1
  64. package/package.json +1 -1
  65. package/useTreeItem2/index.d.ts +2 -2
  66. package/useTreeItem2/useTreeItem2.js +7 -1
@@ -8,6 +8,7 @@ import { useTreeViewContext } from "../../TreeViewProvider/index.js";
8
8
  import { TreeViewChildrenItemContext, TreeViewChildrenItemProvider } from "../../TreeViewProvider/TreeViewChildrenItemProvider.js";
9
9
  import { buildSiblingIndexes, TREE_VIEW_ROOT_PARENT_ID } from "../useTreeViewItems/useTreeViewItems.utils.js";
10
10
  import { TreeViewItemDepthContext } from "../../TreeViewItemDepthContext/index.js";
11
+ import { generateTreeItemIdAttribute } from "../../corePlugins/useTreeViewId/useTreeViewId.utils.js";
11
12
  import { jsx as _jsx } from "react/jsx-runtime";
12
13
  export const useTreeViewJSXItems = ({
13
14
  instance,
@@ -98,7 +99,8 @@ const useTreeViewJSXItemsItemPlugin = ({
98
99
  contentRef
99
100
  }) => {
100
101
  const {
101
- instance
102
+ instance,
103
+ treeId
102
104
  } = useTreeViewContext();
103
105
  const {
104
106
  children,
@@ -122,12 +124,16 @@ const useTreeViewJSXItemsItemPlugin = ({
122
124
 
123
125
  // Prevent any flashing
124
126
  useEnhancedEffect(() => {
125
- const idAttributeWithDefault = instance.getTreeItemIdAttribute(itemId, id);
126
- registerChild(idAttributeWithDefault, itemId);
127
+ const idAttribute = generateTreeItemIdAttribute({
128
+ itemId,
129
+ treeId,
130
+ id
131
+ });
132
+ registerChild(idAttribute, itemId);
127
133
  return () => {
128
- unregisterChild(idAttributeWithDefault);
134
+ unregisterChild(idAttribute);
129
135
  };
130
- }, [instance, registerChild, unregisterChild, itemId, id]);
136
+ }, [registerChild, unregisterChild, itemId, id, treeId]);
131
137
  React.useEffect(() => {
132
138
  return instance.insertJSXItem({
133
139
  id: itemId,
@@ -153,6 +153,9 @@ export const useTreeViewKeyboardNavigation = ({
153
153
  // If the focused item is collapsed and has children, we expand it
154
154
  case key === 'ArrowRight' && !isRtl || key === 'ArrowLeft' && isRtl:
155
155
  {
156
+ if (ctrlPressed) {
157
+ return;
158
+ }
156
159
  if (instance.isItemExpanded(itemId)) {
157
160
  const nextItemId = getNextNavigableItem(instance, itemId);
158
161
  if (nextItemId) {
@@ -170,6 +173,9 @@ export const useTreeViewKeyboardNavigation = ({
170
173
  // If the focused item is collapsed and has a parent, we move the focus to this parent
171
174
  case key === 'ArrowLeft' && !isRtl || key === 'ArrowRight' && isRtl:
172
175
  {
176
+ if (ctrlPressed) {
177
+ return;
178
+ }
173
179
  if (canToggleItemExpansion(itemId) && instance.isItemExpanded(itemId)) {
174
180
  instance.toggleItemExpansion(event, itemId);
175
181
  event.preventDefault();
@@ -6,14 +6,8 @@ export const useTreeViewLabel = ({
6
6
  instance,
7
7
  state,
8
8
  setState,
9
- params,
10
- experimentalFeatures
9
+ params
11
10
  }) => {
12
- if (process.env.NODE_ENV !== 'production') {
13
- if (params.isItemEditable && !experimentalFeatures?.labelEditing) {
14
- warnOnce(['MUI X: The label editing feature requires the `labelEditing` experimental feature to be enabled.', 'You can do it by passing `experimentalFeatures={{ labelEditing: true}}` to the `RichTreeViewPro` component.', 'Check the documentation for more details: https://mui.com/x/react-tree-view/rich-tree-view/editing/']);
15
- }
16
- }
17
11
  const editedItemRef = React.useRef(state.editedItemId);
18
12
  const isItemBeingEditedRef = itemId => editedItemRef.current === itemId;
19
13
  const setEditedItemId = editedItemId => {
@@ -23,7 +17,7 @@ export const useTreeViewLabel = ({
23
17
  editedItemRef.current = editedItemId;
24
18
  };
25
19
  const isItemBeingEdited = itemId => itemId === state.editedItemId;
26
- const isTreeViewEditable = Boolean(params.isItemEditable) && !!experimentalFeatures.labelEditing;
20
+ const isTreeViewEditable = Boolean(params.isItemEditable);
27
21
  const isItemEditable = itemId => {
28
22
  if (itemId == null || !isTreeViewEditable) {
29
23
  return false;
@@ -72,6 +66,20 @@ export const useTreeViewLabel = ({
72
66
  };
73
67
  };
74
68
  useTreeViewLabel.itemPlugin = useTreeViewLabelItemPlugin;
69
+ useTreeViewLabel.getDefaultizedParams = ({
70
+ params,
71
+ experimentalFeatures
72
+ }) => {
73
+ const canUseFeature = experimentalFeatures?.labelEditing;
74
+ if (process.env.NODE_ENV !== 'production') {
75
+ if (params.isItemEditable && !canUseFeature) {
76
+ warnOnce(['MUI X: The label editing feature requires the `labelEditing` experimental feature to be enabled.', 'You can do it by passing `experimentalFeatures={{ labelEditing: true}}` to the `RichTreeViewPro` component.', 'Check the documentation for more details: https://mui.com/x/react-tree-view/rich-tree-view/editing/']);
77
+ }
78
+ }
79
+ return _extends({}, params, {
80
+ isItemEditable: canUseFeature ? params.isItemEditable ?? false : false
81
+ });
82
+ };
75
83
  useTreeViewLabel.getInitialState = () => ({
76
84
  editedItemId: null
77
85
  });
@@ -1,4 +1,4 @@
1
- import { TreeViewPluginSignature } from '../../models';
1
+ import { DefaultizedProps, TreeViewPluginSignature } from '../../models';
2
2
  import { TreeViewItemId } from '../../../models';
3
3
  import { UseTreeViewItemsSignature } from '../useTreeViewItems';
4
4
  import { TreeItem2LabelInputProps } from '../../../TreeItem2LabelInput';
@@ -59,12 +59,13 @@ export interface UseTreeViewLabelParameters<R extends {}> {
59
59
  */
60
60
  isItemEditable?: boolean | ((item: R) => boolean);
61
61
  }
62
+ export type UseTreeViewLabelDefaultizedParameters<R extends {}> = DefaultizedProps<UseTreeViewLabelParameters<R>, 'isItemEditable'>;
62
63
  export interface UseTreeViewLabelState {
63
64
  editedItemId: string | null;
64
65
  }
65
66
  export type UseTreeViewLabelSignature = TreeViewPluginSignature<{
66
67
  params: UseTreeViewLabelParameters<any>;
67
- defaultizedParams: UseTreeViewLabelParameters<any>;
68
+ defaultizedParams: UseTreeViewLabelDefaultizedParameters<any>;
68
69
  publicAPI: UseTreeViewLabelPublicAPI;
69
70
  instance: UseTreeViewLabelInstance;
70
71
  state: UseTreeViewLabelState;
@@ -174,7 +174,9 @@ useTreeViewSelection.models = {
174
174
  }
175
175
  };
176
176
  const DEFAULT_SELECTED_ITEMS = [];
177
- useTreeViewSelection.getDefaultizedParams = params => _extends({}, params, {
177
+ useTreeViewSelection.getDefaultizedParams = ({
178
+ params
179
+ }) => _extends({}, params, {
178
180
  disableSelection: params.disableSelection ?? false,
179
181
  multiSelect: params.multiSelect ?? false,
180
182
  checkboxSelection: params.checkboxSelection ?? false,
@@ -9,5 +9,5 @@ interface ExtractPluginParamsFromPropsReturnValue<TSignatures extends readonly T
9
9
  pluginParams: MergeSignaturesProperty<TSignatures, 'defaultizedParams'>;
10
10
  forwardedProps: Omit<TProps, keyof MergeSignaturesProperty<TSignatures, 'params'>>;
11
11
  }
12
- export declare const extractPluginParamsFromProps: <TSignatures extends readonly TreeViewPluginSignature<any>[], TProps extends Partial<UseTreeViewBaseProps<TSignatures>>>({ props: { slots, slotProps, apiRef, experimentalFeatures, ...props }, plugins, }: ExtractPluginParamsFromPropsParameters<TSignatures, TProps>) => ExtractPluginParamsFromPropsReturnValue<TSignatures, TProps>;
12
+ export declare const extractPluginParamsFromProps: <TSignatures extends readonly TreeViewPluginSignature<any>[], TProps extends Partial<UseTreeViewBaseProps<TSignatures>>>({ props: { slots, slotProps, apiRef, experimentalFeatures: inExperimentalFeatures, ...props }, plugins, }: ExtractPluginParamsFromPropsParameters<TSignatures, TProps>) => ExtractPluginParamsFromPropsReturnValue<TSignatures, TProps>;
13
13
  export {};
@@ -6,7 +6,7 @@ export const extractPluginParamsFromProps = _ref => {
6
6
  slots,
7
7
  slotProps,
8
8
  apiRef,
9
- experimentalFeatures
9
+ experimentalFeatures: inExperimentalFeatures
10
10
  },
11
11
  plugins
12
12
  } = _ref,
@@ -25,9 +25,13 @@ export const extractPluginParamsFromProps = _ref => {
25
25
  forwardedProps[propName] = prop;
26
26
  }
27
27
  });
28
+ const experimentalFeatures = inExperimentalFeatures ?? {};
28
29
  const defaultizedPluginParams = plugins.reduce((acc, plugin) => {
29
30
  if (plugin.getDefaultizedParams) {
30
- return plugin.getDefaultizedParams(acc);
31
+ return plugin.getDefaultizedParams({
32
+ params: acc,
33
+ experimentalFeatures
34
+ });
31
35
  }
32
36
  return acc;
33
37
  }, pluginParams);
@@ -37,6 +41,6 @@ export const extractPluginParamsFromProps = _ref => {
37
41
  pluginParams: defaultizedPluginParams,
38
42
  slots: slots ?? {},
39
43
  slotProps: slotProps ?? {},
40
- experimentalFeatures: experimentalFeatures ?? {}
44
+ experimentalFeatures
41
45
  };
42
46
  };
@@ -28,6 +28,7 @@ import { TreeItem2Provider } from "../TreeItem2Provider/index.js";
28
28
  import { TreeViewItemDepthContext } from "../internals/TreeViewItemDepthContext/index.js";
29
29
  import { useTreeItemState } from "./useTreeItemState.js";
30
30
  import { isTargetInDescendants } from "../internals/utils/tree.js";
31
+ import { generateTreeItemIdAttribute } from "../internals/corePlugins/useTreeViewId/useTreeViewId.utils.js";
31
32
  import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
32
33
  const useThemeProps = createUseThemeProps('MuiTreeItem');
33
34
  const useUtilityClasses = ownerState => {
@@ -185,6 +186,7 @@ export const TreeItem = /*#__PURE__*/React.forwardRef(function TreeItem(inProps,
185
186
  expansion: {
186
187
  expansionTrigger
187
188
  },
189
+ treeId,
188
190
  instance
189
191
  } = useTreeViewContext();
190
192
  const depthContext = React.useContext(TreeViewItemDepthContext);
@@ -341,7 +343,11 @@ export const TreeItem = /*#__PURE__*/React.forwardRef(function TreeItem(inProps,
341
343
  }
342
344
  instance.handleItemKeyDown(event, itemId);
343
345
  };
344
- const idAttribute = instance.getTreeItemIdAttribute(itemId, id);
346
+ const idAttribute = generateTreeItemIdAttribute({
347
+ itemId,
348
+ treeId,
349
+ id
350
+ });
345
351
  const tabIndex = instance.canItemBeTabbed(itemId) ? 0 : -1;
346
352
  const sharedPropsEnhancerParams = {
347
353
  rootRefObject,
@@ -77,7 +77,7 @@ const TreeItemContent = /*#__PURE__*/React.forwardRef(function TreeItemContent(p
77
77
  /*#__PURE__*/
78
78
  /* eslint-disable-next-line jsx-a11y/click-events-have-key-events,jsx-a11y/no-static-element-interactions -- Key event is handled by the TreeView */
79
79
  _jsxs("div", _extends({}, other, {
80
- className: clsx(className, classes.root, expanded && classes.expanded, selected && classes.selected, focused && classes.focused, disabled && classes.disabled, editing && classes.editing, editable && classes.editable),
80
+ className: clsx(classes.root, className, expanded && classes.expanded, selected && classes.selected, focused && classes.focused, disabled && classes.disabled, editing && classes.editing, editable && classes.editable),
81
81
  onClick: handleClick,
82
82
  onMouseDown: handleMouseDown,
83
83
  ref: ref,
@@ -1,12 +1,6 @@
1
1
  import { useTreeViewContext } from "../../internals/TreeViewProvider/index.js";
2
2
  import { useTreeViewLabel } from "../../internals/plugins/useTreeViewLabel/index.js";
3
3
  import { hasPlugin } from "../../internals/utils/plugins.js";
4
- const isItemExpandable = reactChildren => {
5
- if (Array.isArray(reactChildren)) {
6
- return reactChildren.length > 0 && reactChildren.some(isItemExpandable);
7
- }
8
- return Boolean(reactChildren);
9
- };
10
4
 
11
5
  /**
12
6
  * Plugins that need to be present in the Tree View in order for `useTreeItem2Utils` to work correctly.
@@ -16,6 +10,12 @@ const isItemExpandable = reactChildren => {
16
10
  * Plugins that `useTreeItem2Utils` can use if they are present, but are not required.
17
11
  */
18
12
 
13
+ const isItemExpandable = reactChildren => {
14
+ if (Array.isArray(reactChildren)) {
15
+ return reactChildren.length > 0 && reactChildren.some(isItemExpandable);
16
+ }
17
+ return Boolean(reactChildren);
18
+ };
19
19
  export const useTreeItem2Utils = ({
20
20
  itemId,
21
21
  children
@@ -24,7 +24,8 @@ export const useTreeItem2Utils = ({
24
24
  instance,
25
25
  selection: {
26
26
  multiSelect
27
- }
27
+ },
28
+ publicAPI
28
29
  } = useTreeViewContext();
29
30
  const status = {
30
31
  expandable: isItemExpandable(children),
@@ -134,6 +135,7 @@ export const useTreeItem2Utils = ({
134
135
  };
135
136
  return {
136
137
  interactions,
137
- status
138
+ status,
139
+ publicAPI
138
140
  };
139
141
  };
package/modern/index.js CHANGED
@@ -1,5 +1,5 @@
1
1
  /**
2
- * @mui/x-tree-view v7.18.0
2
+ * @mui/x-tree-view v7.19.0
3
3
  *
4
4
  * @license MIT
5
5
  * This source code is licensed under the MIT license found in the
@@ -2,6 +2,7 @@ import * as React from 'react';
2
2
  import PropTypes from 'prop-types';
3
3
  import { useTreeViewContext } from "./useTreeViewContext.js";
4
4
  import { escapeOperandAttributeSelector } from "../utils/utils.js";
5
+ import { generateTreeItemIdAttribute } from "../corePlugins/useTreeViewId/useTreeViewId.utils.js";
5
6
  import { jsx as _jsx } from "react/jsx-runtime";
6
7
  export const TreeViewChildrenItemContext = /*#__PURE__*/React.createContext(null);
7
8
  if (process.env.NODE_ENV !== 'production') {
@@ -14,6 +15,7 @@ export function TreeViewChildrenItemProvider(props) {
14
15
  } = props;
15
16
  const {
16
17
  instance,
18
+ treeId,
17
19
  rootRef
18
20
  } = useTreeViewContext();
19
21
  const childrenIdAttrToIdRef = React.useRef(new Map());
@@ -28,7 +30,11 @@ export function TreeViewChildrenItemProvider(props) {
28
30
  // Undefined during 1st render
29
31
  const itemMeta = instance.getItemMeta(itemId);
30
32
  if (itemMeta !== undefined) {
31
- idAttr = instance.getTreeItemIdAttribute(itemId, itemMeta.idAttribute);
33
+ idAttr = generateTreeItemIdAttribute({
34
+ itemId,
35
+ treeId,
36
+ id: itemMeta.idAttribute
37
+ });
32
38
  }
33
39
  }
34
40
  if (idAttr == null) {
@@ -14,7 +14,8 @@ export function TreeViewProvider(props) {
14
14
  return /*#__PURE__*/_jsx(TreeViewContext.Provider, {
15
15
  value: value,
16
16
  children: value.wrapRoot({
17
- children
17
+ children,
18
+ instance: value.instance
18
19
  })
19
20
  });
20
21
  }
@@ -1,19 +1,40 @@
1
+ import _extends from "@babel/runtime/helpers/esm/extends";
1
2
  import * as React from 'react';
2
- import useId from '@mui/utils/useId';
3
+ import { createTreeViewDefaultId } from "./useTreeViewId.utils.js";
3
4
  export const useTreeViewId = ({
4
- params
5
+ params,
6
+ state,
7
+ setState
5
8
  }) => {
6
- const treeId = useId(params.id);
7
- const getTreeItemIdAttribute = React.useCallback((itemId, idAttribute) => idAttribute ?? `${treeId}-${itemId}`, [treeId]);
9
+ const treeId = state.id.treeId;
10
+ React.useEffect(() => {
11
+ setState(prevState => {
12
+ if (prevState.id.treeId === params.id) {
13
+ return prevState;
14
+ }
15
+ return _extends({}, prevState, {
16
+ id: _extends({}, prevState.id, {
17
+ treeId: params.id ?? createTreeViewDefaultId()
18
+ })
19
+ });
20
+ });
21
+ }, [setState, params.id]);
8
22
  return {
9
23
  getRootProps: () => ({
10
24
  id: treeId
11
25
  }),
12
- instance: {
13
- getTreeItemIdAttribute
26
+ contextValue: {
27
+ treeId
14
28
  }
15
29
  };
16
30
  };
17
31
  useTreeViewId.params = {
18
32
  id: true
19
- };
33
+ };
34
+ useTreeViewId.getInitialState = ({
35
+ id
36
+ }) => ({
37
+ id: {
38
+ treeId: id ?? createTreeViewDefaultId()
39
+ }
40
+ });
@@ -0,0 +1,26 @@
1
+ let globalTreeViewDefaultId = 0;
2
+ export const createTreeViewDefaultId = () => {
3
+ globalTreeViewDefaultId += 1;
4
+ return `mui-tree-view-${globalTreeViewDefaultId}`;
5
+ };
6
+
7
+ /**
8
+ * Generate the id attribute (i.e.: the `id` attribute passed to the DOM element) of a tree item.
9
+ * If the user explicitly defined an id attribute, it will be returned.
10
+ * Otherwise, the method creates a unique id for the item based on the Tree View id attribute and the item `itemId`
11
+ * @param {object} params The parameters to determine the id attribute of the item.
12
+ * @param {TreeViewItemId} params.itemId The id of the item to get the id attribute of.
13
+ * @param {string | undefined} params.idAttribute The id attribute of the item if explicitly defined by the user.
14
+ * @param {string} params.treeId The id attribute of the Tree View.
15
+ * @returns {string} The id attribute of the item.
16
+ */
17
+ export const generateTreeItemIdAttribute = ({
18
+ id,
19
+ treeId = '',
20
+ itemId
21
+ }) => {
22
+ if (id != null) {
23
+ return id;
24
+ }
25
+ return `${treeId}-${itemId}`;
26
+ };
@@ -86,7 +86,9 @@ useTreeViewExpansion.models = {
86
86
  }
87
87
  };
88
88
  const DEFAULT_EXPANDED_ITEMS = [];
89
- useTreeViewExpansion.getDefaultizedParams = params => _extends({}, params, {
89
+ useTreeViewExpansion.getDefaultizedParams = ({
90
+ params
91
+ }) => _extends({}, params, {
90
92
  defaultExpandedItems: params.defaultExpandedItems ?? DEFAULT_EXPANDED_ITEMS
91
93
  });
92
94
  useTreeViewExpansion.params = {
@@ -64,7 +64,7 @@ export const useTreeViewFocus = ({
64
64
  }
65
65
  const itemMeta = instance.getItemMeta(state.focusedItemId);
66
66
  if (itemMeta) {
67
- const itemElement = document.getElementById(instance.getTreeItemIdAttribute(state.focusedItemId, itemMeta.idAttribute));
67
+ const itemElement = instance.getItemDOMElement(state.focusedItemId);
68
68
  if (itemElement) {
69
69
  itemElement.blur();
70
70
  }
@@ -5,6 +5,7 @@ import * as React from 'react';
5
5
  import { publishTreeViewEvent } from "../../utils/publishTreeViewEvent.js";
6
6
  import { buildSiblingIndexes, TREE_VIEW_ROOT_PARENT_ID } from "./useTreeViewItems.utils.js";
7
7
  import { TreeViewItemDepthContext } from "../../TreeViewItemDepthContext/index.js";
8
+ import { generateTreeItemIdAttribute } from "../../corePlugins/useTreeViewId/useTreeViewId.utils.js";
8
9
  import { jsx as _jsx } from "react/jsx-runtime";
9
10
  const updateItemsState = ({
10
11
  items,
@@ -110,7 +111,11 @@ export const useTreeViewItems = ({
110
111
  if (itemMeta == null) {
111
112
  return null;
112
113
  }
113
- return document.getElementById(instance.getTreeItemIdAttribute(itemId, itemMeta.idAttribute));
114
+ return document.getElementById(generateTreeItemIdAttribute({
115
+ treeId: state.id.treeId,
116
+ itemId,
117
+ id: itemMeta.idAttribute
118
+ }));
114
119
  };
115
120
  const isItemNavigable = itemId => {
116
121
  if (params.disabledItemsFocusable) {
@@ -200,7 +205,9 @@ useTreeViewItems.getInitialState = params => ({
200
205
  getItemLabel: params.getItemLabel
201
206
  })
202
207
  });
203
- useTreeViewItems.getDefaultizedParams = params => _extends({}, params, {
208
+ useTreeViewItems.getDefaultizedParams = ({
209
+ params
210
+ }) => _extends({}, params, {
204
211
  disabledItemsFocusable: params.disabledItemsFocusable ?? false,
205
212
  itemChildrenIndentation: params.itemChildrenIndentation ?? '12px'
206
213
  });
@@ -8,6 +8,7 @@ import { useTreeViewContext } from "../../TreeViewProvider/index.js";
8
8
  import { TreeViewChildrenItemContext, TreeViewChildrenItemProvider } from "../../TreeViewProvider/TreeViewChildrenItemProvider.js";
9
9
  import { buildSiblingIndexes, TREE_VIEW_ROOT_PARENT_ID } from "../useTreeViewItems/useTreeViewItems.utils.js";
10
10
  import { TreeViewItemDepthContext } from "../../TreeViewItemDepthContext/index.js";
11
+ import { generateTreeItemIdAttribute } from "../../corePlugins/useTreeViewId/useTreeViewId.utils.js";
11
12
  import { jsx as _jsx } from "react/jsx-runtime";
12
13
  export const useTreeViewJSXItems = ({
13
14
  instance,
@@ -98,7 +99,8 @@ const useTreeViewJSXItemsItemPlugin = ({
98
99
  contentRef
99
100
  }) => {
100
101
  const {
101
- instance
102
+ instance,
103
+ treeId
102
104
  } = useTreeViewContext();
103
105
  const {
104
106
  children,
@@ -122,12 +124,16 @@ const useTreeViewJSXItemsItemPlugin = ({
122
124
 
123
125
  // Prevent any flashing
124
126
  useEnhancedEffect(() => {
125
- const idAttributeWithDefault = instance.getTreeItemIdAttribute(itemId, id);
126
- registerChild(idAttributeWithDefault, itemId);
127
+ const idAttribute = generateTreeItemIdAttribute({
128
+ itemId,
129
+ treeId,
130
+ id
131
+ });
132
+ registerChild(idAttribute, itemId);
127
133
  return () => {
128
- unregisterChild(idAttributeWithDefault);
134
+ unregisterChild(idAttribute);
129
135
  };
130
- }, [instance, registerChild, unregisterChild, itemId, id]);
136
+ }, [registerChild, unregisterChild, itemId, id, treeId]);
131
137
  React.useEffect(() => {
132
138
  return instance.insertJSXItem({
133
139
  id: itemId,
@@ -153,6 +153,9 @@ export const useTreeViewKeyboardNavigation = ({
153
153
  // If the focused item is collapsed and has children, we expand it
154
154
  case key === 'ArrowRight' && !isRtl || key === 'ArrowLeft' && isRtl:
155
155
  {
156
+ if (ctrlPressed) {
157
+ return;
158
+ }
156
159
  if (instance.isItemExpanded(itemId)) {
157
160
  const nextItemId = getNextNavigableItem(instance, itemId);
158
161
  if (nextItemId) {
@@ -170,6 +173,9 @@ export const useTreeViewKeyboardNavigation = ({
170
173
  // If the focused item is collapsed and has a parent, we move the focus to this parent
171
174
  case key === 'ArrowLeft' && !isRtl || key === 'ArrowRight' && isRtl:
172
175
  {
176
+ if (ctrlPressed) {
177
+ return;
178
+ }
173
179
  if (canToggleItemExpansion(itemId) && instance.isItemExpanded(itemId)) {
174
180
  instance.toggleItemExpansion(event, itemId);
175
181
  event.preventDefault();
@@ -6,14 +6,8 @@ export const useTreeViewLabel = ({
6
6
  instance,
7
7
  state,
8
8
  setState,
9
- params,
10
- experimentalFeatures
9
+ params
11
10
  }) => {
12
- if (process.env.NODE_ENV !== 'production') {
13
- if (params.isItemEditable && !experimentalFeatures?.labelEditing) {
14
- warnOnce(['MUI X: The label editing feature requires the `labelEditing` experimental feature to be enabled.', 'You can do it by passing `experimentalFeatures={{ labelEditing: true}}` to the `RichTreeViewPro` component.', 'Check the documentation for more details: https://mui.com/x/react-tree-view/rich-tree-view/editing/']);
15
- }
16
- }
17
11
  const editedItemRef = React.useRef(state.editedItemId);
18
12
  const isItemBeingEditedRef = itemId => editedItemRef.current === itemId;
19
13
  const setEditedItemId = editedItemId => {
@@ -23,7 +17,7 @@ export const useTreeViewLabel = ({
23
17
  editedItemRef.current = editedItemId;
24
18
  };
25
19
  const isItemBeingEdited = itemId => itemId === state.editedItemId;
26
- const isTreeViewEditable = Boolean(params.isItemEditable) && !!experimentalFeatures.labelEditing;
20
+ const isTreeViewEditable = Boolean(params.isItemEditable);
27
21
  const isItemEditable = itemId => {
28
22
  if (itemId == null || !isTreeViewEditable) {
29
23
  return false;
@@ -72,6 +66,20 @@ export const useTreeViewLabel = ({
72
66
  };
73
67
  };
74
68
  useTreeViewLabel.itemPlugin = useTreeViewLabelItemPlugin;
69
+ useTreeViewLabel.getDefaultizedParams = ({
70
+ params,
71
+ experimentalFeatures
72
+ }) => {
73
+ const canUseFeature = experimentalFeatures?.labelEditing;
74
+ if (process.env.NODE_ENV !== 'production') {
75
+ if (params.isItemEditable && !canUseFeature) {
76
+ warnOnce(['MUI X: The label editing feature requires the `labelEditing` experimental feature to be enabled.', 'You can do it by passing `experimentalFeatures={{ labelEditing: true}}` to the `RichTreeViewPro` component.', 'Check the documentation for more details: https://mui.com/x/react-tree-view/rich-tree-view/editing/']);
77
+ }
78
+ }
79
+ return _extends({}, params, {
80
+ isItemEditable: canUseFeature ? params.isItemEditable ?? false : false
81
+ });
82
+ };
75
83
  useTreeViewLabel.getInitialState = () => ({
76
84
  editedItemId: null
77
85
  });
@@ -174,7 +174,9 @@ useTreeViewSelection.models = {
174
174
  }
175
175
  };
176
176
  const DEFAULT_SELECTED_ITEMS = [];
177
- useTreeViewSelection.getDefaultizedParams = params => _extends({}, params, {
177
+ useTreeViewSelection.getDefaultizedParams = ({
178
+ params
179
+ }) => _extends({}, params, {
178
180
  disableSelection: params.disableSelection ?? false,
179
181
  multiSelect: params.multiSelect ?? false,
180
182
  checkboxSelection: params.checkboxSelection ?? false,
@@ -6,7 +6,7 @@ export const extractPluginParamsFromProps = _ref => {
6
6
  slots,
7
7
  slotProps,
8
8
  apiRef,
9
- experimentalFeatures
9
+ experimentalFeatures: inExperimentalFeatures
10
10
  },
11
11
  plugins
12
12
  } = _ref,
@@ -25,9 +25,13 @@ export const extractPluginParamsFromProps = _ref => {
25
25
  forwardedProps[propName] = prop;
26
26
  }
27
27
  });
28
+ const experimentalFeatures = inExperimentalFeatures ?? {};
28
29
  const defaultizedPluginParams = plugins.reduce((acc, plugin) => {
29
30
  if (plugin.getDefaultizedParams) {
30
- return plugin.getDefaultizedParams(acc);
31
+ return plugin.getDefaultizedParams({
32
+ params: acc,
33
+ experimentalFeatures
34
+ });
31
35
  }
32
36
  return acc;
33
37
  }, pluginParams);
@@ -37,6 +41,6 @@ export const extractPluginParamsFromProps = _ref => {
37
41
  pluginParams: defaultizedPluginParams,
38
42
  slots: slots ?? {},
39
43
  slotProps: slotProps ?? {},
40
- experimentalFeatures: experimentalFeatures ?? {}
44
+ experimentalFeatures
41
45
  };
42
46
  };
@@ -6,6 +6,7 @@ import { useTreeViewContext } from "../internals/TreeViewProvider/index.js";
6
6
  import { useTreeItem2Utils } from "../hooks/useTreeItem2Utils/index.js";
7
7
  import { TreeViewItemDepthContext } from "../internals/TreeViewItemDepthContext/index.js";
8
8
  import { isTargetInDescendants } from "../internals/utils/tree.js";
9
+ import { generateTreeItemIdAttribute } from "../internals/corePlugins/useTreeViewId/useTreeViewId.utils.js";
9
10
  export const useTreeItem2 = parameters => {
10
11
  const {
11
12
  runItemPlugins,
@@ -22,6 +23,7 @@ export const useTreeItem2 = parameters => {
22
23
  expansion: {
23
24
  expansionTrigger
24
25
  },
26
+ treeId,
25
27
  instance,
26
28
  publicAPI
27
29
  } = useTreeViewContext();
@@ -47,10 +49,14 @@ export const useTreeItem2 = parameters => {
47
49
  });
48
50
  const rootRefObject = React.useRef(null);
49
51
  const contentRefObject = React.useRef(null);
50
- const idAttribute = instance.getTreeItemIdAttribute(itemId, id);
51
52
  const handleRootRef = useForkRef(rootRef, pluginRootRef, rootRefObject);
52
53
  const handleContentRef = useForkRef(contentRef, contentRefObject);
53
54
  const checkboxRef = React.useRef(null);
55
+ const idAttribute = generateTreeItemIdAttribute({
56
+ itemId,
57
+ treeId,
58
+ id
59
+ });
54
60
  const rootTabIndex = instance.canItemBeTabbed(itemId) ? 0 : -1;
55
61
  const sharedPropsEnhancerParams = {
56
62
  rootRefObject,
@@ -31,6 +31,7 @@ var _TreeItem2Provider = require("../TreeItem2Provider");
31
31
  var _TreeViewItemDepthContext = require("../internals/TreeViewItemDepthContext");
32
32
  var _useTreeItemState = require("./useTreeItemState");
33
33
  var _tree = require("../internals/utils/tree");
34
+ var _useTreeViewId = require("../internals/corePlugins/useTreeViewId/useTreeViewId.utils");
34
35
  var _jsxRuntime = require("react/jsx-runtime");
35
36
  const _excluded = ["children", "className", "slots", "slotProps", "ContentComponent", "ContentProps", "itemId", "id", "label", "onClick", "onMouseDown", "onFocus", "onBlur", "onKeyDown"],
36
37
  _excluded2 = ["ownerState"],
@@ -192,6 +193,7 @@ const TreeItem = exports.TreeItem = /*#__PURE__*/React.forwardRef(function TreeI
192
193
  expansion: {
193
194
  expansionTrigger
194
195
  },
196
+ treeId,
195
197
  instance
196
198
  } = (0, _TreeViewProvider.useTreeViewContext)();
197
199
  const depthContext = React.useContext(_TreeViewItemDepthContext.TreeViewItemDepthContext);
@@ -348,7 +350,11 @@ const TreeItem = exports.TreeItem = /*#__PURE__*/React.forwardRef(function TreeI
348
350
  }
349
351
  instance.handleItemKeyDown(event, itemId);
350
352
  };
351
- const idAttribute = instance.getTreeItemIdAttribute(itemId, id);
353
+ const idAttribute = (0, _useTreeViewId.generateTreeItemIdAttribute)({
354
+ itemId,
355
+ treeId,
356
+ id
357
+ });
352
358
  const tabIndex = instance.canItemBeTabbed(itemId) ? 0 : -1;
353
359
  const sharedPropsEnhancerParams = {
354
360
  rootRefObject,