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

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 (120) hide show
  1. package/CHANGELOG.md +131 -0
  2. package/RichTreeView/RichTreeView.js +24 -5
  3. package/SimpleTreeView/SimpleTreeView.js +8 -6
  4. package/TreeItem/TreeItem.d.ts +2 -0
  5. package/TreeItem/TreeItem.js +46 -5
  6. package/TreeItem/TreeItem.types.d.ts +14 -0
  7. package/TreeItemIcon/TreeItemIcon.js +2 -0
  8. package/esm/RichTreeView/RichTreeView.js +24 -5
  9. package/esm/SimpleTreeView/SimpleTreeView.js +8 -6
  10. package/esm/TreeItem/TreeItem.d.ts +2 -0
  11. package/esm/TreeItem/TreeItem.js +45 -4
  12. package/esm/TreeItem/TreeItem.types.d.ts +14 -0
  13. package/esm/TreeItemIcon/TreeItemIcon.js +2 -0
  14. package/esm/hooks/useTreeItemUtils/useTreeItemUtils.d.ts +3 -2
  15. package/esm/hooks/useTreeItemUtils/useTreeItemUtils.js +21 -9
  16. package/esm/hooks/useTreeViewApiRef.d.ts +1 -1
  17. package/esm/index.js +1 -1
  18. package/esm/internals/index.d.ts +6 -1
  19. package/esm/internals/index.js +4 -1
  20. package/esm/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.js +35 -12
  21. package/esm/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.selectors.d.ts +4 -0
  22. package/esm/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.types.d.ts +40 -16
  23. package/esm/internals/plugins/useTreeViewItems/useTreeViewItems.js +157 -16
  24. package/esm/internals/plugins/useTreeViewItems/useTreeViewItems.selectors.d.ts +172 -0
  25. package/esm/internals/plugins/useTreeViewItems/useTreeViewItems.selectors.js +13 -0
  26. package/esm/internals/plugins/useTreeViewItems/useTreeViewItems.types.d.ts +49 -0
  27. package/esm/internals/plugins/useTreeViewJSXItems/useTreeViewJSXItems.js +2 -2
  28. package/esm/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.js +16 -7
  29. package/esm/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.types.d.ts +2 -1
  30. package/esm/internals/plugins/useTreeViewLazyLoading/index.d.ts +1 -0
  31. package/esm/internals/plugins/useTreeViewLazyLoading/index.js +1 -0
  32. package/esm/internals/plugins/useTreeViewLazyLoading/useTreeViewLazyLoading.selectors.d.ts +249 -0
  33. package/esm/internals/plugins/useTreeViewLazyLoading/useTreeViewLazyLoading.selectors.js +27 -0
  34. package/esm/internals/plugins/useTreeViewLazyLoading/useTreeViewLazyLoading.types.d.ts +83 -0
  35. package/esm/internals/plugins/useTreeViewLazyLoading/useTreeViewLazyLoading.types.js +1 -0
  36. package/esm/internals/plugins/useTreeViewSelection/useTreeViewSelection.js +4 -4
  37. package/esm/internals/plugins/useTreeViewSelection/useTreeViewSelection.types.d.ts +12 -12
  38. package/esm/internals/utils/selectors.d.ts +7 -0
  39. package/esm/internals/utils/selectors.js +9 -0
  40. package/esm/useTreeItem/useTreeItem.d.ts +1 -1
  41. package/esm/useTreeItem/useTreeItem.js +13 -0
  42. package/esm/useTreeItem/useTreeItem.types.d.ts +21 -0
  43. package/esm/utils/cache.d.ts +38 -0
  44. package/esm/utils/cache.js +31 -0
  45. package/esm/utils/index.d.ts +1 -0
  46. package/esm/utils/index.js +1 -0
  47. package/hooks/useTreeItemUtils/useTreeItemUtils.d.ts +3 -2
  48. package/hooks/useTreeItemUtils/useTreeItemUtils.js +22 -10
  49. package/hooks/useTreeViewApiRef.d.ts +1 -1
  50. package/index.js +1 -1
  51. package/internals/index.d.ts +6 -1
  52. package/internals/index.js +33 -0
  53. package/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.js +35 -12
  54. package/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.selectors.d.ts +4 -0
  55. package/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.types.d.ts +40 -16
  56. package/internals/plugins/useTreeViewItems/useTreeViewItems.js +157 -16
  57. package/internals/plugins/useTreeViewItems/useTreeViewItems.selectors.d.ts +172 -0
  58. package/internals/plugins/useTreeViewItems/useTreeViewItems.selectors.js +14 -1
  59. package/internals/plugins/useTreeViewItems/useTreeViewItems.types.d.ts +49 -0
  60. package/internals/plugins/useTreeViewJSXItems/useTreeViewJSXItems.js +1 -1
  61. package/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.js +16 -7
  62. package/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.types.d.ts +2 -1
  63. package/internals/plugins/useTreeViewLazyLoading/index.d.ts +1 -0
  64. package/internals/plugins/useTreeViewLazyLoading/index.js +5 -0
  65. package/internals/plugins/useTreeViewLazyLoading/useTreeViewLazyLoading.selectors.d.ts +249 -0
  66. package/internals/plugins/useTreeViewLazyLoading/useTreeViewLazyLoading.selectors.js +33 -0
  67. package/internals/plugins/useTreeViewLazyLoading/useTreeViewLazyLoading.types.d.ts +83 -0
  68. package/internals/plugins/useTreeViewLazyLoading/useTreeViewLazyLoading.types.js +5 -0
  69. package/internals/plugins/useTreeViewSelection/useTreeViewSelection.js +4 -4
  70. package/internals/plugins/useTreeViewSelection/useTreeViewSelection.types.d.ts +12 -12
  71. package/internals/utils/selectors.d.ts +7 -0
  72. package/internals/utils/selectors.js +9 -0
  73. package/modern/RichTreeView/RichTreeView.js +24 -5
  74. package/modern/SimpleTreeView/SimpleTreeView.js +8 -6
  75. package/modern/TreeItem/TreeItem.d.ts +2 -0
  76. package/modern/TreeItem/TreeItem.js +45 -4
  77. package/modern/TreeItem/TreeItem.types.d.ts +14 -0
  78. package/modern/TreeItemIcon/TreeItemIcon.js +2 -0
  79. package/modern/hooks/useTreeItemUtils/useTreeItemUtils.d.ts +3 -2
  80. package/modern/hooks/useTreeItemUtils/useTreeItemUtils.js +21 -9
  81. package/modern/hooks/useTreeViewApiRef.d.ts +1 -1
  82. package/modern/index.js +1 -1
  83. package/modern/internals/index.d.ts +6 -1
  84. package/modern/internals/index.js +4 -1
  85. package/modern/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.js +35 -12
  86. package/modern/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.selectors.d.ts +4 -0
  87. package/modern/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.types.d.ts +40 -16
  88. package/modern/internals/plugins/useTreeViewItems/useTreeViewItems.js +157 -16
  89. package/modern/internals/plugins/useTreeViewItems/useTreeViewItems.selectors.d.ts +172 -0
  90. package/modern/internals/plugins/useTreeViewItems/useTreeViewItems.selectors.js +13 -0
  91. package/modern/internals/plugins/useTreeViewItems/useTreeViewItems.types.d.ts +49 -0
  92. package/modern/internals/plugins/useTreeViewJSXItems/useTreeViewJSXItems.js +2 -2
  93. package/modern/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.js +16 -7
  94. package/modern/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.types.d.ts +2 -1
  95. package/modern/internals/plugins/useTreeViewLazyLoading/index.d.ts +1 -0
  96. package/modern/internals/plugins/useTreeViewLazyLoading/index.js +1 -0
  97. package/modern/internals/plugins/useTreeViewLazyLoading/useTreeViewLazyLoading.selectors.d.ts +249 -0
  98. package/modern/internals/plugins/useTreeViewLazyLoading/useTreeViewLazyLoading.selectors.js +27 -0
  99. package/modern/internals/plugins/useTreeViewLazyLoading/useTreeViewLazyLoading.types.d.ts +83 -0
  100. package/modern/internals/plugins/useTreeViewLazyLoading/useTreeViewLazyLoading.types.js +1 -0
  101. package/modern/internals/plugins/useTreeViewSelection/useTreeViewSelection.js +4 -4
  102. package/modern/internals/plugins/useTreeViewSelection/useTreeViewSelection.types.d.ts +12 -12
  103. package/modern/internals/utils/selectors.d.ts +7 -0
  104. package/modern/internals/utils/selectors.js +9 -0
  105. package/modern/useTreeItem/useTreeItem.d.ts +1 -1
  106. package/modern/useTreeItem/useTreeItem.js +13 -0
  107. package/modern/useTreeItem/useTreeItem.types.d.ts +21 -0
  108. package/modern/utils/cache.d.ts +38 -0
  109. package/modern/utils/cache.js +31 -0
  110. package/modern/utils/index.d.ts +1 -0
  111. package/modern/utils/index.js +1 -0
  112. package/package.json +1 -1
  113. package/tsconfig.build.tsbuildinfo +1 -1
  114. package/useTreeItem/useTreeItem.d.ts +1 -1
  115. package/useTreeItem/useTreeItem.js +13 -0
  116. package/useTreeItem/useTreeItem.types.d.ts +21 -0
  117. package/utils/cache.d.ts +38 -0
  118. package/utils/cache.js +38 -0
  119. package/utils/index.d.ts +1 -0
  120. package/utils/index.js +16 -0
