@mui/x-tree-view 7.0.0-alpha.1 → 7.0.0-alpha.7

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 (203) hide show
  1. package/CHANGELOG.md +1254 -188
  2. package/README.md +0 -1
  3. package/RichTreeView/RichTreeView.d.ts +20 -0
  4. package/RichTreeView/RichTreeView.js +324 -0
  5. package/RichTreeView/RichTreeView.types.d.ts +55 -0
  6. package/RichTreeView/RichTreeView.types.js +1 -0
  7. package/RichTreeView/index.d.ts +3 -0
  8. package/RichTreeView/index.js +3 -0
  9. package/RichTreeView/package.json +6 -0
  10. package/RichTreeView/richTreeViewClasses.d.ts +7 -0
  11. package/RichTreeView/richTreeViewClasses.js +6 -0
  12. package/SimpleTreeView/SimpleTreeView.d.ts +20 -0
  13. package/SimpleTreeView/SimpleTreeView.js +268 -0
  14. package/SimpleTreeView/SimpleTreeView.plugins.d.ts +6 -0
  15. package/SimpleTreeView/SimpleTreeView.plugins.js +5 -0
  16. package/SimpleTreeView/SimpleTreeView.types.d.ts +38 -0
  17. package/SimpleTreeView/SimpleTreeView.types.js +1 -0
  18. package/SimpleTreeView/index.d.ts +3 -0
  19. package/SimpleTreeView/index.js +3 -0
  20. package/SimpleTreeView/package.json +6 -0
  21. package/SimpleTreeView/simpleTreeViewClasses.d.ts +7 -0
  22. package/SimpleTreeView/simpleTreeViewClasses.js +6 -0
  23. package/TreeItem/TreeItem.js +44 -89
  24. package/TreeItem/TreeItem.types.d.ts +2 -1
  25. package/TreeItem/index.d.ts +2 -2
  26. package/TreeItem/index.js +2 -2
  27. package/TreeItem/useTreeItem.js +5 -5
  28. package/TreeView/TreeView.d.ts +4 -0
  29. package/TreeView/TreeView.js +80 -87
  30. package/TreeView/TreeView.types.d.ts +4 -26
  31. package/TreeView/index.d.ts +1 -1
  32. package/index.d.ts +3 -0
  33. package/index.js +5 -2
  34. package/internals/TreeViewProvider/TreeViewContext.d.ts +1 -2
  35. package/internals/TreeViewProvider/TreeViewContext.js +1 -14
  36. package/internals/TreeViewProvider/TreeViewProvider.types.d.ts +3 -3
  37. package/internals/TreeViewProvider/useTreeViewContext.js +7 -1
  38. package/internals/corePlugins/corePlugins.d.ts +1 -1
  39. package/internals/corePlugins/corePlugins.js +1 -1
  40. package/internals/corePlugins/useTreeViewInstanceEvents/useTreeViewInstanceEvents.d.ts +0 -5
  41. package/internals/corePlugins/useTreeViewInstanceEvents/useTreeViewInstanceEvents.js +0 -6
  42. package/internals/hooks/useLazyRef.d.ts +2 -0
  43. package/internals/hooks/useLazyRef.js +11 -0
  44. package/internals/hooks/useOnMount.d.ts +2 -0
  45. package/internals/hooks/useOnMount.js +7 -0
  46. package/internals/hooks/useTimeout.d.ts +9 -0
  47. package/internals/hooks/useTimeout.js +28 -0
  48. package/internals/models/plugin.d.ts +23 -0
  49. package/internals/models/treeView.d.ts +5 -1
  50. package/internals/plugins/defaultPlugins.d.ts +3 -2
  51. package/internals/plugins/defaultPlugins.js +2 -1
  52. package/internals/plugins/useTreeViewContextValueBuilder/useTreeViewContextValueBuilder.js +8 -6
  53. package/internals/plugins/useTreeViewContextValueBuilder/useTreeViewContextValueBuilder.types.d.ts +1 -6
  54. package/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.js +26 -17
  55. package/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.types.d.ts +12 -5
  56. package/internals/plugins/useTreeViewFocus/useTreeViewFocus.js +13 -6
  57. package/internals/plugins/useTreeViewFocus/useTreeViewFocus.types.d.ts +4 -1
  58. package/internals/plugins/useTreeViewId/index.d.ts +2 -0
  59. package/internals/plugins/useTreeViewId/index.js +1 -0
  60. package/internals/plugins/useTreeViewId/useTreeViewId.d.ts +3 -0
  61. package/internals/plugins/useTreeViewId/useTreeViewId.js +18 -0
  62. package/internals/plugins/useTreeViewId/useTreeViewId.types.d.ts +17 -0
  63. package/internals/plugins/useTreeViewId/useTreeViewId.types.js +1 -0
  64. package/internals/plugins/useTreeViewJSXNodes/index.d.ts +2 -0
  65. package/internals/plugins/useTreeViewJSXNodes/index.js +1 -0
  66. package/internals/plugins/useTreeViewJSXNodes/useTreeViewJSXNodes.d.ts +3 -0
  67. package/internals/plugins/useTreeViewJSXNodes/useTreeViewJSXNodes.js +114 -0
  68. package/internals/plugins/useTreeViewJSXNodes/useTreeViewJSXNodes.types.d.ts +16 -0
  69. package/internals/plugins/useTreeViewJSXNodes/useTreeViewJSXNodes.types.js +1 -0
  70. package/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.js +20 -9
  71. package/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.types.d.ts +5 -2
  72. package/internals/plugins/useTreeViewNodes/useTreeViewNodes.js +83 -18
  73. package/internals/plugins/useTreeViewNodes/useTreeViewNodes.types.d.ts +48 -5
  74. package/internals/plugins/useTreeViewSelection/useTreeViewSelection.d.ts +1 -1
  75. package/internals/plugins/useTreeViewSelection/useTreeViewSelection.js +41 -28
  76. package/internals/plugins/useTreeViewSelection/useTreeViewSelection.types.d.ts +15 -8
  77. package/internals/useTreeView/useTreeView.js +40 -3
  78. package/internals/useTreeView/useTreeView.types.d.ts +2 -1
  79. package/internals/utils/warning.d.ts +1 -0
  80. package/internals/utils/warning.js +14 -0
  81. package/legacy/RichTreeView/RichTreeView.js +317 -0
  82. package/legacy/RichTreeView/RichTreeView.types.js +1 -0
  83. package/legacy/RichTreeView/index.js +3 -0
  84. package/legacy/RichTreeView/richTreeViewClasses.js +6 -0
  85. package/legacy/SimpleTreeView/SimpleTreeView.js +264 -0
  86. package/legacy/SimpleTreeView/SimpleTreeView.plugins.js +6 -0
  87. package/legacy/SimpleTreeView/SimpleTreeView.types.js +1 -0
  88. package/legacy/SimpleTreeView/index.js +3 -0
  89. package/legacy/SimpleTreeView/simpleTreeViewClasses.js +6 -0
  90. package/legacy/TreeItem/TreeItem.js +49 -103
  91. package/legacy/TreeItem/index.js +2 -2
  92. package/legacy/TreeItem/useTreeItem.js +5 -5
  93. package/legacy/TreeView/TreeView.js +80 -82
  94. package/legacy/index.js +5 -2
  95. package/legacy/internals/TreeViewProvider/TreeViewContext.js +1 -14
  96. package/legacy/internals/TreeViewProvider/useTreeViewContext.js +5 -1
  97. package/legacy/internals/corePlugins/corePlugins.js +1 -1
  98. package/legacy/internals/corePlugins/useTreeViewInstanceEvents/useTreeViewInstanceEvents.js +0 -6
  99. package/legacy/internals/hooks/useLazyRef.js +11 -0
  100. package/legacy/internals/hooks/useOnMount.js +7 -0
  101. package/legacy/internals/hooks/useTimeout.js +38 -0
  102. package/legacy/internals/plugins/defaultPlugins.js +2 -1
  103. package/legacy/internals/plugins/useTreeViewContextValueBuilder/useTreeViewContextValueBuilder.js +11 -8
  104. package/legacy/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.js +26 -17
  105. package/legacy/internals/plugins/useTreeViewFocus/useTreeViewFocus.js +13 -6
  106. package/legacy/internals/plugins/useTreeViewId/index.js +1 -0
  107. package/legacy/internals/plugins/useTreeViewId/useTreeViewId.js +21 -0
  108. package/legacy/internals/plugins/useTreeViewId/useTreeViewId.types.js +1 -0
  109. package/legacy/internals/plugins/useTreeViewJSXNodes/index.js +1 -0
  110. package/legacy/internals/plugins/useTreeViewJSXNodes/useTreeViewJSXNodes.js +120 -0
  111. package/legacy/internals/plugins/useTreeViewJSXNodes/useTreeViewJSXNodes.types.js +1 -0
  112. package/legacy/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.js +20 -9
  113. package/legacy/internals/plugins/useTreeViewNodes/useTreeViewNodes.js +89 -20
  114. package/legacy/internals/plugins/useTreeViewSelection/useTreeViewSelection.js +45 -28
  115. package/legacy/internals/useTreeView/useTreeView.js +39 -3
  116. package/legacy/internals/utils/warning.js +15 -0
  117. package/legacy/models/index.js +1 -0
  118. package/legacy/models/items.js +1 -0
  119. package/models/index.d.ts +1 -0
  120. package/models/index.js +1 -0
  121. package/models/items.d.ts +7 -0
  122. package/models/items.js +1 -0
  123. package/models/package.json +6 -0
  124. package/modern/RichTreeView/RichTreeView.js +322 -0
  125. package/modern/RichTreeView/RichTreeView.types.js +1 -0
  126. package/modern/RichTreeView/index.js +3 -0
  127. package/modern/RichTreeView/richTreeViewClasses.js +6 -0
  128. package/modern/SimpleTreeView/SimpleTreeView.js +267 -0
  129. package/modern/SimpleTreeView/SimpleTreeView.plugins.js +5 -0
  130. package/modern/SimpleTreeView/SimpleTreeView.types.js +1 -0
  131. package/modern/SimpleTreeView/index.js +3 -0
  132. package/modern/SimpleTreeView/simpleTreeViewClasses.js +6 -0
  133. package/modern/TreeItem/TreeItem.js +44 -88
  134. package/modern/TreeItem/index.js +2 -2
  135. package/modern/TreeItem/useTreeItem.js +5 -5
  136. package/modern/TreeView/TreeView.js +80 -87
  137. package/modern/index.js +5 -2
  138. package/modern/internals/TreeViewProvider/TreeViewContext.js +1 -14
  139. package/modern/internals/TreeViewProvider/useTreeViewContext.js +7 -1
  140. package/modern/internals/corePlugins/corePlugins.js +1 -1
  141. package/modern/internals/corePlugins/useTreeViewInstanceEvents/useTreeViewInstanceEvents.js +0 -6
  142. package/modern/internals/hooks/useLazyRef.js +11 -0
  143. package/modern/internals/hooks/useOnMount.js +7 -0
  144. package/modern/internals/hooks/useTimeout.js +28 -0
  145. package/modern/internals/plugins/defaultPlugins.js +2 -1
  146. package/modern/internals/plugins/useTreeViewContextValueBuilder/useTreeViewContextValueBuilder.js +8 -6
  147. package/modern/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.js +26 -17
  148. package/modern/internals/plugins/useTreeViewFocus/useTreeViewFocus.js +12 -6
  149. package/modern/internals/plugins/useTreeViewId/index.js +1 -0
  150. package/modern/internals/plugins/useTreeViewId/useTreeViewId.js +18 -0
  151. package/modern/internals/plugins/useTreeViewId/useTreeViewId.types.js +1 -0
  152. package/modern/internals/plugins/useTreeViewJSXNodes/index.js +1 -0
  153. package/modern/internals/plugins/useTreeViewJSXNodes/useTreeViewJSXNodes.js +113 -0
  154. package/modern/internals/plugins/useTreeViewJSXNodes/useTreeViewJSXNodes.types.js +1 -0
  155. package/modern/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.js +19 -9
  156. package/modern/internals/plugins/useTreeViewNodes/useTreeViewNodes.js +82 -18
  157. package/modern/internals/plugins/useTreeViewSelection/useTreeViewSelection.js +41 -28
  158. package/modern/internals/useTreeView/useTreeView.js +40 -3
  159. package/modern/internals/utils/warning.js +14 -0
  160. package/modern/models/index.js +1 -0
  161. package/modern/models/items.js +1 -0
  162. package/node/RichTreeView/RichTreeView.js +330 -0
  163. package/node/RichTreeView/RichTreeView.types.js +5 -0
  164. package/node/RichTreeView/index.js +27 -0
  165. package/node/RichTreeView/richTreeViewClasses.js +14 -0
  166. package/node/SimpleTreeView/SimpleTreeView.js +275 -0
  167. package/node/SimpleTreeView/SimpleTreeView.plugins.js +11 -0
  168. package/node/SimpleTreeView/SimpleTreeView.types.js +5 -0
  169. package/node/SimpleTreeView/index.js +27 -0
  170. package/node/SimpleTreeView/simpleTreeViewClasses.js +14 -0
  171. package/node/TreeItem/TreeItem.js +44 -88
  172. package/node/TreeItem/index.js +11 -15
  173. package/node/TreeItem/useTreeItem.js +5 -5
  174. package/node/TreeView/TreeView.js +80 -87
  175. package/node/index.js +38 -2
  176. package/node/internals/TreeViewProvider/TreeViewContext.js +2 -15
  177. package/node/internals/TreeViewProvider/useTreeViewContext.js +7 -1
  178. package/node/internals/corePlugins/corePlugins.js +1 -1
  179. package/node/internals/corePlugins/useTreeViewInstanceEvents/useTreeViewInstanceEvents.js +0 -6
  180. package/node/internals/hooks/useLazyRef.js +19 -0
  181. package/node/internals/hooks/useOnMount.js +15 -0
  182. package/node/internals/hooks/useTimeout.js +34 -0
  183. package/node/internals/plugins/defaultPlugins.js +2 -1
  184. package/node/internals/plugins/useTreeViewContextValueBuilder/useTreeViewContextValueBuilder.js +8 -7
  185. package/node/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.js +26 -17
  186. package/node/internals/plugins/useTreeViewFocus/useTreeViewFocus.js +12 -6
  187. package/node/internals/plugins/useTreeViewId/index.js +12 -0
  188. package/node/internals/plugins/useTreeViewId/useTreeViewId.js +28 -0
  189. package/node/internals/plugins/useTreeViewId/useTreeViewId.types.js +5 -0
  190. package/node/internals/plugins/useTreeViewJSXNodes/index.js +12 -0
  191. package/node/internals/plugins/useTreeViewJSXNodes/useTreeViewJSXNodes.js +123 -0
  192. package/node/internals/plugins/useTreeViewJSXNodes/useTreeViewJSXNodes.types.js +5 -0
  193. package/node/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.js +19 -9
  194. package/node/internals/plugins/useTreeViewNodes/useTreeViewNodes.js +82 -18
  195. package/node/internals/plugins/useTreeViewSelection/useTreeViewSelection.js +41 -28
  196. package/node/internals/useTreeView/useTreeView.js +40 -3
  197. package/node/internals/utils/warning.js +21 -0
  198. package/node/models/index.js +16 -0
  199. package/node/models/items.js +5 -0
  200. package/package.json +8 -7
  201. package/themeAugmentation/components.d.ts +14 -4
  202. package/themeAugmentation/overrides.d.ts +8 -4
  203. package/themeAugmentation/props.d.ts +7 -3
