@mui/x-tree-view 8.0.0-alpha.0 → 8.0.0-alpha.2
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.
- package/CHANGELOG.md +651 -6
- package/README.md +2 -2
- package/RichTreeView/RichTreeView.js +2 -4
- package/RichTreeView/RichTreeView.types.d.ts +5 -18
- package/SimpleTreeView/SimpleTreeView.types.d.ts +2 -2
- package/TreeItem/TreeItem.js +4 -4
- package/TreeItem/TreeItem.types.d.ts +4 -2
- package/TreeItemDragAndDropOverlay/TreeItemDragAndDropOverlay.js +1 -1
- package/TreeItemIcon/TreeItemIcon.types.d.ts +1 -1
- package/TreeItemProvider/TreeItemProvider.d.ts +2 -4
- package/TreeItemProvider/TreeItemProvider.js +26 -11
- package/TreeItemProvider/TreeItemProvider.types.d.ts +1 -0
- package/hooks/index.d.ts +1 -0
- package/hooks/index.js +2 -1
- package/hooks/useTreeItemModel.d.ts +2 -0
- package/hooks/useTreeItemModel.js +11 -0
- package/hooks/useTreeItemUtils/useTreeItemUtils.d.ts +2 -1
- package/hooks/useTreeItemUtils/useTreeItemUtils.js +31 -15
- package/hooks/useTreeViewApiRef.d.ts +1 -0
- package/index.js +1 -1
- package/internals/TreeViewItemDepthContext/TreeViewItemDepthContext.d.ts +3 -1
- package/internals/TreeViewProvider/TreeViewChildrenItemProvider.d.ts +2 -1
- package/internals/TreeViewProvider/TreeViewChildrenItemProvider.js +6 -22
- package/internals/TreeViewProvider/TreeViewProvider.js +1 -2
- package/internals/TreeViewProvider/TreeViewProvider.types.d.ts +4 -2
- package/internals/components/RichTreeViewItems.d.ts +3 -5
- package/internals/components/RichTreeViewItems.js +42 -30
- package/internals/corePlugins/useTreeViewId/useTreeViewId.js +10 -11
- package/internals/corePlugins/useTreeViewId/useTreeViewId.selectors.d.ts +36 -0
- package/internals/corePlugins/useTreeViewId/useTreeViewId.selectors.js +9 -0
- package/internals/corePlugins/useTreeViewId/useTreeViewId.types.d.ts +1 -5
- package/internals/hooks/useSelector.d.ts +4 -0
- package/internals/hooks/useSelector.js +6 -0
- package/internals/index.d.ts +6 -1
- package/internals/index.js +5 -1
- package/internals/models/itemPlugin.d.ts +5 -5
- package/internals/models/plugin.d.ts +20 -8
- package/internals/models/treeView.d.ts +6 -0
- package/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.js +36 -24
- package/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.selectors.d.ts +124 -0
- package/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.selectors.js +17 -0
- package/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.types.d.ts +6 -14
- package/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.utils.d.ts +1 -0
- package/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.utils.js +7 -0
- package/internals/plugins/useTreeViewFocus/useTreeViewFocus.js +62 -40
- package/internals/plugins/useTreeViewFocus/useTreeViewFocus.selectors.d.ts +182 -0
- package/internals/plugins/useTreeViewFocus/useTreeViewFocus.selectors.js +34 -0
- package/internals/plugins/useTreeViewFocus/useTreeViewFocus.types.d.ts +4 -16
- package/internals/plugins/useTreeViewIcons/useTreeViewIcons.js +15 -13
- package/internals/plugins/useTreeViewIcons/useTreeViewIcons.types.d.ts +1 -1
- package/internals/plugins/useTreeViewItems/index.d.ts +1 -1
- package/internals/plugins/useTreeViewItems/useTreeViewItems.js +58 -98
- package/internals/plugins/useTreeViewItems/useTreeViewItems.selectors.d.ts +718 -0
- package/internals/plugins/useTreeViewItems/useTreeViewItems.selectors.js +103 -0
- package/internals/plugins/useTreeViewItems/useTreeViewItems.types.d.ts +15 -52
- package/internals/plugins/useTreeViewJSXItems/useTreeViewJSXItems.js +29 -26
- package/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.js +27 -18
- package/internals/plugins/useTreeViewLabel/useTreeViewLabel.itemPlugin.js +13 -5
- package/internals/plugins/useTreeViewLabel/useTreeViewLabel.js +19 -30
- package/internals/plugins/useTreeViewLabel/useTreeViewLabel.selectors.d.ts +74 -0
- package/internals/plugins/useTreeViewLabel/useTreeViewLabel.selectors.js +26 -0
- package/internals/plugins/useTreeViewLabel/useTreeViewLabel.types.d.ts +7 -24
- package/internals/plugins/useTreeViewSelection/useTreeViewSelection.itemPlugin.js +8 -6
- package/internals/plugins/useTreeViewSelection/useTreeViewSelection.js +45 -34
- package/internals/plugins/useTreeViewSelection/useTreeViewSelection.selectors.d.ts +32 -0
- package/internals/plugins/useTreeViewSelection/useTreeViewSelection.selectors.js +9 -0
- package/internals/plugins/useTreeViewSelection/useTreeViewSelection.types.d.ts +6 -6
- package/internals/plugins/useTreeViewSelection/useTreeViewSelection.utils.d.ts +6 -6
- package/internals/plugins/useTreeViewSelection/useTreeViewSelection.utils.js +23 -13
- package/internals/useTreeView/useTreeView.js +30 -17
- package/internals/useTreeView/useTreeView.types.d.ts +2 -3
- package/internals/useTreeView/useTreeViewBuildContext.d.ts +3 -1
- package/internals/useTreeView/useTreeViewBuildContext.js +24 -18
- package/internals/utils/TreeViewStore.d.ts +12 -0
- package/internals/utils/TreeViewStore.js +24 -0
- package/internals/utils/selectors.d.ts +9 -0
- package/internals/utils/selectors.js +37 -0
- package/internals/utils/tree.d.ts +8 -8
- package/internals/utils/tree.js +51 -43
- package/models/items.d.ts +3 -2
- package/modern/RichTreeView/RichTreeView.js +2 -4
- package/modern/TreeItem/TreeItem.js +4 -4
- package/modern/TreeItemDragAndDropOverlay/TreeItemDragAndDropOverlay.js +1 -1
- package/modern/TreeItemProvider/TreeItemProvider.js +26 -11
- package/modern/hooks/index.js +2 -1
- package/modern/hooks/useTreeItemModel.js +11 -0
- package/modern/hooks/useTreeItemUtils/useTreeItemUtils.js +31 -15
- package/modern/index.js +1 -1
- package/modern/internals/TreeViewProvider/TreeViewChildrenItemProvider.js +6 -22
- package/modern/internals/TreeViewProvider/TreeViewProvider.js +1 -2
- package/modern/internals/components/RichTreeViewItems.js +42 -30
- package/modern/internals/corePlugins/useTreeViewId/useTreeViewId.js +10 -11
- package/modern/internals/corePlugins/useTreeViewId/useTreeViewId.selectors.js +9 -0
- package/modern/internals/hooks/useSelector.js +6 -0
- package/modern/internals/index.js +5 -1
- package/modern/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.js +36 -24
- package/modern/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.selectors.js +17 -0
- package/modern/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.utils.js +7 -0
- package/modern/internals/plugins/useTreeViewFocus/useTreeViewFocus.js +62 -40
- package/modern/internals/plugins/useTreeViewFocus/useTreeViewFocus.selectors.js +34 -0
- package/modern/internals/plugins/useTreeViewIcons/useTreeViewIcons.js +15 -13
- package/modern/internals/plugins/useTreeViewItems/useTreeViewItems.js +58 -98
- package/modern/internals/plugins/useTreeViewItems/useTreeViewItems.selectors.js +103 -0
- package/modern/internals/plugins/useTreeViewJSXItems/useTreeViewJSXItems.js +29 -26
- package/modern/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.js +27 -18
- package/modern/internals/plugins/useTreeViewLabel/useTreeViewLabel.itemPlugin.js +13 -5
- package/modern/internals/plugins/useTreeViewLabel/useTreeViewLabel.js +19 -30
- package/modern/internals/plugins/useTreeViewLabel/useTreeViewLabel.selectors.js +26 -0
- package/modern/internals/plugins/useTreeViewSelection/useTreeViewSelection.itemPlugin.js +8 -6
- package/modern/internals/plugins/useTreeViewSelection/useTreeViewSelection.js +45 -34
- package/modern/internals/plugins/useTreeViewSelection/useTreeViewSelection.selectors.js +9 -0
- package/modern/internals/plugins/useTreeViewSelection/useTreeViewSelection.utils.js +23 -13
- package/modern/internals/useTreeView/useTreeView.js +30 -17
- package/modern/internals/useTreeView/useTreeViewBuildContext.js +24 -18
- package/modern/internals/utils/TreeViewStore.js +24 -0
- package/modern/internals/utils/selectors.js +37 -0
- package/modern/internals/utils/tree.js +51 -43
- package/modern/useTreeItem/useTreeItem.js +26 -11
- package/node/RichTreeView/RichTreeView.js +2 -4
- package/node/TreeItem/TreeItem.js +4 -4
- package/node/TreeItemDragAndDropOverlay/TreeItemDragAndDropOverlay.js +2 -2
- package/node/TreeItemProvider/TreeItemProvider.js +26 -10
- package/node/hooks/index.js +8 -1
- package/node/hooks/useTreeItemModel.js +17 -0
- package/node/hooks/useTreeItemUtils/useTreeItemUtils.js +32 -15
- package/node/index.js +1 -1
- package/node/internals/TreeViewProvider/TreeViewChildrenItemProvider.js +6 -22
- package/node/internals/TreeViewProvider/TreeViewProvider.js +1 -2
- package/node/internals/components/RichTreeViewItems.js +42 -30
- package/node/internals/corePlugins/useTreeViewId/useTreeViewId.js +12 -13
- package/node/internals/corePlugins/useTreeViewId/useTreeViewId.selectors.js +15 -0
- package/node/internals/hooks/useSelector.js +13 -0
- package/node/internals/index.js +47 -1
- package/node/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.js +36 -24
- package/node/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.selectors.js +23 -0
- package/node/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.utils.js +14 -0
- package/node/internals/plugins/useTreeViewFocus/useTreeViewFocus.js +62 -40
- package/node/internals/plugins/useTreeViewFocus/useTreeViewFocus.selectors.js +40 -0
- package/node/internals/plugins/useTreeViewIcons/useTreeViewIcons.js +16 -13
- package/node/internals/plugins/useTreeViewItems/useTreeViewItems.js +60 -100
- package/node/internals/plugins/useTreeViewItems/useTreeViewItems.selectors.js +109 -0
- package/node/internals/plugins/useTreeViewJSXItems/useTreeViewJSXItems.js +30 -27
- package/node/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.js +27 -18
- package/node/internals/plugins/useTreeViewLabel/useTreeViewLabel.itemPlugin.js +13 -5
- package/node/internals/plugins/useTreeViewLabel/useTreeViewLabel.js +19 -30
- package/node/internals/plugins/useTreeViewLabel/useTreeViewLabel.selectors.js +32 -0
- package/node/internals/plugins/useTreeViewSelection/useTreeViewSelection.itemPlugin.js +8 -6
- package/node/internals/plugins/useTreeViewSelection/useTreeViewSelection.js +46 -35
- package/node/internals/plugins/useTreeViewSelection/useTreeViewSelection.selectors.js +15 -0
- package/node/internals/plugins/useTreeViewSelection/useTreeViewSelection.utils.js +24 -14
- package/node/internals/useTreeView/useTreeView.js +30 -17
- package/node/internals/useTreeView/useTreeViewBuildContext.js +25 -18
- package/node/internals/utils/TreeViewStore.js +31 -0
- package/node/internals/utils/selectors.js +44 -0
- package/node/internals/utils/tree.js +51 -43
- package/node/useTreeItem/useTreeItem.js +26 -11
- package/package.json +6 -4
- package/useTreeItem/useTreeItem.js +26 -11
- package/useTreeItem/useTreeItem.types.d.ts +9 -0
|
@@ -1,46 +1,56 @@
|
|
|
1
1
|
import _extends from "@babel/runtime/helpers/esm/extends";
|
|
2
2
|
import * as React from 'react';
|
|
3
3
|
import useEventCallback from '@mui/utils/useEventCallback';
|
|
4
|
-
import ownerDocument from '@mui/utils/ownerDocument';
|
|
5
4
|
import { useInstanceEventHandler } from "../../hooks/useInstanceEventHandler.js";
|
|
6
|
-
import { getActiveElement } from "../../utils/utils.js";
|
|
7
5
|
import { getFirstNavigableItem } from "../../utils/tree.js";
|
|
8
6
|
import { convertSelectedItemsToArray } from "../useTreeViewSelection/useTreeViewSelection.utils.js";
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
return false;
|
|
13
|
-
}
|
|
14
|
-
const itemMeta = instance.getItemMeta(itemId);
|
|
15
|
-
return itemMeta && (itemMeta.parentId == null || instance.isItemExpanded(itemMeta.parentId));
|
|
16
|
-
});
|
|
17
|
-
if (tabbableItemId == null) {
|
|
18
|
-
tabbableItemId = getFirstNavigableItem(instance);
|
|
19
|
-
}
|
|
20
|
-
return tabbableItemId;
|
|
21
|
-
};
|
|
7
|
+
import { selectorDefaultFocusableItemId, selectorFocusedItemId } from "./useTreeViewFocus.selectors.js";
|
|
8
|
+
import { selectorIsItemExpanded } from "../useTreeViewExpansion/useTreeViewExpansion.selectors.js";
|
|
9
|
+
import { selectorCanItemBeFocused, selectorItemMeta } from "../useTreeViewItems/useTreeViewItems.selectors.js";
|
|
22
10
|
export const useTreeViewFocus = ({
|
|
23
11
|
instance,
|
|
24
12
|
params,
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
models,
|
|
28
|
-
rootRef
|
|
13
|
+
store,
|
|
14
|
+
models
|
|
29
15
|
}) => {
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
16
|
+
React.useEffect(() => {
|
|
17
|
+
let defaultFocusableItemId = convertSelectedItemsToArray(models.selectedItems.value).find(itemId => {
|
|
18
|
+
if (!selectorCanItemBeFocused(store.value, itemId)) {
|
|
19
|
+
return false;
|
|
20
|
+
}
|
|
21
|
+
const itemMeta = selectorItemMeta(store.value, itemId);
|
|
22
|
+
return itemMeta && (itemMeta.parentId == null || selectorIsItemExpanded(store.value, itemMeta.parentId));
|
|
23
|
+
});
|
|
24
|
+
if (defaultFocusableItemId == null) {
|
|
25
|
+
defaultFocusableItemId = getFirstNavigableItem(store.value) ?? null;
|
|
37
26
|
}
|
|
27
|
+
store.update(prevState => {
|
|
28
|
+
if (defaultFocusableItemId === prevState.focus.defaultFocusableItemId) {
|
|
29
|
+
return prevState;
|
|
30
|
+
}
|
|
31
|
+
return _extends({}, prevState, {
|
|
32
|
+
focus: _extends({}, prevState.focus, {
|
|
33
|
+
defaultFocusableItemId
|
|
34
|
+
})
|
|
35
|
+
});
|
|
36
|
+
});
|
|
37
|
+
}, [store, models.selectedItems.value]);
|
|
38
|
+
const setFocusedItemId = useEventCallback(itemId => {
|
|
39
|
+
store.update(prevState => {
|
|
40
|
+
const focusedItemId = selectorFocusedItemId(prevState);
|
|
41
|
+
if (focusedItemId === itemId) {
|
|
42
|
+
return prevState;
|
|
43
|
+
}
|
|
44
|
+
return _extends({}, prevState, {
|
|
45
|
+
focus: _extends({}, prevState.focus, {
|
|
46
|
+
focusedItemId: itemId
|
|
47
|
+
})
|
|
48
|
+
});
|
|
49
|
+
});
|
|
38
50
|
});
|
|
39
|
-
const isTreeViewFocused = React.useCallback(() => !!rootRef.current && rootRef.current.contains(getActiveElement(ownerDocument(rootRef.current))), [rootRef]);
|
|
40
|
-
const isItemFocused = React.useCallback(itemId => state.focusedItemId === itemId && isTreeViewFocused(), [state.focusedItemId, isTreeViewFocused]);
|
|
41
51
|
const isItemVisible = itemId => {
|
|
42
|
-
const itemMeta =
|
|
43
|
-
return itemMeta && (itemMeta.parentId == null ||
|
|
52
|
+
const itemMeta = selectorItemMeta(store.value, itemId);
|
|
53
|
+
return itemMeta && (itemMeta.parentId == null || selectorIsItemExpanded(store.value, itemMeta.parentId));
|
|
44
54
|
};
|
|
45
55
|
const innerFocusItem = (event, itemId) => {
|
|
46
56
|
const itemElement = instance.getItemDOMElement(itemId);
|
|
@@ -59,23 +69,25 @@ export const useTreeViewFocus = ({
|
|
|
59
69
|
}
|
|
60
70
|
});
|
|
61
71
|
const removeFocusedItem = useEventCallback(() => {
|
|
62
|
-
|
|
72
|
+
const focusedItemId = selectorFocusedItemId(store.value);
|
|
73
|
+
if (focusedItemId == null) {
|
|
63
74
|
return;
|
|
64
75
|
}
|
|
65
|
-
const itemMeta =
|
|
76
|
+
const itemMeta = selectorItemMeta(store.value, focusedItemId);
|
|
66
77
|
if (itemMeta) {
|
|
67
|
-
const itemElement = instance.getItemDOMElement(
|
|
78
|
+
const itemElement = instance.getItemDOMElement(focusedItemId);
|
|
68
79
|
if (itemElement) {
|
|
69
80
|
itemElement.blur();
|
|
70
81
|
}
|
|
71
82
|
}
|
|
72
83
|
setFocusedItemId(null);
|
|
73
84
|
});
|
|
74
|
-
const canItemBeTabbed = itemId => itemId === defaultFocusableItemId;
|
|
75
85
|
useInstanceEventHandler(instance, 'removeItem', ({
|
|
76
86
|
id
|
|
77
87
|
}) => {
|
|
78
|
-
|
|
88
|
+
const focusedItemId = selectorFocusedItemId(store.value);
|
|
89
|
+
const defaultFocusableItemId = selectorDefaultFocusableItemId(store.value);
|
|
90
|
+
if (focusedItemId === id && defaultFocusableItemId != null) {
|
|
79
91
|
innerFocusItem(null, defaultFocusableItemId);
|
|
80
92
|
}
|
|
81
93
|
});
|
|
@@ -86,27 +98,37 @@ export const useTreeViewFocus = ({
|
|
|
86
98
|
}
|
|
87
99
|
|
|
88
100
|
// if the event bubbled (which is React specific) we don't want to steal focus
|
|
89
|
-
|
|
101
|
+
const defaultFocusableItemId = selectorDefaultFocusableItemId(store.value);
|
|
102
|
+
if (event.target === event.currentTarget && defaultFocusableItemId != null) {
|
|
90
103
|
innerFocusItem(event, defaultFocusableItemId);
|
|
91
104
|
}
|
|
92
105
|
};
|
|
106
|
+
const createRootHandleBlur = otherHandlers => event => {
|
|
107
|
+
otherHandlers.onBlur?.(event);
|
|
108
|
+
if (event.defaultMuiPrevented) {
|
|
109
|
+
return;
|
|
110
|
+
}
|
|
111
|
+
setFocusedItemId(null);
|
|
112
|
+
};
|
|
93
113
|
return {
|
|
94
114
|
getRootProps: otherHandlers => ({
|
|
95
|
-
onFocus: createRootHandleFocus(otherHandlers)
|
|
115
|
+
onFocus: createRootHandleFocus(otherHandlers),
|
|
116
|
+
onBlur: createRootHandleBlur(otherHandlers)
|
|
96
117
|
}),
|
|
97
118
|
publicAPI: {
|
|
98
119
|
focusItem
|
|
99
120
|
},
|
|
100
121
|
instance: {
|
|
101
|
-
isItemFocused,
|
|
102
|
-
canItemBeTabbed,
|
|
103
122
|
focusItem,
|
|
104
123
|
removeFocusedItem
|
|
105
124
|
}
|
|
106
125
|
};
|
|
107
126
|
};
|
|
108
127
|
useTreeViewFocus.getInitialState = () => ({
|
|
109
|
-
|
|
128
|
+
focus: {
|
|
129
|
+
focusedItemId: null,
|
|
130
|
+
defaultFocusableItemId: null
|
|
131
|
+
}
|
|
110
132
|
});
|
|
111
133
|
useTreeViewFocus.params = {
|
|
112
134
|
onItemFocus: true
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { createSelector } from "../../utils/selectors.js";
|
|
2
|
+
const selectorTreeViewFocusState = state => state.focus;
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Get the item that should be sequentially focusable (usually with the Tab key).
|
|
6
|
+
* At any point in time, there is a single item that can be sequentially focused in the Tree View.
|
|
7
|
+
* This item is the first selected item (that is both visible and navigable), if any, or the first navigable item if no item is selected.
|
|
8
|
+
* @param {TreeViewState<[UseTreeViewFocusSignature]>} state The state of the tree view.
|
|
9
|
+
* @returns {TreeViewItemId | null} The id of the item that should be sequentially focusable.
|
|
10
|
+
*/
|
|
11
|
+
export const selectorDefaultFocusableItemId = createSelector(selectorTreeViewFocusState, focus => focus.defaultFocusableItemId);
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Check if an item is the default focusable item.
|
|
15
|
+
* @param {TreeViewState<[UseTreeViewFocusSignature]>} state The state of the tree view.
|
|
16
|
+
* @param {TreeViewItemId} itemId The id of the item to check.
|
|
17
|
+
* @returns {boolean} `true` if the item is the default focusable item, `false` otherwise.
|
|
18
|
+
*/
|
|
19
|
+
export const selectorIsItemTheDefaultFocusableItem = createSelector([selectorDefaultFocusableItemId, (_, itemId) => itemId], (defaultFocusableItemId, itemId) => defaultFocusableItemId === itemId);
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* Get the id of the item that is currently focused.
|
|
23
|
+
* @param {TreeViewState<[UseTreeViewFocusSignature]>} state The state of the tree view.
|
|
24
|
+
* @returns {TreeViewItemId | null} The id of the item that is currently focused.
|
|
25
|
+
*/
|
|
26
|
+
export const selectorFocusedItemId = createSelector(selectorTreeViewFocusState, focus => focus.focusedItemId);
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* Check if an item is focused.
|
|
30
|
+
* @param {TreeViewState<[UseTreeViewFocusSignature]>} state The state of the tree view.
|
|
31
|
+
* @param {TreeViewItemId} itemId The id of the item to check.
|
|
32
|
+
* @returns {boolean} `true` if the item is focused, `false` otherwise.
|
|
33
|
+
*/
|
|
34
|
+
export const selectorIsItemFocused = createSelector([selectorFocusedItemId, (_, itemId) => itemId], (focusedItemId, itemId) => focusedItemId === itemId);
|
|
@@ -1,22 +1,24 @@
|
|
|
1
|
+
import * as React from 'react';
|
|
1
2
|
export const useTreeViewIcons = ({
|
|
2
3
|
slots,
|
|
3
4
|
slotProps
|
|
4
5
|
}) => {
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
endIcon: slotProps.endIcon
|
|
17
|
-
}
|
|
6
|
+
const pluginContextValue = React.useMemo(() => ({
|
|
7
|
+
icons: {
|
|
8
|
+
slots: {
|
|
9
|
+
collapseIcon: slots.collapseIcon,
|
|
10
|
+
expandIcon: slots.expandIcon,
|
|
11
|
+
endIcon: slots.endIcon
|
|
12
|
+
},
|
|
13
|
+
slotProps: {
|
|
14
|
+
collapseIcon: slotProps.collapseIcon,
|
|
15
|
+
expandIcon: slotProps.expandIcon,
|
|
16
|
+
endIcon: slotProps.endIcon
|
|
18
17
|
}
|
|
19
18
|
}
|
|
19
|
+
}), [slots.collapseIcon, slots.expandIcon, slots.endIcon, slotProps.collapseIcon, slotProps.expandIcon, slotProps.endIcon]);
|
|
20
|
+
return {
|
|
21
|
+
contextValue: pluginContextValue
|
|
20
22
|
};
|
|
21
23
|
};
|
|
22
24
|
useTreeViewIcons.params = {};
|
|
@@ -1,21 +1,23 @@
|
|
|
1
1
|
import _extends from "@babel/runtime/helpers/esm/extends";
|
|
2
|
-
import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
|
|
3
|
-
const _excluded = ["children"];
|
|
4
2
|
import * as React from 'react';
|
|
3
|
+
import useEventCallback from '@mui/utils/useEventCallback';
|
|
5
4
|
import { publishTreeViewEvent } from "../../utils/publishTreeViewEvent.js";
|
|
6
5
|
import { buildSiblingIndexes, TREE_VIEW_ROOT_PARENT_ID } from "./useTreeViewItems.utils.js";
|
|
7
6
|
import { TreeViewItemDepthContext } from "../../TreeViewItemDepthContext/index.js";
|
|
7
|
+
import { selectorItemMeta, selectorItemOrderedChildrenIds, selectorItemModel, selectorItemDepth } from "./useTreeViewItems.selectors.js";
|
|
8
|
+
import { selectorTreeViewId } from "../../corePlugins/useTreeViewId/useTreeViewId.selectors.js";
|
|
8
9
|
import { generateTreeItemIdAttribute } from "../../corePlugins/useTreeViewId/useTreeViewId.utils.js";
|
|
9
10
|
import { jsx as _jsx } from "react/jsx-runtime";
|
|
10
11
|
const updateItemsState = ({
|
|
12
|
+
disabledItemsFocusable,
|
|
11
13
|
items,
|
|
12
14
|
isItemDisabled,
|
|
13
15
|
getItemLabel,
|
|
14
16
|
getItemId
|
|
15
17
|
}) => {
|
|
16
|
-
const
|
|
17
|
-
const
|
|
18
|
-
const
|
|
18
|
+
const itemMetaLookup = {};
|
|
19
|
+
const itemModelLookup = {};
|
|
20
|
+
const itemOrderedChildrenIdsLookup = {
|
|
19
21
|
[TREE_VIEW_ROOT_PARENT_ID]: []
|
|
20
22
|
};
|
|
21
23
|
const processItem = (item, depth, parentId) => {
|
|
@@ -23,14 +25,14 @@ const updateItemsState = ({
|
|
|
23
25
|
if (id == null) {
|
|
24
26
|
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'));
|
|
25
27
|
}
|
|
26
|
-
if (
|
|
28
|
+
if (itemMetaLookup[id] != null) {
|
|
27
29
|
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'));
|
|
28
30
|
}
|
|
29
31
|
const label = getItemLabel ? getItemLabel(item) : item.label;
|
|
30
32
|
if (label == null) {
|
|
31
33
|
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'));
|
|
32
34
|
}
|
|
33
|
-
|
|
35
|
+
itemMetaLookup[id] = {
|
|
34
36
|
id,
|
|
35
37
|
label,
|
|
36
38
|
parentId,
|
|
@@ -39,88 +41,58 @@ const updateItemsState = ({
|
|
|
39
41
|
disabled: isItemDisabled ? isItemDisabled(item) : false,
|
|
40
42
|
depth
|
|
41
43
|
};
|
|
42
|
-
|
|
44
|
+
itemModelLookup[id] = item;
|
|
43
45
|
const parentIdWithDefault = parentId ?? TREE_VIEW_ROOT_PARENT_ID;
|
|
44
|
-
if (!
|
|
45
|
-
|
|
46
|
+
if (!itemOrderedChildrenIdsLookup[parentIdWithDefault]) {
|
|
47
|
+
itemOrderedChildrenIdsLookup[parentIdWithDefault] = [];
|
|
46
48
|
}
|
|
47
|
-
|
|
49
|
+
itemOrderedChildrenIdsLookup[parentIdWithDefault].push(id);
|
|
48
50
|
item.children?.forEach(child => processItem(child, depth + 1, id));
|
|
49
51
|
};
|
|
50
52
|
items.forEach(item => processItem(item, 0, null));
|
|
51
|
-
const
|
|
52
|
-
Object.keys(
|
|
53
|
-
|
|
53
|
+
const itemChildrenIndexesLookup = {};
|
|
54
|
+
Object.keys(itemOrderedChildrenIdsLookup).forEach(parentId => {
|
|
55
|
+
itemChildrenIndexesLookup[parentId] = buildSiblingIndexes(itemOrderedChildrenIdsLookup[parentId]);
|
|
54
56
|
});
|
|
55
57
|
return {
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
58
|
+
disabledItemsFocusable,
|
|
59
|
+
itemMetaLookup,
|
|
60
|
+
itemModelLookup,
|
|
61
|
+
itemOrderedChildrenIdsLookup,
|
|
62
|
+
itemChildrenIndexesLookup
|
|
60
63
|
};
|
|
61
64
|
};
|
|
62
65
|
export const useTreeViewItems = ({
|
|
63
66
|
instance,
|
|
64
67
|
params,
|
|
65
|
-
|
|
66
|
-
setState
|
|
68
|
+
store
|
|
67
69
|
}) => {
|
|
68
|
-
const
|
|
69
|
-
const getItem = React.useCallback(itemId => state.items.itemMap[itemId], [state.items.itemMap]);
|
|
70
|
+
const getItem = React.useCallback(itemId => selectorItemModel(store.value, itemId), [store]);
|
|
70
71
|
const getItemTree = React.useCallback(() => {
|
|
71
|
-
const getItemFromItemId =
|
|
72
|
-
const
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
if (newChildren) {
|
|
72
|
+
const getItemFromItemId = itemId => {
|
|
73
|
+
const item = selectorItemModel(store.value, itemId);
|
|
74
|
+
const newChildren = selectorItemOrderedChildrenIds(store.value, itemId);
|
|
75
|
+
if (newChildren.length > 0) {
|
|
76
76
|
item.children = newChildren.map(getItemFromItemId);
|
|
77
|
+
} else {
|
|
78
|
+
delete item.children;
|
|
77
79
|
}
|
|
78
80
|
return item;
|
|
79
81
|
};
|
|
80
|
-
return
|
|
81
|
-
}, [
|
|
82
|
-
const
|
|
83
|
-
if (itemId == null) {
|
|
84
|
-
return false;
|
|
85
|
-
}
|
|
86
|
-
let itemMeta = instance.getItemMeta(itemId);
|
|
87
|
-
|
|
88
|
-
// This can be called before the item has been added to the item map.
|
|
89
|
-
if (!itemMeta) {
|
|
90
|
-
return false;
|
|
91
|
-
}
|
|
92
|
-
if (itemMeta.disabled) {
|
|
93
|
-
return true;
|
|
94
|
-
}
|
|
95
|
-
while (itemMeta.parentId != null) {
|
|
96
|
-
itemMeta = instance.getItemMeta(itemMeta.parentId);
|
|
97
|
-
if (itemMeta.disabled) {
|
|
98
|
-
return true;
|
|
99
|
-
}
|
|
100
|
-
}
|
|
101
|
-
return false;
|
|
102
|
-
}, [instance]);
|
|
103
|
-
const getItemIndex = React.useCallback(itemId => {
|
|
104
|
-
const parentId = instance.getItemMeta(itemId).parentId ?? TREE_VIEW_ROOT_PARENT_ID;
|
|
105
|
-
return state.items.itemChildrenIndexes[parentId][itemId];
|
|
106
|
-
}, [instance, state.items.itemChildrenIndexes]);
|
|
107
|
-
const getItemOrderedChildrenIds = React.useCallback(itemId => state.items.itemOrderedChildrenIds[itemId ?? TREE_VIEW_ROOT_PARENT_ID] ?? [], [state.items.itemOrderedChildrenIds]);
|
|
82
|
+
return selectorItemOrderedChildrenIds(store.value, null).map(getItemFromItemId);
|
|
83
|
+
}, [store]);
|
|
84
|
+
const getItemOrderedChildrenIds = React.useCallback(itemId => selectorItemOrderedChildrenIds(store.value, itemId), [store]);
|
|
108
85
|
const getItemDOMElement = itemId => {
|
|
109
|
-
const itemMeta =
|
|
86
|
+
const itemMeta = selectorItemMeta(store.value, itemId);
|
|
110
87
|
if (itemMeta == null) {
|
|
111
88
|
return null;
|
|
112
89
|
}
|
|
113
|
-
|
|
114
|
-
treeId:
|
|
90
|
+
const idAttribute = generateTreeItemIdAttribute({
|
|
91
|
+
treeId: selectorTreeViewId(store.value),
|
|
115
92
|
itemId,
|
|
116
93
|
id: itemMeta.idAttribute
|
|
117
|
-
})
|
|
118
|
-
|
|
119
|
-
const isItemNavigable = itemId => {
|
|
120
|
-
if (params.disabledItemsFocusable) {
|
|
121
|
-
return true;
|
|
122
|
-
}
|
|
123
|
-
return !instance.isItemDisabled(itemId);
|
|
94
|
+
});
|
|
95
|
+
return document.getElementById(idAttribute);
|
|
124
96
|
};
|
|
125
97
|
const areItemUpdatesPreventedRef = React.useRef(false);
|
|
126
98
|
const preventItemUpdates = React.useCallback(() => {
|
|
@@ -131,15 +103,16 @@ export const useTreeViewItems = ({
|
|
|
131
103
|
if (instance.areItemUpdatesPrevented()) {
|
|
132
104
|
return;
|
|
133
105
|
}
|
|
134
|
-
|
|
106
|
+
store.update(prevState => {
|
|
135
107
|
const newState = updateItemsState({
|
|
108
|
+
disabledItemsFocusable: params.disabledItemsFocusable,
|
|
136
109
|
items: params.items,
|
|
137
110
|
isItemDisabled: params.isItemDisabled,
|
|
138
111
|
getItemId: params.getItemId,
|
|
139
112
|
getItemLabel: params.getItemLabel
|
|
140
113
|
});
|
|
141
|
-
Object.values(prevState.items.
|
|
142
|
-
if (!newState.
|
|
114
|
+
Object.values(prevState.items.itemMetaLookup).forEach(item => {
|
|
115
|
+
if (!newState.itemMetaLookup[item.id]) {
|
|
143
116
|
publishTreeViewEvent(instance, 'removeItem', {
|
|
144
117
|
id: item.id
|
|
145
118
|
});
|
|
@@ -149,19 +122,19 @@ export const useTreeViewItems = ({
|
|
|
149
122
|
items: newState
|
|
150
123
|
});
|
|
151
124
|
});
|
|
152
|
-
}, [instance,
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
};
|
|
125
|
+
}, [instance, store, params.items, params.disabledItemsFocusable, params.isItemDisabled, params.getItemId, params.getItemLabel]);
|
|
126
|
+
|
|
127
|
+
// Wrap `props.onItemClick` with `useEventCallback` to prevent unneeded context updates.
|
|
128
|
+
const handleItemClick = useEventCallback((event, itemId) => {
|
|
129
|
+
if (params.onItemClick) {
|
|
130
|
+
params.onItemClick(event, itemId);
|
|
131
|
+
}
|
|
132
|
+
});
|
|
133
|
+
const pluginContextValue = React.useMemo(() => ({
|
|
134
|
+
items: {
|
|
135
|
+
onItemClick: handleItemClick
|
|
136
|
+
}
|
|
137
|
+
}), [handleItemClick]);
|
|
165
138
|
return {
|
|
166
139
|
getRootProps: () => ({
|
|
167
140
|
style: {
|
|
@@ -175,28 +148,16 @@ export const useTreeViewItems = ({
|
|
|
175
148
|
getItemOrderedChildrenIds
|
|
176
149
|
},
|
|
177
150
|
instance: {
|
|
178
|
-
getItemMeta,
|
|
179
|
-
getItem,
|
|
180
|
-
getItemTree,
|
|
181
|
-
getItemsToRender,
|
|
182
|
-
getItemIndex,
|
|
183
151
|
getItemDOMElement,
|
|
184
|
-
getItemOrderedChildrenIds,
|
|
185
|
-
isItemDisabled,
|
|
186
|
-
isItemNavigable,
|
|
187
152
|
preventItemUpdates,
|
|
188
153
|
areItemUpdatesPrevented
|
|
189
154
|
},
|
|
190
|
-
contextValue:
|
|
191
|
-
items: {
|
|
192
|
-
onItemClick: params.onItemClick,
|
|
193
|
-
disabledItemsFocusable: params.disabledItemsFocusable
|
|
194
|
-
}
|
|
195
|
-
}
|
|
155
|
+
contextValue: pluginContextValue
|
|
196
156
|
};
|
|
197
157
|
};
|
|
198
158
|
useTreeViewItems.getInitialState = params => ({
|
|
199
159
|
items: updateItemsState({
|
|
160
|
+
disabledItemsFocusable: params.disabledItemsFocusable,
|
|
200
161
|
items: params.items,
|
|
201
162
|
isItemDisabled: params.isItemDisabled,
|
|
202
163
|
getItemId: params.getItemId,
|
|
@@ -210,11 +171,10 @@ useTreeViewItems.getDefaultizedParams = ({
|
|
|
210
171
|
itemChildrenIndentation: params.itemChildrenIndentation ?? '12px'
|
|
211
172
|
});
|
|
212
173
|
useTreeViewItems.wrapRoot = ({
|
|
213
|
-
children
|
|
214
|
-
instance
|
|
174
|
+
children
|
|
215
175
|
}) => {
|
|
216
176
|
return /*#__PURE__*/_jsx(TreeViewItemDepthContext.Provider, {
|
|
217
|
-
value:
|
|
177
|
+
value: selectorItemDepth,
|
|
218
178
|
children: children
|
|
219
179
|
});
|
|
220
180
|
};
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import { createSelector } from "../../utils/selectors.js";
|
|
2
|
+
import { TREE_VIEW_ROOT_PARENT_ID } from "./useTreeViewItems.utils.js";
|
|
3
|
+
const selectorTreeViewItemsState = state => state.items;
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Get the meta-information of all items.
|
|
7
|
+
* @param {TreeViewState<[UseTreeViewItemsSignature]>} state The state of the tree view.
|
|
8
|
+
* @returns {TreeViewItemMetaLookup} The meta-information of all items.
|
|
9
|
+
*/
|
|
10
|
+
export const selectorItemMetaLookup = createSelector(selectorTreeViewItemsState, items => items.itemMetaLookup);
|
|
11
|
+
const EMPTY_CHILDREN = [];
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Get the ordered children ids of a given item.
|
|
15
|
+
* @param {TreeViewState<[UseTreeViewItemsSignature]>} state The state of the tree view.
|
|
16
|
+
* @param {TreeViewItemId} itemId The id of the item to get the children of.
|
|
17
|
+
* @returns {TreeViewItemId[]} The ordered children ids of the item.
|
|
18
|
+
*/
|
|
19
|
+
export const selectorItemOrderedChildrenIds = createSelector([selectorTreeViewItemsState, (_, itemId) => itemId], (itemsState, itemId) => itemsState.itemOrderedChildrenIdsLookup[itemId ?? TREE_VIEW_ROOT_PARENT_ID] ?? EMPTY_CHILDREN);
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* Get the model of an item.
|
|
23
|
+
* @param {TreeViewState<[UseTreeViewItemsSignature]>} state The state of the tree view.
|
|
24
|
+
* @param {TreeViewItemId} itemId The id of the item to get the model of.
|
|
25
|
+
* @returns {R} The model of the item.
|
|
26
|
+
*/
|
|
27
|
+
export const selectorItemModel = createSelector([selectorTreeViewItemsState, (_, itemId) => itemId], (itemsState, itemId) => {
|
|
28
|
+
const a = itemsState.itemModelLookup[itemId];
|
|
29
|
+
return a;
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* Get the meta-information of an item.
|
|
34
|
+
* Check the `TreeViewItemMeta` type for more information.
|
|
35
|
+
* @param {TreeViewState<[UseTreeViewItemsSignature]>}
|
|
36
|
+
* @param {TreeViewItemId} itemId The id of the item to get the meta-information of.
|
|
37
|
+
* @returns {TreeViewItemMeta | null} The meta-information of the item.
|
|
38
|
+
*/
|
|
39
|
+
export const selectorItemMeta = createSelector([selectorItemMetaLookup, (_, itemId) => itemId], (itemMetaLookup, itemId) => itemMetaLookup[itemId ?? TREE_VIEW_ROOT_PARENT_ID] ?? null);
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
* Check if an item is disabled.
|
|
43
|
+
* @param {TreeViewState<[UseTreeViewItemsSignature]>} state The state of the tree view.
|
|
44
|
+
* @param {TreeViewItemId} itemId The id of the item to check.
|
|
45
|
+
* @returns {boolean} `true` if the item is disabled, `false` otherwise.
|
|
46
|
+
*/
|
|
47
|
+
export const selectorIsItemDisabled = createSelector([selectorItemMetaLookup, (_, itemId) => itemId], (itemMetaLookup, itemId) => {
|
|
48
|
+
if (itemId == null) {
|
|
49
|
+
return false;
|
|
50
|
+
}
|
|
51
|
+
let itemMeta = itemMetaLookup[itemId];
|
|
52
|
+
|
|
53
|
+
// This can be called before the item has been added to the item map.
|
|
54
|
+
if (!itemMeta) {
|
|
55
|
+
return false;
|
|
56
|
+
}
|
|
57
|
+
if (itemMeta.disabled) {
|
|
58
|
+
return true;
|
|
59
|
+
}
|
|
60
|
+
while (itemMeta.parentId != null) {
|
|
61
|
+
itemMeta = itemMetaLookup[itemMeta.parentId];
|
|
62
|
+
if (itemMeta.disabled) {
|
|
63
|
+
return true;
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
return false;
|
|
67
|
+
});
|
|
68
|
+
|
|
69
|
+
/**
|
|
70
|
+
* Get the index of an item in its parent's children.
|
|
71
|
+
* @param {TreeViewState<[UseTreeViewItemsSignature]>} state The state of the tree view.
|
|
72
|
+
* @param {TreeViewItemId} itemId The id of the item to get the index of.
|
|
73
|
+
* @returns {number} The index of the item in its parent's children.
|
|
74
|
+
*/
|
|
75
|
+
export const selectorItemIndex = createSelector([selectorTreeViewItemsState, selectorItemMeta], (itemsState, itemMeta) => {
|
|
76
|
+
if (itemMeta == null) {
|
|
77
|
+
return -1;
|
|
78
|
+
}
|
|
79
|
+
const parentIndexes = itemsState.itemChildrenIndexesLookup[itemMeta.parentId ?? TREE_VIEW_ROOT_PARENT_ID];
|
|
80
|
+
return parentIndexes[itemMeta.id];
|
|
81
|
+
});
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* Get the id of the parent of an item.
|
|
85
|
+
* @param {TreeViewState<[UseTreeViewItemsSignature]>} state The state of the tree view.
|
|
86
|
+
* @param {TreeViewItemId} itemId The id of the item to get the parent id of.
|
|
87
|
+
* @returns {TreeViewItemId | null} The id of the parent of the item.
|
|
88
|
+
*/
|
|
89
|
+
export const selectorItemParentId = createSelector([selectorItemMeta], itemMeta => itemMeta?.parentId ?? null);
|
|
90
|
+
|
|
91
|
+
/**
|
|
92
|
+
* Get the depth of an item (items at the root level have a depth of 0).
|
|
93
|
+
* @param {TreeViewState<[UseTreeViewItemsSignature]>} state The state of the tree view.
|
|
94
|
+
* @param {TreeViewItemId} itemId The id of the item to get the depth of.
|
|
95
|
+
* @returns {number} The depth of the item.
|
|
96
|
+
*/
|
|
97
|
+
export const selectorItemDepth = createSelector([selectorItemMeta], itemMeta => itemMeta?.depth ?? 0);
|
|
98
|
+
export const selectorCanItemBeFocused = createSelector([selectorTreeViewItemsState, selectorIsItemDisabled], (itemsState, isItemDisabled) => {
|
|
99
|
+
if (itemsState.disabledItemsFocusable) {
|
|
100
|
+
return true;
|
|
101
|
+
}
|
|
102
|
+
return !isItemDisabled;
|
|
103
|
+
});
|