@@ -16,12 +16,24 @@ var _useTreeViewItems2 = require("./useTreeViewItems.selectors");
16
16
  var _useTreeViewId = require("../../corePlugins/useTreeViewId/useTreeViewId.selectors");
17
17
  var _useTreeViewId2 = require("../../corePlugins/useTreeViewId/useTreeViewId.utils");
18
18
  var _jsxRuntime = require("react/jsx-runtime");
19
- const updateItemsState = ({
19
+ const checkId = (id, item, itemMetaLookup) => {
20
+ if (id == null) {
21
+ throw new Error(['MUI X: The Tree View component requires all items to have a unique `id` property.', 'Alternatively, you can use the `getItemId` prop to specify a custom id for each item.', 'An item was provided without id in the `items` prop:', JSON.stringify(item)].join('\n'));
22
+ }
23
+ if (itemMetaLookup[id] != null) {
24
+ throw new Error(['MUI X: The Tree View component requires all items to have a unique `id` property.', 'Alternatively, you can use the `getItemId` prop to specify a custom id for each item.', `Two items were provided with the same id in the \`items\` prop: "${id}"`].join('\n'));
25
+ }
26
+ };
27
+ const processItemsLookups = ({
20
28
  disabledItemsFocusable,
21
29
  items,
22
30
  isItemDisabled,
23
31
  getItemLabel,
24
- getItemId
32
+ getItemId,
33
+ initialDepth = 0,
34
+ initialParentId = null,
35
+ getChildrenCount,
36
+ ignoreChildren = false
25
37
  }) => {
26
38
  const itemMetaLookup = {};
27
39
  const itemModelLookup = {};
@@ -30,12 +42,7 @@ const updateItemsState = ({
30
42
  };
31
43
  const processItem = (item, depth, parentId) => {
32
44
  const id = getItemId ? getItemId(item) : item.id;
33
- if (id == null) {
34
- throw new Error(['MUI X: The Tree View component requires all items to have a unique `id` property.', 'Alternatively, you can use the `getItemId` prop to specify a custom id for each item.', 'An item was provided without id in the `items` prop:', JSON.stringify(item)].join('\n'));
35
- }
36
- if (itemMetaLookup[id] != null) {
37
- throw new Error(['MUI X: The Tree View component requires all items to have a unique `id` property.', 'Alternatively, you can use the `getItemId` prop to specify a custom id for each item.', `Two items were provided with the same id in the \`items\` prop: "${id}"`].join('\n'));
38
- }
45
+ checkId(id, item, itemMetaLookup);
39
46
  const label = getItemLabel ? getItemLabel(item) : item.label;
40
47
  if (label == null) {
41
48
  throw new Error(['MUI X: The Tree View component requires all items to have a `label` property.', 'Alternatively, you can use the `getItemLabel` prop to specify a custom label for each item.', 'An item was provided without label in the `items` prop:', JSON.stringify(item)].join('\n'));
@@ -45,7 +52,7 @@ const updateItemsState = ({
45
52
  label,
46
53
  parentId,
47
54
  idAttribute: undefined,
48
- expandable: !!item.children?.length,
55
+ expandable: getChildrenCount ? getChildrenCount(item) > 0 : !!item.children?.length,
49
56
  disabled: isItemDisabled ? isItemDisabled(item) : false,
50
57
  depth
51
58
  };
@@ -55,9 +62,13 @@ const updateItemsState = ({
55
62
  itemOrderedChildrenIdsLookup[parentIdWithDefault] = [];
56
63
  }
57
64
  itemOrderedChildrenIdsLookup[parentIdWithDefault].push(id);
58
- item.children?.forEach(child => processItem(child, depth + 1, id));
65
+
66
+ // if lazy loading is enabled, we don't want to process children passed through the `items` prop
67
+ if (!ignoreChildren) {
68
+ item.children?.forEach(child => processItem(child, depth + 1, id));
69
+ }
59
70
  };
60
- items.forEach(item => processItem(item, 0, null));
71
+ items?.forEach(item => processItem(item, initialDepth, initialParentId));
61
72
  const itemChildrenIndexesLookup = {};
62
73
  Object.keys(itemOrderedChildrenIdsLookup).forEach(parentId => {
63
74
  itemChildrenIndexesLookup[parentId] = (0, _useTreeViewItems.buildSiblingIndexes)(itemOrderedChildrenIdsLookup[parentId]);
@@ -76,6 +87,43 @@ const useTreeViewItems = ({
76
87
  store
77
88
  }) => {
78
89
  const getItem = React.useCallback(itemId => (0, _useTreeViewItems2.selectorItemModel)(store.value, itemId), [store]);
90
+ const getParentId = React.useCallback(itemId => {
91
+ const itemMeta = (0, _useTreeViewItems2.selectorItemMeta)(store.value, itemId);
92
+ return itemMeta?.parentId || null;
93
+ }, [store]);
94
+ const setTreeViewLoading = (0, _useEventCallback.default)(isLoading => {
95
+ store.update(prevState => (0, _extends2.default)({}, prevState, {
96
+ items: (0, _extends2.default)({}, prevState.items, {
97
+ loading: isLoading
98
+ })
99
+ }));
100
+ });
101
+ const setTreeViewError = (0, _useEventCallback.default)(error => {
102
+ store.update(prevState => (0, _extends2.default)({}, prevState, {
103
+ items: (0, _extends2.default)({}, prevState.items, {
104
+ error
105
+ })
106
+ }));
107
+ });
108
+ const setIsItemDisabled = (0, _useEventCallback.default)(({
109
+ itemId,
110
+ shouldBeDisabled
111
+ }) => {
112
+ store.update(prevState => {
113
+ if (!prevState.items.itemMetaLookup[itemId]) {
114
+ return prevState;
115
+ }
116
+ const itemMetaLookup = (0, _extends2.default)({}, prevState.items.itemMetaLookup);
117
+ itemMetaLookup[itemId] = (0, _extends2.default)({}, itemMetaLookup[itemId], {
118
+ disabled: shouldBeDisabled ?? !itemMetaLookup[itemId].disabled
119
+ });
120
+ return (0, _extends2.default)({}, prevState, {
121
+ items: (0, _extends2.default)({}, prevState.items, {
122
+ itemMetaLookup
123
+ })
124
+ });
125
+ });
126
+ });
79
127
  const getItemTree = React.useCallback(() => {
80
128
  const getItemFromItemId = itemId => {
81
129
  const item = (0, _useTreeViewItems2.selectorItemModel)(store.value, itemId);
@@ -107,12 +155,96 @@ const useTreeViewItems = ({
107
155
  areItemUpdatesPreventedRef.current = true;
108
156
  }, []);
109
157
  const areItemUpdatesPrevented = React.useCallback(() => areItemUpdatesPreventedRef.current, []);
158
+ const addItems = ({
159
+ items,
160
+ parentId,
161
+ depth,
162
+ getChildrenCount
163
+ }) => {
164
+ if (items) {
165
+ const newState = processItemsLookups({
166
+ disabledItemsFocusable: params.disabledItemsFocusable,
167
+ items,
168
+ isItemDisabled: params.isItemDisabled,
169
+ getItemId: params.getItemId,
170
+ getItemLabel: params.getItemLabel,
171
+ getChildrenCount,
172
+ initialDepth: depth,
173
+ initialParentId: parentId,
174
+ ignoreChildren: true
175
+ });
176
+ store.update(prevState => {
177
+ let newItems;
178
+ if (parentId) {
179
+ newItems = {
180
+ itemModelLookup: (0, _extends2.default)({}, prevState.items.itemModelLookup, newState.itemModelLookup),
181
+ itemMetaLookup: (0, _extends2.default)({}, prevState.items.itemMetaLookup, newState.itemMetaLookup),
182
+ itemOrderedChildrenIdsLookup: (0, _extends2.default)({}, newState.itemOrderedChildrenIdsLookup, prevState.items.itemOrderedChildrenIdsLookup),
183
+ itemChildrenIndexesLookup: (0, _extends2.default)({}, newState.itemChildrenIndexesLookup, prevState.items.itemChildrenIndexesLookup)
184
+ };
185
+ } else {
186
+ newItems = {
187
+ itemModelLookup: newState.itemModelLookup,
188
+ itemMetaLookup: newState.itemMetaLookup,
189
+ itemOrderedChildrenIdsLookup: newState.itemOrderedChildrenIdsLookup,
190
+ itemChildrenIndexesLookup: newState.itemChildrenIndexesLookup
191
+ };
192
+ }
193
+ Object.values(prevState.items.itemMetaLookup).forEach(item => {
194
+ if (!newState.itemMetaLookup[item.id]) {
195
+ (0, _publishTreeViewEvent.publishTreeViewEvent)(instance, 'removeItem', {
196
+ id: item.id
197
+ });
198
+ }
199
+ });
200
+ return (0, _extends2.default)({}, prevState, {
201
+ items: (0, _extends2.default)({}, prevState.items, newItems)
202
+ });
203
+ });
204
+ }
205
+ };
206
+ const removeChildren = parentId => {
207
+ store.update(prevState => {
208
+ if (!parentId) {
209
+ return (0, _extends2.default)({}, prevState, {
210
+ items: (0, _extends2.default)({}, prevState.items, {
211
+ itemMetaLookup: {},
212
+ itemOrderedChildrenIdsLookup: {},
213
+ itemChildrenIndexesLookup: {}
214
+ })
215
+ });
216
+ }
217
+ const newMetaMap = Object.keys(prevState.items.itemMetaLookup).reduce((acc, key) => {
218
+ const item = prevState.items.itemMetaLookup[key];
219
+ if (item.parentId === parentId) {
220
+ (0, _publishTreeViewEvent.publishTreeViewEvent)(instance, 'removeItem', {
221
+ id: item.id
222
+ });
223
+ return acc;
224
+ }
225
+ return (0, _extends2.default)({}, acc, {
226
+ [item.id]: item
227
+ });
228
+ }, {});
229
+ const newItemOrderedChildrenIdsLookup = prevState.items.itemOrderedChildrenIdsLookup;
230
+ const newItemChildrenIndexesLookup = prevState.items.itemChildrenIndexesLookup;
231
+ delete newItemChildrenIndexesLookup[parentId];
232
+ delete newItemOrderedChildrenIdsLookup[parentId];
233
+ return (0, _extends2.default)({}, prevState, {
234
+ items: (0, _extends2.default)({}, prevState.items, {
235
+ itemMetaLookup: newMetaMap,
236
+ itemOrderedChildrenIdsLookup: newItemOrderedChildrenIdsLookup,
237
+ itemChildrenIndexesLookup: newItemChildrenIndexesLookup
238
+ })
239
+ });
240
+ });
241
+ };
110
242
  React.useEffect(() => {
111
243
  if (instance.areItemUpdatesPrevented()) {
112
244
  return;
113
245
  }
114
246
  store.update(prevState => {
115
- const newState = updateItemsState({
247
+ const newState = processItemsLookups({
116
248
  disabledItemsFocusable: params.disabledItemsFocusable,
117
249
  items: params.items,
118
250
  isItemDisabled: params.isItemDisabled,
@@ -127,7 +259,7 @@ const useTreeViewItems = ({
127
259
  }
128
260
  });
129
261
  return (0, _extends2.default)({}, prevState, {
130
- items: newState
262
+ items: (0, _extends2.default)({}, prevState.items, newState)
131
263
  });
132
264
  });
133
265
  }, [instance, store, params.items, params.disabledItemsFocusable, params.isItemDisabled, params.getItemId, params.getItemLabel]);
@@ -153,24 +285,33 @@ const useTreeViewItems = ({
153
285
  getItem,
154
286
  getItemDOMElement,
155
287
  getItemTree,
156
- getItemOrderedChildrenIds
288
+ getItemOrderedChildrenIds,
289
+ setIsItemDisabled,
290
+ getParentId
157
291
  },
158
292
  instance: {
159
293
  getItemDOMElement,
160
294
  preventItemUpdates,
161
- areItemUpdatesPrevented
295
+ areItemUpdatesPrevented,
296
+ addItems,
297
+ setTreeViewLoading,
298
+ setTreeViewError,
299
+ removeChildren
162
300
  },
163
301
  contextValue: pluginContextValue
164
302
  };
165
303
  };
166
304
  exports.useTreeViewItems = useTreeViewItems;
167
305
  useTreeViewItems.getInitialState = params => ({
168
- items: updateItemsState({
306
+ items: (0, _extends2.default)({}, processItemsLookups({
169
307
  disabledItemsFocusable: params.disabledItemsFocusable,
170
308
  items: params.items,
171
309
  isItemDisabled: params.isItemDisabled,
172
310
  getItemId: params.getItemId,
173
311
  getItemLabel: params.getItemLabel
312
+ }), {
313
+ loading: false,
314
+ error: null
174
315
  })
175
316
  });
176
317
  useTreeViewItems.getDefaultizedParams = ({
@@ -1,6 +1,134 @@
1
1
  import { TreeViewItemMeta } from "../../models/index.js";
2
2
  import { TreeViewRootSelector } from "../../utils/selectors.js";
3
3
  import { UseTreeViewItemsSignature } from "./useTreeViewItems.types.js";
4
+ /**
5
+ * Get the loading state for the Tree View.
6
+ * @param {TreeViewState<[UseTreeViewItemsSignature]>} state The state of the tree view.
7
+ * @returns {boolean} The loading state for the Tree View.
8
+ */
9
+ export declare const selectorIsTreeViewLoading: ((state: import("../../corePlugins/useTreeViewId/useTreeViewId.types").UseTreeViewIdState & import("./useTreeViewItems.types").UseTreeViewItemsState<import("../../..").TreeViewDefaultItemModelProperties> & Partial<{}> & {
10
+ cacheKey: import("../../models").TreeViewStateCacheKey;
11
+ }) => boolean) & {
12
+ clearCache: () => void;
13
+ resultsCount: () => number;
14
+ resetResultsCount: () => void;
15
+ } & {
16
+ resultFunc: (resultFuncArgs_0: {
17
+ disabledItemsFocusable: boolean;
18
+ itemModelLookup: {
19
+ [itemId: string]: import("../../..").TreeViewBaseItem<import("../../..").TreeViewDefaultItemModelProperties>;
20
+ };
21
+ itemMetaLookup: {
22
+ [itemId: string]: TreeViewItemMeta;
23
+ };
24
+ itemOrderedChildrenIdsLookup: {
25
+ [parentItemId: string]: string[];
26
+ };
27
+ itemChildrenIndexesLookup: {
28
+ [parentItemId: string]: {
29
+ [itemId: string]: number;
30
+ };
31
+ };
32
+ loading: boolean;
33
+ error: Error | null;
34
+ }) => boolean;
35
+ memoizedResultFunc: ((resultFuncArgs_0: {
36
+ disabledItemsFocusable: boolean;
37
+ itemModelLookup: {
38
+ [itemId: string]: import("../../..").TreeViewBaseItem<import("../../..").TreeViewDefaultItemModelProperties>;
39
+ };
40
+ itemMetaLookup: {
41
+ [itemId: string]: TreeViewItemMeta;
42
+ };
43
+ itemOrderedChildrenIdsLookup: {
44
+ [parentItemId: string]: string[];
45
+ };
46
+ itemChildrenIndexesLookup: {
47
+ [parentItemId: string]: {
48
+ [itemId: string]: number;
49
+ };
50
+ };
51
+ loading: boolean;
52
+ error: Error | null;
53
+ }) => boolean) & {
54
+ clearCache: () => void;
55
+ resultsCount: () => number;
56
+ resetResultsCount: () => void;
57
+ };
58
+ lastResult: () => boolean;
59
+ dependencies: [TreeViewRootSelector<UseTreeViewItemsSignature>];
60
+ recomputations: () => number;
61
+ resetRecomputations: () => void;
62
+ dependencyRecomputations: () => number;
63
+ resetDependencyRecomputations: () => void;
64
+ } & {
65
+ argsMemoize: typeof import("reselect").weakMapMemoize;
66
+ memoize: typeof import("reselect").weakMapMemoize;
67
+ };
68
+ /**
69
+ * Get the error state for the Tree View.
70
+ * @param {TreeViewState<[UseTreeViewItemsSignature]>} state The state of the tree view.
71
+ * @returns {boolean} The error state for the Tree View.
72
+ */
73
+ export declare const selectorGetTreeViewError: ((state: import("../../corePlugins/useTreeViewId/useTreeViewId.types").UseTreeViewIdState & import("./useTreeViewItems.types").UseTreeViewItemsState<import("../../..").TreeViewDefaultItemModelProperties> & Partial<{}> & {
74
+ cacheKey: import("../../models").TreeViewStateCacheKey;
75
+ }) => Error | null) & {
76
+ clearCache: () => void;
77
+ resultsCount: () => number;
78
+ resetResultsCount: () => void;
79
+ } & {
80
+ resultFunc: (resultFuncArgs_0: {
81
+ disabledItemsFocusable: boolean;
82
+ itemModelLookup: {
83
+ [itemId: string]: import("../../..").TreeViewBaseItem<import("../../..").TreeViewDefaultItemModelProperties>;
84
+ };
85
+ itemMetaLookup: {
86
+ [itemId: string]: TreeViewItemMeta;
87
+ };
88
+ itemOrderedChildrenIdsLookup: {
89
+ [parentItemId: string]: string[];
90
+ };
91
+ itemChildrenIndexesLookup: {
92
+ [parentItemId: string]: {
93
+ [itemId: string]: number;
94
+ };
95
+ };
96
+ loading: boolean;
97
+ error: Error | null;
98
+ }) => Error | null;
99
+ memoizedResultFunc: ((resultFuncArgs_0: {
100
+ disabledItemsFocusable: boolean;
101
+ itemModelLookup: {
102
+ [itemId: string]: import("../../..").TreeViewBaseItem<import("../../..").TreeViewDefaultItemModelProperties>;
103
+ };
104
+ itemMetaLookup: {
105
+ [itemId: string]: TreeViewItemMeta;
106
+ };
107
+ itemOrderedChildrenIdsLookup: {
108
+ [parentItemId: string]: string[];
109
+ };
110
+ itemChildrenIndexesLookup: {
111
+ [parentItemId: string]: {
112
+ [itemId: string]: number;
113
+ };
114
+ };
115
+ loading: boolean;
116
+ error: Error | null;
117
+ }) => Error | null) & {
118
+ clearCache: () => void;
119
+ resultsCount: () => number;
120
+ resetResultsCount: () => void;
121
+ };
122
+ lastResult: () => Error | null;
123
+ dependencies: [TreeViewRootSelector<UseTreeViewItemsSignature>];
124
+ recomputations: () => number;
125
+ resetRecomputations: () => void;
126
+ dependencyRecomputations: () => number;
127
+ resetDependencyRecomputations: () => void;
128
+ } & {
129
+ argsMemoize: typeof import("reselect").weakMapMemoize;
130
+ memoize: typeof import("reselect").weakMapMemoize;
131
+ };
4
132
  /**
5
133
  * Get the meta-information of all items.
6
134
  * @param {TreeViewState<[UseTreeViewItemsSignature]>} state The state of the tree view.
@@ -31,6 +159,8 @@ export declare const selectorItemMetaLookup: ((state: import("../../corePlugins/
31
159
  [itemId: string]: number;
32
160
  };
33
161
  };
162
+ loading: boolean;
163
+ error: Error | null;
34
164
  }) => {
35
165
  [itemId: string]: TreeViewItemMeta;
36
166
  };
@@ -50,6 +180,8 @@ export declare const selectorItemMetaLookup: ((state: import("../../corePlugins/
50
180
  [itemId: string]: number;
51
181
  };
52
182
  };
183
+ loading: boolean;
184
+ error: Error | null;
53
185
  }) => {
54
186
  [itemId: string]: TreeViewItemMeta;
55
187
  }) & {
@@ -96,6 +228,8 @@ export declare const selectorItemOrderedChildrenIds: ((state: any, itemId: strin
96
228
  [itemId: string]: number;
97
229
  };
98
230
  };
231
+ loading: boolean;
232
+ error: Error | null;
99
233
  }, resultFuncArgs_1: string | null) => string[];
100
234
  memoizedResultFunc: ((resultFuncArgs_0: {
101
235
  disabledItemsFocusable: boolean;
@@ -113,6 +247,8 @@ export declare const selectorItemOrderedChildrenIds: ((state: any, itemId: strin
113
247
  [itemId: string]: number;
114
248
  };
115
249
  };
250
+ loading: boolean;
251
+ error: Error | null;
116
252
  }, resultFuncArgs_1: string | null) => string[]) & {
117
253
  clearCache: () => void;
118
254
  resultsCount: () => number;
@@ -155,6 +291,8 @@ export declare const selectorItemModel: ((state: any, itemId: string) => import(
155
291
  [itemId: string]: number;
156
292
  };
157
293
  };
294
+ loading: boolean;
295
+ error: Error | null;
158
296
  }, resultFuncArgs_1: string) => import("../../..").TreeViewBaseItem<import("../../..").TreeViewDefaultItemModelProperties>;
159
297
  memoizedResultFunc: ((resultFuncArgs_0: {
160
298
  disabledItemsFocusable: boolean;
@@ -172,6 +310,8 @@ export declare const selectorItemModel: ((state: any, itemId: string) => import(
172
310
  [itemId: string]: number;
173
311
  };
174
312
  };
313
+ loading: boolean;
314
+ error: Error | null;
175
315
  }, resultFuncArgs_1: string) => import("../../..").TreeViewBaseItem<import("../../..").TreeViewDefaultItemModelProperties>) & {
176
316
  clearCache: () => void;
177
317
  resultsCount: () => number;
@@ -235,6 +375,8 @@ export declare const selectorItemMeta: ((state: any, itemId: string | null) => T
235
375
  [itemId: string]: number;
236
376
  };
237
377
  };
378
+ loading: boolean;
379
+ error: Error | null;
238
380
  }) => {
239
381
  [itemId: string]: TreeViewItemMeta;
240
382
  };
@@ -254,6 +396,8 @@ export declare const selectorItemMeta: ((state: any, itemId: string | null) => T
254
396
  [itemId: string]: number;
255
397
  };
256
398
  };
399
+ loading: boolean;
400
+ error: Error | null;
257
401
  }) => {
258
402
  [itemId: string]: TreeViewItemMeta;
259
403
  }) & {
@@ -328,6 +472,8 @@ export declare const selectorIsItemDisabled: ((state: any, itemId: string) => bo
328
472
  [itemId: string]: number;
329
473
  };
330
474
  };
475
+ loading: boolean;
476
+ error: Error | null;
331
477
  }) => {
332
478
  [itemId: string]: TreeViewItemMeta;
333
479
  };
@@ -347,6 +493,8 @@ export declare const selectorIsItemDisabled: ((state: any, itemId: string) => bo
347
493
  [itemId: string]: number;
348
494
  };
349
495
  };
496
+ loading: boolean;
497
+ error: Error | null;
350
498
  }) => {
351
499
  [itemId: string]: TreeViewItemMeta;
352
500
  }) & {
@@ -401,6 +549,8 @@ export declare const selectorItemIndex: ((state: any, itemId: string | null) =>
401
549
  [itemId: string]: number;
402
550
  };
403
551
  };
552
+ loading: boolean;
553
+ error: Error | null;
404
554
  }, resultFuncArgs_1: TreeViewItemMeta | null) => number;
405
555
  memoizedResultFunc: ((resultFuncArgs_0: {
406
556
  disabledItemsFocusable: boolean;
@@ -418,6 +568,8 @@ export declare const selectorItemIndex: ((state: any, itemId: string | null) =>
418
568
  [itemId: string]: number;
419
569
  };
420
570
  };
571
+ loading: boolean;
572
+ error: Error | null;
421
573
  }, resultFuncArgs_1: TreeViewItemMeta | null) => number) & {
422
574
  clearCache: () => void;
423
575
  resultsCount: () => number;
@@ -465,6 +617,8 @@ export declare const selectorItemIndex: ((state: any, itemId: string | null) =>
465
617
  [itemId: string]: number;
466
618
  };
467
619
  };
620
+ loading: boolean;
621
+ error: Error | null;
468
622
  }) => {
469
623
  [itemId: string]: TreeViewItemMeta;
470
624
  };
@@ -484,6 +638,8 @@ export declare const selectorItemIndex: ((state: any, itemId: string | null) =>
484
638
  [itemId: string]: number;
485
639
  };
486
640
  };
641
+ loading: boolean;
642
+ error: Error | null;
487
643
  }) => {
488
644
  [itemId: string]: TreeViewItemMeta;
489
645
  }) & {
@@ -578,6 +734,8 @@ export declare const selectorItemParentId: ((state: any, itemId: string | null)
578
734
  [itemId: string]: number;
579
735
  };
580
736
  };
737
+ loading: boolean;
738
+ error: Error | null;
581
739
  }) => {
582
740
  [itemId: string]: TreeViewItemMeta;
583
741
  };
@@ -597,6 +755,8 @@ export declare const selectorItemParentId: ((state: any, itemId: string | null)
597
755
  [itemId: string]: number;
598
756
  };
599
757
  };
758
+ loading: boolean;
759
+ error: Error | null;
600
760
  }) => {
601
761
  [itemId: string]: TreeViewItemMeta;
602
762
  }) & {
@@ -691,6 +851,8 @@ export declare const selectorItemDepth: ((state: any, itemId: string | null) =>
691
851
  [itemId: string]: number;
692
852
  };
693
853
  };
854
+ loading: boolean;
855
+ error: Error | null;
694
856
  }) => {
695
857
  [itemId: string]: TreeViewItemMeta;
696
858
  };
@@ -710,6 +872,8 @@ export declare const selectorItemDepth: ((state: any, itemId: string | null) =>
710
872
  [itemId: string]: number;
711
873
  };
712
874
  };
875
+ loading: boolean;
876
+ error: Error | null;
713
877
  }) => {
714
878
  [itemId: string]: TreeViewItemMeta;
715
879
  }) & {
@@ -766,6 +930,8 @@ export declare const selectorCanItemBeFocused: ((state: any, itemId: string) =>
766
930
  [itemId: string]: number;
767
931
  };
768
932
  };
933
+ loading: boolean;
934
+ error: Error | null;
769
935
  }, resultFuncArgs_1: boolean) => boolean;
770
936
  memoizedResultFunc: ((resultFuncArgs_0: {
771
937
  disabledItemsFocusable: boolean;
@@ -783,6 +949,8 @@ export declare const selectorCanItemBeFocused: ((state: any, itemId: string) =>
783
949
  [itemId: string]: number;
784
950
  };
785
951
  };
952
+ loading: boolean;
953
+ error: Error | null;
786
954
  }, resultFuncArgs_1: boolean) => boolean) & {
787
955
  clearCache: () => void;
788
956
  resultsCount: () => number;
@@ -830,6 +998,8 @@ export declare const selectorCanItemBeFocused: ((state: any, itemId: string) =>
830
998
  [itemId: string]: number;
831
999
  };
832
1000
  };
1001
+ loading: boolean;
1002
+ error: Error | null;
833
1003
  }) => {
834
1004
  [itemId: string]: TreeViewItemMeta;
835
1005
  };
@@ -849,6 +1019,8 @@ export declare const selectorCanItemBeFocused: ((state: any, itemId: string) =>
849
1019
  [itemId: string]: number;
850
1020
  };
851
1021
  };
1022
+ loading: boolean;
1023
+ error: Error | null;
852
1024
  }) => {
853
1025
  [itemId: string]: TreeViewItemMeta;
854
1026
  }) & {
@@ -3,11 +3,24 @@
3
3
  Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
- exports.selectorItemParentId = exports.selectorItemOrderedChildrenIds = exports.selectorItemModel = exports.selectorItemMetaLookup = exports.selectorItemMeta = exports.selectorItemIndex = exports.selectorItemDepth = exports.selectorIsItemDisabled = exports.selectorCanItemBeFocused = void 0;
6
+ exports.selectorItemParentId = exports.selectorItemOrderedChildrenIds = exports.selectorItemModel = exports.selectorItemMetaLookup = exports.selectorItemMeta = exports.selectorItemIndex = exports.selectorItemDepth = exports.selectorIsTreeViewLoading = exports.selectorIsItemDisabled = exports.selectorGetTreeViewError = exports.selectorCanItemBeFocused = void 0;
7
7
  var _selectors = require("../../utils/selectors");
8
8
  var _useTreeViewItems = require("./useTreeViewItems.utils");
9
9
  const selectorTreeViewItemsState = state => state.items;
10
10
 
11
+ /**
12
+ * Get the loading state for the Tree View.
13
+ * @param {TreeViewState<[UseTreeViewItemsSignature]>} state The state of the tree view.
14
+ * @returns {boolean} The loading state for the Tree View.
15
+ */
16
+ const selectorIsTreeViewLoading = exports.selectorIsTreeViewLoading = (0, _selectors.createSelector)(selectorTreeViewItemsState, items => items.loading);
17
+ /**
18
+ * Get the error state for the Tree View.
19
+ * @param {TreeViewState<[UseTreeViewItemsSignature]>} state The state of the tree view.
20
+ * @returns {boolean} The error state for the Tree View.
21
+ */
22
+ const selectorGetTreeViewError = exports.selectorGetTreeViewError = (0, _selectors.createSelector)(selectorTreeViewItemsState, items => items.error);
23
+
11
24
  /**
12
25
  * Get the meta-information of all items.
13
26
  * @param {TreeViewState<[UseTreeViewItemsSignature]>} state The state of the tree view.
@@ -2,6 +2,12 @@ import * as React from 'react';
2
2
  import { DefaultizedProps } from '@mui/x-internals/types';
3
3
  import { TreeViewItemMeta, TreeViewPluginSignature } from "../../models/index.js";
4
4
  import { TreeViewBaseItem, TreeViewDefaultItemModelProperties, TreeViewItemId } from "../../../models/index.js";
5
+ export type AddItemsParameters<R> = {
6
+ items: readonly R[];
7
+ parentId?: TreeViewItemId;
8
+ depth: number;
9
+ getChildrenCount?: (item: R) => number;
10
+ };
5
11
  export interface UseTreeViewItemsPublicAPI<R extends {}> {
6
12
  /**
7
13
  * Get the item with the given id.
@@ -29,6 +35,21 @@ export interface UseTreeViewItemsPublicAPI<R extends {}> {
29
35
  * @returns {TreeViewBaseItem[]} The items in the tree.
30
36
  */
31
37
  getItemTree: () => TreeViewBaseItem[];
38
+ /**
39
+ * Toggle the disabled state of the item with the given id.
40
+ * @param {object} parameters The params of the method.
41
+ * @param {TreeViewItemId } parameters.itemId The id of the item to get the children of.
42
+ * @param {boolean } parameters.shouldBeDisabled true if the item should be disabled.
43
+ */
44
+ setIsItemDisabled: (parameters: {
45
+ itemId: TreeViewItemId;
46
+ shouldBeDisabled?: boolean;
47
+ }) => void;
48
+ /** * Get the id of the parent item.
49
+ * @param {string} itemId The id of the item to whose parentId we want to retrieve.
50
+ * @returns {TreeViewItemId | null} The id of the parent item.
51
+ */
52
+ getParentId: (itemId: TreeViewItemId) => TreeViewItemId | null;
32
53
  }
33
54
  export interface UseTreeViewItemsInstance<R extends {}> extends Pick<UseTreeViewItemsPublicAPI<R>, 'getItemDOMElement'> {
34
55
  /**
@@ -42,6 +63,26 @@ export interface UseTreeViewItemsInstance<R extends {}> extends Pick<UseTreeView
42
63
  * @returns {boolean} `true` if the updates to the state based on the `items` prop are prevented.
43
64
  */
44
65
  areItemUpdatesPrevented: () => boolean;
66
+ /**
67
+ * Add an array of items to the tree.
68
+ * @param {AddItemsParameters<R>} args The items to add to the tree and information about their ancestors.
69
+ */
70
+ addItems: (args: AddItemsParameters<R>) => void;
71
+ /**
72
+ * Remove the children of an item.
73
+ * @param {TreeViewItemId} parentId The id of the item to remove the children of.
74
+ */
75
+ removeChildren: (parentId?: TreeViewItemId) => void;
76
+ /**
77
+ * Set the loading state of the tree.
78
+ * @param {boolean} loading True if the tree view is loading.
79
+ */
80
+ setTreeViewLoading: (loading: boolean) => void;
81
+ /**
82
+ * Set the error state of the tree.
83
+ * @param {Error | null} error The error on the tree view.
84
+ */
85
+ setTreeViewError: (error: Error | null) => void;
45
86
  }
46
87
  export interface UseTreeViewItemsParameters<R extends {
47
88
  children?: R[];
@@ -137,6 +178,14 @@ export interface UseTreeViewItemsState<R extends {}> {
137
178
  [itemId: string]: number;
138
179
  };
139
180
  };
181
+ /**
182
+ * The loading state of the tree.
183
+ */
184
+ loading: boolean;
185
+ /**
186
+ * The error state of the tree.
187
+ */
188
+ error: Error | null;
140
189
  };
141
190
  }
142
191
  interface UseTreeViewItemsContextValue {
@@ -124,7 +124,7 @@ const useTreeViewJSXItemsItemPlugin = ({
124
124
  unregisterChild,
125
125
  parentId
126
126
  } = parentContext;
127
- const expandable = (0, _useTreeItemUtils.isItemExpandable)(children);
127
+ const expandable = (0, _useTreeItemUtils.itemHasChildren)(children);
128
128
  const pluginContentRef = React.useRef(null);
129
129
  const handleContentRef = (0, _useForkRef.default)(pluginContentRef, contentRef);
130
130
  const treeId = (0, _useSelector.useSelector)(store, _useTreeViewId2.selectorTreeViewId);