Skip to content

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.

Support selectors in tree expanded logic (#1258)

Bogdan Chadkinafb2a35863ca
diff --git a/packages/design-system/src/components/tree/horizontal-shift.test.ts b/packages/design-system/src/components/tree/horizontal-shift.test.ts
index 7abf498953..085a8446b7 100644
--- a/packages/design-system/src/components/tree/horizontal-shift.test.ts
+++ b/packages/design-system/src/components/tree/horizontal-shift.test.ts
@@ -2,9 +2,10 @@ import { describe, test, expect } from "@jest/globals";
import { renderHook, act } from "@testing-library/react-hooks";
import type { Placement } from "../primitives/dnd";
import { useHorizontalShift } from "./horizontal-shift";
-import type { ItemDropTarget, ItemId } from "./item-utils";
+import type { ItemDropTarget, ItemId, ItemSelector } from "./item-utils";
import {
canAcceptChild,
+ findItemById,
getItemChildren,
getItemPath,
Item,
@@ -112,7 +113,8 @@ const render = (
dragItem === undefined ? undefined : getItemSelector(dragItem.id),
dropTarget,
root: tree,
- getIsExpanded: (item: Item) => item.children.length > 0,
+ getIsExpanded: (itemSelector: ItemSelector) =>
+ (findItemById(tree, itemSelector[0])?.children.length ?? 0) > 0,
canAcceptChild,
getItemChildren,
getItemPath,
diff --git a/packages/design-system/src/components/tree/horizontal-shift.ts b/packages/design-system/src/components/tree/horizontal-shift.ts
index 37624832f5..2178906bf3 100644
--- a/packages/design-system/src/components/tree/horizontal-shift.ts
+++ b/packages/design-system/src/components/tree/horizontal-shift.ts
@@ -24,7 +24,7 @@ export const useHorizontalShift = <Data extends { id: string }>({
dragItemSelector: undefined | ItemSelector;
dropTarget: ItemDropTarget<Data> | undefined;
root: Data;
- getIsExpanded: (item: Data) => boolean;
+ getIsExpanded: (itemSelector: ItemSelector) => boolean;
}) => {
const [horizontalShift, setHorizontalShift] = useState(0);
@@ -145,7 +145,7 @@ export const useHorizontalShift = <Data extends { id: string }>({
while (
potentialNewParent &&
- getIsExpanded(potentialNewParent) &&
+ getIsExpanded([potentialNewParent.id, ...newParentSelector]) &&
canAcceptChild(potentialNewParent) &&
shifted < desiredDepth - currentDepth
) {
diff --git a/packages/design-system/src/components/tree/item-utils.ts b/packages/design-system/src/components/tree/item-utils.ts
index 219e7772f2..b73d936c05 100644
--- a/packages/design-system/src/components/tree/item-utils.ts
+++ b/packages/design-system/src/components/tree/item-utils.ts
@@ -44,8 +44,8 @@ export const getItemSelectorFromElement = (element: Element) => {
};
export const areItemSelectorsEqual = (
- left?: ItemSelector,
- right?: ItemSelector
+ left: undefined | ItemSelector,
+ right: undefined | ItemSelector
) => {
if (left === undefined || right === undefined) {
return false;
diff --git a/packages/design-system/src/components/tree/tree.tsx b/packages/design-system/src/components/tree/tree.tsx
index c9d6430ecf..75cdbd6936 100644
--- a/packages/design-system/src/components/tree/tree.tsx
+++ b/packages/design-system/src/components/tree/tree.tsx
@@ -55,8 +55,9 @@ export const Tree = <Data extends { id: string }>({
onDragEnd,
}: TreeProps<Data>) => {
const { getIsExpanded, setIsExpanded } = useExpandState({
- root,
selectedItemSelector,
+ root,
+ findItemById,
getItemChildren,
});
@@ -97,9 +98,9 @@ export const Tree = <Data extends { id: string }>({
onHold: (dropTarget) => {
if (
getItemChildren(dropTarget.data).length > 0 ||
- getIsExpanded(dropTarget.data) === false
+ getIsExpanded(dropTarget.itemSelector) === false
) {
- setIsExpanded(dropTarget.data, true);
+ setIsExpanded(dropTarget.itemSelector, true);
}
},
});
@@ -248,7 +249,6 @@ export const Tree = <Data extends { id: string }>({
const keyboardNavigation = useKeyboardNavigation({
root,
getItemChildren,
- findItemById,
selectedItemSelector,
getIsExpanded,
setIsExpanded,
@@ -295,8 +295,18 @@ export const Tree = <Data extends { id: string }>({
selectedItemId={selectedItemSelector?.[0]}
itemData={root}
level={0}
- getIsExpanded={getIsExpanded}
- setIsExpanded={setIsExpanded}
+ getIsExpanded={(item) => {
+ const itemSelector = getItemPath(root, item.id)
+ .map((item) => item.id)
+ .reverse();
+ return getIsExpanded(itemSelector);
+ }}
+ setIsExpanded={(item, isExpanded) => {
+ const itemSelector = getItemPath(root, item.id)
+ .map((item) => item.id)
+ .reverse();
+ setIsExpanded(itemSelector, isExpanded);
+ }}
onExpandTransitionEnd={dropHandlers.handleDomMutation}
dropTargetItemId={shiftedDropTarget?.itemSelector[0]}
/>
@@ -320,7 +330,6 @@ const useKeyboardNavigation = <Data extends { id: string }>({
root,
selectedItemSelector,
getItemChildren,
- findItemById,
getIsExpanded,
setIsExpanded,
onEsc,
@@ -328,24 +337,15 @@ const useKeyboardNavigation = <Data extends { id: string }>({
root: Data;
selectedItemSelector: undefined | ItemSelector;
getItemChildren: (item: Data) => Data[];
- findItemById: (root: Data, id: string) => Data | undefined;
- getIsExpanded: (instance: Data) => boolean;
- setIsExpanded: (instance: Data, isExpanded: boolean) => void;
+ getIsExpanded: (itemSelector: ItemSelector) => boolean;
+ setIsExpanded: (itemSelector: ItemSelector, isExpanded: boolean) => void;
onEsc: () => void;
}) => {
- const selectedItem = useMemo(() => {
- if (selectedItemSelector === undefined) {
- return undefined;
- }
- const [selectedItemId] = selectedItemSelector;
- return findItemById(root, selectedItemId);
- }, [root, selectedItemSelector, findItemById]);
-
const flatCurrentlyExpandedTree = useMemo(() => {
const result: ItemSelector[] = [];
const traverse = (item: Data, itemSelector: ItemSelector) => {
result.push(itemSelector);
- if (getIsExpanded(item)) {
+ if (getIsExpanded(itemSelector)) {
for (const child of getItemChildren(item)) {
traverse(child, [child.id, ...itemSelector]);
}
@@ -359,18 +359,21 @@ const useKeyboardNavigation = <Data extends { id: string }>({
const handleKeyDown = (event: ReactKeyboardEvent) => {
// skip if nothing is selected in the tree
- if (selectedItem === undefined) {
+ if (selectedItemSelector === undefined) {
return;
}
- if (event.key === "ArrowRight" && getIsExpanded(selectedItem) === false) {
- setIsExpanded(selectedItem, true);
+ if (
+ event.key === "ArrowRight" &&
+ getIsExpanded(selectedItemSelector) === false
+ ) {
+ setIsExpanded(selectedItemSelector, true);
}
- if (event.key === "ArrowLeft" && getIsExpanded(selectedItem)) {
- setIsExpanded(selectedItem, false);
+ if (event.key === "ArrowLeft" && getIsExpanded(selectedItemSelector)) {
+ setIsExpanded(selectedItemSelector, false);
}
if (event.key === " ") {
- setIsExpanded(selectedItem, !getIsExpanded(selectedItem));
+ setIsExpanded(selectedItemSelector, !getIsExpanded(selectedItemSelector));
// prevent scrolling
event.preventDefault();
}
@@ -469,15 +472,18 @@ const useKeyboardNavigation = <Data extends { id: string }>({
const useExpandState = <Data extends { id: string }>({
selectedItemSelector,
root,
+ findItemById,
getItemChildren,
}: {
+ selectedItemSelector: undefined | ItemSelector;
root: Data;
+ findItemById: (root: Data, id: string) => Data | undefined;
getItemChildren: (item: Data) => Data[];
- selectedItemSelector: undefined | ItemSelector;
}) => {
const [record, setRecord] = useState<Record<string, boolean>>({});
- // We want to automatically expand all parents of the selected instance whenever it changes
+ // whenever selected instance is changed
+ // all its parents should be automatically expanded
const prevSelectedItemSelector = useRef(selectedItemSelector);
useEffect(() => {
if (
@@ -492,39 +498,46 @@ const useExpandState = <Data extends { id: string }>({
if (selectedItemSelector === undefined) {
return;
}
- const path = selectedItemSelector.slice().reverse();
- // Don't want to expand the selected instance itself
- path.pop();
- const toExpand = path.filter((id) => record[id] !== true);
- if (toExpand.length === 0) {
- return;
- }
setRecord((record) => {
const newRecord = { ...record };
- for (const id of toExpand) {
- newRecord[id] = true;
+ let expanded = 0;
+ // do not expand the selected instance itself, start with parent
+ for (let index = 1; index < selectedItemSelector.length; index += 1) {
+ const key = selectedItemSelector.slice(index).join();
+ if (newRecord[key] !== true) {
+ newRecord[key] = true;
+ expanded += 1;
+ }
}
- return newRecord;
+ // prevent rerender if nothing new is expanded
+ return expanded === 0 ? record : newRecord;
});
- }, [record, selectedItemSelector]);
+ }, [selectedItemSelector]);
const getIsExpanded = useCallback(
- (instance: Data) => {
+ (itemSelector: ItemSelector) => {
// root is always expanded
- if (instance.id === root.id) {
+ if (itemSelector.length === 1) {
return true;
}
+ const item = findItemById(root, itemSelector[0]);
+ if (item === undefined) {
+ return false;
+ }
return (
- getItemChildren(instance).length > 0 && record[instance.id] === true
+ getItemChildren(item).length > 0 && record[itemSelector.join()] === true
);
},
- [record, root, getItemChildren]
+ [record, root, findItemById, getItemChildren]
);
- const setIsExpanded = useCallback((instance: Data, expanded: boolean) => {
- setRecord((record) => ({ ...record, [instance.id]: expanded }));
- }, []);
+ const setIsExpanded = useCallback(
+ (itemSelector: ItemSelector, expanded: boolean) => {
+ setRecord((record) => ({ ...record, [itemSelector.join()]: expanded }));
+ },
+ []
+ );
return { getIsExpanded, setIsExpanded };
};