@@ -10,30 +10,49 @@ export const useTreeViewSelection = ({
10
10
  const lastSelectedNode = React.useRef(null);
11
11
  const lastSelectionWasRange = React.useRef(false);
12
12
  const currentRangeSelection = React.useRef([]);
13
- const isNodeSelected = nodeId => Array.isArray(models.selected.value) ? models.selected.value.indexOf(nodeId) !== -1 : models.selected.value === nodeId;
13
+ const isNodeSelected = nodeId => Array.isArray(models.selectedNodes.value) ? models.selectedNodes.value.indexOf(nodeId) !== -1 : models.selectedNodes.value === nodeId;
14
+ const setSelectedNodes = (event, newSelectedNodes) => {
15
+ if (params.onNodeSelectionToggle) {
16
+ if (params.multiSelect) {
17
+ const addedNodes = newSelectedNodes.filter(nodeId => !instance.isNodeSelected(nodeId));
18
+ const removedNodes = models.selectedNodes.value.filter(nodeId => !newSelectedNodes.includes(nodeId));
19
+ addedNodes.forEach(nodeId => {
20
+ params.onNodeSelectionToggle(event, nodeId, true);
21
+ });
22
+ removedNodes.forEach(nodeId => {
23
+ params.onNodeSelectionToggle(event, nodeId, false);
24
+ });
25
+ } else if (newSelectedNodes !== models.selectedNodes.value) {
26
+ if (models.selectedNodes.value != null) {
27
+ params.onNodeSelectionToggle(event, models.selectedNodes.value, false);
28
+ }
29
+ if (newSelectedNodes != null) {
30
+ params.onNodeSelectionToggle(event, newSelectedNodes, true);
31
+ }
32
+ }
33
+ }
34
+ if (params.onSelectedNodesChange) {
35
+ params.onSelectedNodesChange(event, newSelectedNodes);
36
+ }
37
+ models.selectedNodes.setValue(newSelectedNodes);
38
+ };
14
39
  const selectNode = (event, nodeId, multiple = false) => {
15
40
  if (params.disableSelection) {
16
41
  return;
17
42
  }
18
43
  if (multiple) {
19
- if (Array.isArray(models.selected.value)) {
44
+ if (Array.isArray(models.selectedNodes.value)) {
20
45
  let newSelected;
21
- if (models.selected.value.indexOf(nodeId) !== -1) {
22
- newSelected = models.selected.value.filter(id => id !== nodeId);
46
+ if (models.selectedNodes.value.indexOf(nodeId) !== -1) {
47
+ newSelected = models.selectedNodes.value.filter(id => id !== nodeId);
23
48
  } else {
24
- newSelected = [nodeId].concat(models.selected.value);
25
- }
26
- if (params.onNodeSelect) {
27
- params.onNodeSelect(event, newSelected);
49
+ newSelected = [nodeId].concat(models.selectedNodes.value);
28
50
  }
29
- models.selected.setValue(newSelected);
51
+ setSelectedNodes(event, newSelected);
30
52
  }
31
53
  } else {
32
54
  const newSelected = params.multiSelect ? [nodeId] : nodeId;
33
- if (params.onNodeSelect) {
34
- params.onNodeSelect(event, newSelected);
35
- }
36
- models.selected.setValue(newSelected);
55
+ setSelectedNodes(event, newSelected);
37
56
  }
38
57
  lastSelectedNode.current = nodeId;
39
58
  lastSelectionWasRange.current = false;
@@ -50,7 +69,7 @@ export const useTreeViewSelection = ({
50
69
  return nodes;
51
70
  };
52
71
  const handleRangeArrowSelect = (event, nodes) => {
53
- let base = models.selected.value.slice();
72
+ let base = models.selectedNodes.value.slice();
54
73
  const {
55
74
  start,
56
75
  next,
@@ -74,13 +93,10 @@ export const useTreeViewSelection = ({
74
93
  base.push(next);
75
94
  currentRangeSelection.current.push(current, next);
76
95
  }
77
- if (params.onNodeSelect) {
78
- params.onNodeSelect(event, base);
79
- }
80
- models.selected.setValue(base);
96
+ setSelectedNodes(event, base);
81
97
  };
82
98
  const handleRangeSelect = (event, nodes) => {
83
- let base = models.selected.value.slice();
99
+ let base = models.selectedNodes.value.slice();
84
100
  const {
85
101
  start,
86
102
  end
@@ -94,10 +110,7 @@ export const useTreeViewSelection = ({
94
110
  currentRangeSelection.current = range;
95
111
  let newSelected = base.concat(range);
96
112
  newSelected = newSelected.filter((id, i) => newSelected.indexOf(id) === i);
97
- if (params.onNodeSelect) {
98
- params.onNodeSelect(event, newSelected);
99
- }
100
- models.selected.setValue(newSelected);
113
+ setSelectedNodes(event, newSelected);
101
114
  };
102
115
  const selectRange = (event, nodes, stacked = false) => {
103
116
  if (params.disableSelection) {
@@ -156,17 +169,17 @@ export const useTreeViewSelection = ({
156
169
  };
157
170
  };
158
171
  useTreeViewSelection.models = {
159
- selected: {
160
- controlledProp: 'selected',
161
- defaultProp: 'defaultSelected'
172
+ selectedNodes: {
173
+ controlledProp: 'selectedNodes',
174
+ defaultProp: 'defaultSelectedNodes'
162
175
  }
163
176
  };
164
- const DEFAULT_SELECTED = [];
177
+ const DEFAULT_SELECTED_NODES = [];
165
178
  useTreeViewSelection.getDefaultizedParams = params => {
166
179
  var _params$disableSelect, _params$multiSelect, _params$defaultSelect;
167
180
  return _extends({}, params, {
168
181
  disableSelection: (_params$disableSelect = params.disableSelection) != null ? _params$disableSelect : false,
169
182
  multiSelect: (_params$multiSelect = params.multiSelect) != null ? _params$multiSelect : false,
170
- defaultSelected: (_params$defaultSelect = params.defaultSelected) != null ? _params$defaultSelect : params.multiSelect ? DEFAULT_SELECTED : null
183
+ defaultSelectedNodes: (_params$defaultSelect = params.defaultSelectedNodes) != null ? _params$defaultSelect : params.multiSelect ? DEFAULT_SELECTED_NODES : null
171
184
  });
172
185
  };
@@ -21,27 +21,34 @@ export interface UseTreeViewSelectionParameters<Multiple extends boolean | undef
21
21
  * When `multiSelect` is true this takes an array of strings; when false (default) a string.
22
22
  * @default []
23
23
  */
24
- defaultSelected?: TreeViewSelectionValue<Multiple>;
24
+ defaultSelectedNodes?: TreeViewSelectionValue<Multiple>;
25
25
  /**
26
26
  * Selected node ids. (Controlled)
27
27
  * When `multiSelect` is true this takes an array of strings; when false (default) a string.
28
28
  */
29
- selected?: TreeViewSelectionValue<Multiple>;
29
+ selectedNodes?: TreeViewSelectionValue<Multiple>;
30
30
  /**
31
31
  * If true `ctrl` and `shift` will trigger multiselect.
32
32
  * @default false
33
33
  */
34
34
  multiSelect?: Multiple;
35
35
  /**
36
- * Callback fired when tree items are selected/unselected.
36
+ * Callback fired when tree items are selected/deselected.
37
37
  * @param {React.SyntheticEvent} event The event source of the callback
38
- * @param {string[] | string} nodeIds Ids of the selected nodes. When `multiSelect` is true
39
- * this is an array of strings; when false (default) a string.
38
+ * @param {string[] | string} nodeIds The ids of the selected nodes.
39
+ * When `multiSelect` is `true`, this is an array of strings; when false (default) a string.
40
40
  */
41
- onNodeSelect?: (event: React.SyntheticEvent, nodeIds: Exclude<TreeViewSelectionValue<Multiple>, null>) => void;
41
+ onSelectedNodesChange?: (event: React.SyntheticEvent, nodeIds: TreeViewSelectionValue<Multiple>) => void;
42
+ /**
43
+ * Callback fired when a tree item is selected or deselected.
44
+ * @param {React.SyntheticEvent} event The event source of the callback.
45
+ * @param {array} nodeId The nodeId of the modified node.
46
+ * @param {array} isSelected `true` if the node has just been selected, `false` if it has just been deselected.
47
+ */
48
+ onNodeSelectionToggle?: (event: React.SyntheticEvent, nodeId: string, isSelected: boolean) => void;
42
49
  }
43
- export type UseTreeViewSelectionDefaultizedParameters<Multiple extends boolean> = DefaultizedProps<UseTreeViewSelectionParameters<Multiple>, 'disableSelection' | 'defaultSelected' | 'multiSelect'>;
44
- export type UseTreeViewSelectionSignature<Multiple extends boolean | undefined> = TreeViewPluginSignature<UseTreeViewSelectionParameters<Multiple>, UseTreeViewSelectionDefaultizedParameters<Multiple extends undefined ? false : Multiple>, UseTreeViewSelectionInstance, {}, {}, 'selected', [
50
+ export type UseTreeViewSelectionDefaultizedParameters<Multiple extends boolean> = DefaultizedProps<UseTreeViewSelectionParameters<Multiple>, 'disableSelection' | 'defaultSelectedNodes' | 'multiSelect'>;
51
+ export type UseTreeViewSelectionSignature = TreeViewPluginSignature<UseTreeViewSelectionParameters<any>, UseTreeViewSelectionDefaultizedParameters<any>, UseTreeViewSelectionInstance, {}, {}, 'selectedNodes', [
45
52
  UseTreeViewNodesSignature,
46
53
  UseTreeViewExpansionSignature,
47
54
  UseTreeViewNodesSignature
@@ -1,7 +1,6 @@
1
1
  import _extends from "@babel/runtime/helpers/esm/extends";
2
2
  import * as React from 'react';
3
3
  import useForkRef from '@mui/utils/useForkRef';
4
- import { DEFAULT_TREE_VIEW_CONTEXT_VALUE } from '../TreeViewProvider/TreeViewContext';
5
4
  import { useTreeViewModels } from './useTreeViewModels';
6
5
  import { TREE_VIEW_CORE_PLUGINS } from '../corePlugins';
7
6
  export const useTreeView = inParams => {
@@ -27,7 +26,7 @@ export const useTreeView = inParams => {
27
26
  return temp;
28
27
  });
29
28
  const rootPropsGetters = [];
30
- let contextValue = DEFAULT_TREE_VIEW_CONTEXT_VALUE;
29
+ let contextValue = {};
31
30
  const runPlugin = plugin => {
32
31
  const pluginResponse = plugin({
33
32
  instance,
@@ -45,6 +44,43 @@ export const useTreeView = inParams => {
45
44
  }
46
45
  };
47
46
  plugins.forEach(runPlugin);
47
+ contextValue.runItemPlugins = ({
48
+ props,
49
+ ref
50
+ }) => {
51
+ let finalProps = props;
52
+ let finalRef = ref;
53
+ const itemWrappers = [];
54
+ plugins.forEach(plugin => {
55
+ if (!plugin.itemPlugin) {
56
+ return;
57
+ }
58
+ const itemPluginResponse = plugin.itemPlugin({
59
+ props: finalProps,
60
+ ref: finalRef
61
+ });
62
+ if (itemPluginResponse != null && itemPluginResponse.props) {
63
+ finalProps = itemPluginResponse.props;
64
+ }
65
+ if (itemPluginResponse != null && itemPluginResponse.ref) {
66
+ finalRef = itemPluginResponse.ref;
67
+ }
68
+ if (itemPluginResponse != null && itemPluginResponse.wrapItem) {
69
+ itemWrappers.push(itemPluginResponse.wrapItem);
70
+ }
71
+ });
72
+ return {
73
+ props: finalProps,
74
+ ref: finalRef,
75
+ wrapItem: children => {
76
+ let finalChildren = children;
77
+ itemWrappers.forEach(itemWrapper => {
78
+ finalChildren = itemWrapper(finalChildren);
79
+ });
80
+ return finalChildren;
81
+ }
82
+ };
83
+ };
48
84
  const getRootProps = (otherHandlers = {}) => {
49
85
  const rootProps = _extends({
50
86
  role: 'tree',
@@ -60,6 +96,7 @@ export const useTreeView = inParams => {
60
96
  return {
61
97
  getRootProps,
62
98
  rootRef: handleRootRef,
63
- contextValue
99
+ contextValue,
100
+ instance: instance
64
101
  };
65
102
  };
@@ -1,7 +1,7 @@
1
1
  import * as React from 'react';
2
2
  import { EventHandlers } from '@mui/base/utils';
3
3
  import type { TreeViewContextValue } from '../TreeViewProvider';
4
- import { TreeViewAnyPluginSignature, TreeViewPlugin, ConvertPluginsIntoSignatures, MergePluginsProperty } from '../models';
4
+ import { TreeViewAnyPluginSignature, TreeViewPlugin, ConvertPluginsIntoSignatures, MergePluginsProperty, TreeViewInstance } from '../models';
5
5
  export type UseTreeViewParameters<TPlugins extends readonly TreeViewPlugin<TreeViewAnyPluginSignature>[]> = {
6
6
  rootRef?: React.Ref<HTMLUListElement> | undefined;
7
7
  plugins: TPlugins;
@@ -17,4 +17,5 @@ export interface UseTreeViewReturnValue<TPlugins extends readonly TreeViewAnyPlu
17
17
  getRootProps: <TOther extends EventHandlers = {}>(otherHandlers?: TOther) => UseTreeViewRootSlotProps;
18
18
  rootRef: React.RefCallback<HTMLUListElement> | null;
19
19
  contextValue: TreeViewContextValue<TPlugins>;
20
+ instance: TreeViewInstance<TPlugins>;
20
21
  }
@@ -0,0 +1 @@
1
+ export declare const buildWarning: (message: string | string[], gravity?: 'warning' | 'error') => () => void;
@@ -0,0 +1,14 @@
1
+ export const buildWarning = (message, gravity = 'warning') => {
2
+ let alreadyWarned = false;
3
+ const cleanMessage = Array.isArray(message) ? message.join('\n') : message;
4
+ return () => {
5
+ if (!alreadyWarned) {
6
+ alreadyWarned = true;
7
+ if (gravity === 'error') {
8
+ console.error(cleanMessage);
9
+ } else {
10
+ console.warn(cleanMessage);
11
+ }
12
+ }
13
+ };
14
+ };
@@ -0,0 +1,317 @@
1
+ import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
2
+ import _extends from "@babel/runtime/helpers/esm/extends";
3
+ var _excluded = ["disabledItemsFocusable", "expandedNodes", "defaultExpandedNodes", "onExpandedNodesChange", "onNodeExpansionToggle", "onNodeFocus", "disableSelection", "defaultSelectedNodes", "selectedNodes", "multiSelect", "onSelectedNodesChange", "onNodeSelectionToggle", "id", "defaultCollapseIcon", "defaultEndIcon", "defaultExpandIcon", "defaultParentIcon", "items", "getItemId", "getItemLabel", "isItemDisabled", "slots", "slotProps"];
4
+ import * as React from 'react';
5
+ import PropTypes from 'prop-types';
6
+ import { styled, useThemeProps } from '@mui/material/styles';
7
+ import composeClasses from '@mui/utils/composeClasses';
8
+ import { useSlotProps } from '@mui/base/utils';
9
+ import { getRichTreeViewUtilityClass } from './richTreeViewClasses';
10
+ import { useTreeView } from '../internals/useTreeView';
11
+ import { TreeViewProvider } from '../internals/TreeViewProvider';
12
+ import { DEFAULT_TREE_VIEW_PLUGINS } from '../internals/plugins';
13
+ import { TreeItem } from '../TreeItem';
14
+ import { buildWarning } from '../internals/utils/warning';
15
+ import { jsx as _jsx } from "react/jsx-runtime";
16
+ var useUtilityClasses = function useUtilityClasses(ownerState) {
17
+ var classes = ownerState.classes;
18
+ var slots = {
19
+ root: ['root']
20
+ };
21
+ return composeClasses(slots, getRichTreeViewUtilityClass, classes);
22
+ };
23
+ export var RichTreeViewRoot = styled('ul', {
24
+ name: 'MuiRichTreeView',
25
+ slot: 'Root',
26
+ overridesResolver: function overridesResolver(props, styles) {
27
+ return styles.root;
28
+ }
29
+ })({
30
+ padding: 0,
31
+ margin: 0,
32
+ listStyle: 'none',
33
+ outline: 0
34
+ });
35
+ function WrappedTreeItem(_ref) {
36
+ var _slots$item;
37
+ var slots = _ref.slots,
38
+ slotProps = _ref.slotProps,
39
+ label = _ref.label,
40
+ id = _ref.id,
41
+ nodeId = _ref.nodeId,
42
+ children = _ref.children;
43
+ var Item = (_slots$item = slots == null ? void 0 : slots.item) != null ? _slots$item : TreeItem;
44
+ var itemProps = useSlotProps({
45
+ elementType: Item,
46
+ externalSlotProps: slotProps == null ? void 0 : slotProps.item,
47
+ additionalProps: {
48
+ nodeId: nodeId,
49
+ id: id,
50
+ label: label
51
+ },
52
+ ownerState: {
53
+ nodeId: nodeId,
54
+ label: label
55
+ }
56
+ });
57
+ return /*#__PURE__*/_jsx(Item, _extends({}, itemProps, {
58
+ children: children
59
+ }));
60
+ }
61
+ var childrenWarning = buildWarning(['MUI: The `RichTreeView` component does not support JSX children.', 'If you want to add items, you need to use the `items` prop', 'Check the documentation for more details: https://next.mui.com/x/react-tree-view/rich-tree-view/items/']);
62
+
63
+ /**
64
+ *
65
+ * Demos:
66
+ *
67
+ * - [Tree View](https://mui.com/x/react-tree-view/)
68
+ *
69
+ * API:
70
+ *
71
+ * - [RichTreeView API](https://mui.com/x/api/tree-view/rich-tree-view/)
72
+ */
73
+ var RichTreeView = /*#__PURE__*/React.forwardRef(function RichTreeView(inProps, ref) {
74
+ var _slots$root;
75
+ var props = useThemeProps({
76
+ props: inProps,
77
+ name: 'MuiRichTreeView'
78
+ });
79
+ var _ref2 = props,
80
+ disabledItemsFocusable = _ref2.disabledItemsFocusable,
81
+ expandedNodes = _ref2.expandedNodes,
82
+ defaultExpandedNodes = _ref2.defaultExpandedNodes,
83
+ onExpandedNodesChange = _ref2.onExpandedNodesChange,
84
+ onNodeExpansionToggle = _ref2.onNodeExpansionToggle,
85
+ onNodeFocus = _ref2.onNodeFocus,
86
+ disableSelection = _ref2.disableSelection,
87
+ defaultSelectedNodes = _ref2.defaultSelectedNodes,
88
+ selectedNodes = _ref2.selectedNodes,
89
+ multiSelect = _ref2.multiSelect,
90
+ onSelectedNodesChange = _ref2.onSelectedNodesChange,
91
+ onNodeSelectionToggle = _ref2.onNodeSelectionToggle,
92
+ treeId = _ref2.id,
93
+ defaultCollapseIcon = _ref2.defaultCollapseIcon,
94
+ defaultEndIcon = _ref2.defaultEndIcon,
95
+ defaultExpandIcon = _ref2.defaultExpandIcon,
96
+ defaultParentIcon = _ref2.defaultParentIcon,
97
+ items = _ref2.items,
98
+ getItemId = _ref2.getItemId,
99
+ getItemLabel = _ref2.getItemLabel,
100
+ isItemDisabled = _ref2.isItemDisabled,
101
+ slots = _ref2.slots,
102
+ slotProps = _ref2.slotProps,
103
+ other = _objectWithoutProperties(_ref2, _excluded);
104
+ if (process.env.NODE_ENV !== 'production') {
105
+ if (props.children != null) {
106
+ childrenWarning();
107
+ }
108
+ }
109
+ var _useTreeView = useTreeView({
110
+ disabledItemsFocusable: disabledItemsFocusable,
111
+ expandedNodes: expandedNodes,
112
+ defaultExpandedNodes: defaultExpandedNodes,
113
+ onExpandedNodesChange: onExpandedNodesChange,
114
+ onNodeExpansionToggle: onNodeExpansionToggle,
115
+ onNodeFocus: onNodeFocus,
116
+ disableSelection: disableSelection,
117
+ defaultSelectedNodes: defaultSelectedNodes,
118
+ selectedNodes: selectedNodes,
119
+ multiSelect: multiSelect,
120
+ onSelectedNodesChange: onSelectedNodesChange,
121
+ onNodeSelectionToggle: onNodeSelectionToggle,
122
+ id: treeId,
123
+ defaultCollapseIcon: defaultCollapseIcon,
124
+ defaultEndIcon: defaultEndIcon,
125
+ defaultExpandIcon: defaultExpandIcon,
126
+ defaultParentIcon: defaultParentIcon,
127
+ items: items,
128
+ getItemId: getItemId,
129
+ getItemLabel: getItemLabel,
130
+ isItemDisabled: isItemDisabled,
131
+ plugins: DEFAULT_TREE_VIEW_PLUGINS,
132
+ rootRef: ref
133
+ }),
134
+ getRootProps = _useTreeView.getRootProps,
135
+ contextValue = _useTreeView.contextValue,
136
+ instance = _useTreeView.instance;
137
+ var classes = useUtilityClasses(props);
138
+ var Root = (_slots$root = slots == null ? void 0 : slots.root) != null ? _slots$root : RichTreeViewRoot;
139
+ var rootProps = useSlotProps({
140
+ elementType: Root,
141
+ externalSlotProps: slotProps == null ? void 0 : slotProps.root,
142
+ externalForwardedProps: other,
143
+ className: classes.root,
144
+ getSlotProps: getRootProps,
145
+ ownerState: props
146
+ });
147
+ var nodesToRender = instance.getNodesToRender();
148
+ var renderNode = function renderNode(_ref3) {
149
+ var label = _ref3.label,
150
+ nodeId = _ref3.nodeId,
151
+ id = _ref3.id,
152
+ children = _ref3.children;
153
+ return /*#__PURE__*/_jsx(WrappedTreeItem, {
154
+ slots: slots,
155
+ slotProps: slotProps,
156
+ label: label,
157
+ id: id,
158
+ nodeId: nodeId,
159
+ children: children == null ? void 0 : children.map(renderNode)
160
+ }, nodeId);
161
+ };
162
+ return /*#__PURE__*/_jsx(TreeViewProvider, {
163
+ value: contextValue,
164
+ children: /*#__PURE__*/_jsx(Root, _extends({}, rootProps, {
165
+ children: nodesToRender.map(renderNode)
166
+ }))
167
+ });
168
+ });
169
+ process.env.NODE_ENV !== "production" ? RichTreeView.propTypes = {
170
+ // ----------------------------- Warning --------------------------------
171
+ // | These PropTypes are generated from the TypeScript type definitions |
172
+ // | To update them edit the TypeScript types and run "yarn proptypes" |
173
+ // ----------------------------------------------------------------------
174
+ /**
175
+ * Override or extend the styles applied to the component.
176
+ */
177
+ classes: PropTypes.object,
178
+ /**
179
+ * className applied to the root element.
180
+ */
181
+ className: PropTypes.string,
182
+ /**
183
+ * The default icon used to collapse the node.
184
+ */
185
+ defaultCollapseIcon: PropTypes.node,
186
+ /**
187
+ * The default icon displayed next to a end node. This is applied to all
188
+ * tree nodes and can be overridden by the TreeItem `icon` prop.
189
+ */
190
+ defaultEndIcon: PropTypes.node,
191
+ /**
192
+ * Expanded node ids.
193
+ * Used when the item's expansion is not controlled.
194
+ * @default []
195
+ */
196
+ defaultExpandedNodes: PropTypes.arrayOf(PropTypes.string),
197
+ /**
198
+ * The default icon used to expand the node.
199
+ */
200
+ defaultExpandIcon: PropTypes.node,
201
+ /**
202
+ * The default icon displayed next to a parent node. This is applied to all
203
+ * parent nodes and can be overridden by the TreeItem `icon` prop.
204
+ */
205
+ defaultParentIcon: PropTypes.node,
206
+ /**
207
+ * Selected node ids. (Uncontrolled)
208
+ * When `multiSelect` is true this takes an array of strings; when false (default) a string.
209
+ * @default []
210
+ */
211
+ defaultSelectedNodes: PropTypes.any,
212
+ /**
213
+ * If `true`, will allow focus on disabled items.
214
+ * @default false
215
+ */
216
+ disabledItemsFocusable: PropTypes.bool,
217
+ /**
218
+ * If `true` selection is disabled.
219
+ * @default false
220
+ */
221
+ disableSelection: PropTypes.bool,
222
+ /**
223
+ * Expanded node ids.
224
+ * Used when the item's expansion is controlled.
225
+ */
226
+ expandedNodes: PropTypes.arrayOf(PropTypes.string),
227
+ /**
228
+ * Used to determine the string label for a given item.
229
+ *
230
+ * @template R
231
+ * @param {R} item The item to check.
232
+ * @returns {string} The id of the item.
233
+ * @default `(item) => item.id`
234
+ */
235
+ getItemId: PropTypes.func,
236
+ /**
237
+ * Used to determine the string label for a given item.
238
+ *
239
+ * @template R
240
+ * @param {R} item The item to check.
241
+ * @returns {string} The label of the item.
242
+ * @default `(item) => item.label`
243
+ */
244
+ getItemLabel: PropTypes.func,
245
+ /**
246
+ * This prop is used to help implement the accessibility logic.
247
+ * If you don't provide this prop. It falls back to a randomly generated id.
248
+ */
249
+ id: PropTypes.string,
250
+ /**
251
+ * Used to determine if a given item should be disabled.
252
+ * @template R
253
+ * @param {R} item The item to check.
254
+ * @returns {boolean} `true` if the item should be disabled.
255
+ */
256
+ isItemDisabled: PropTypes.func,
257
+ items: PropTypes.array.isRequired,
258
+ /**
259
+ * If true `ctrl` and `shift` will trigger multiselect.
260
+ * @default false
261
+ */
262
+ multiSelect: PropTypes.bool,
263
+ /**
264
+ * Callback fired when tree items are expanded/collapsed.
265
+ * @param {React.SyntheticEvent} event The event source of the callback.
266
+ * @param {array} nodeIds The ids of the expanded nodes.
267
+ */
268
+ onExpandedNodesChange: PropTypes.func,
269
+ /**
270
+ * Callback fired when a tree item is expanded or collapsed.
271
+ * @param {React.SyntheticEvent} event The event source of the callback.
272
+ * @param {array} nodeId The nodeId of the modified node.
273
+ * @param {array} isExpanded `true` if the node has just been expanded, `false` if it has just been collapsed.
274
+ */
275
+ onNodeExpansionToggle: PropTypes.func,
276
+ /**
277
+ * Callback fired when tree items are focused.
278
+ * @param {React.SyntheticEvent} event The event source of the callback **Warning**: This is a generic event not a focus event.
279
+ * @param {string} nodeId The id of the node focused.
280
+ * @param {string} value of the focused node.
281
+ */
282
+ onNodeFocus: PropTypes.func,
283
+ /**
284
+ * Callback fired when a tree item is selected or deselected.
285
+ * @param {React.SyntheticEvent} event The event source of the callback.
286
+ * @param {array} nodeId The nodeId of the modified node.
287
+ * @param {array} isSelected `true` if the node has just been selected, `false` if it has just been deselected.
288
+ */
289
+ onNodeSelectionToggle: PropTypes.func,
290
+ /**
291
+ * Callback fired when tree items are selected/deselected.
292
+ * @param {React.SyntheticEvent} event The event source of the callback
293
+ * @param {string[] | string} nodeIds The ids of the selected nodes.
294
+ * When `multiSelect` is `true`, this is an array of strings; when false (default) a string.
295
+ */
296
+ onSelectedNodesChange: PropTypes.func,
297
+ /**
298
+ * Selected node ids. (Controlled)
299
+ * When `multiSelect` is true this takes an array of strings; when false (default) a string.
300
+ */
301
+ selectedNodes: PropTypes.any,
302
+ /**
303
+ * The props used for each component slot.
304
+ * @default {}
305
+ */
306
+ slotProps: PropTypes.object,
307
+ /**
308
+ * Overridable component slots.
309
+ * @default {}
310
+ */
311
+ slots: PropTypes.object,
312
+ /**
313
+ * The system prop that allows defining system overrides as well as additional CSS styles.
314
+ */
315
+ sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object])
316
+ } : void 0;
317
+ export { RichTreeView };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,3 @@
1
+ export * from './RichTreeView';
2
+ export * from './richTreeViewClasses';
3
+ export {};
@@ -0,0 +1,6 @@
1
+ import generateUtilityClass from '@mui/utils/generateUtilityClass';
2
+ import generateUtilityClasses from '@mui/utils/generateUtilityClasses';
3
+ export function getRichTreeViewUtilityClass(slot) {
4
+ return generateUtilityClass('MuiRichTreeView', slot);
5
+ }
6
+ export var richTreeViewClasses = generateUtilityClasses('MuiRichTreeView', ['root']);