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.

refactor: use selectors in all tree callbacks (#2635)

Bogdan Chadkin177cfeb3a17b
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/pages.tsx b/apps/builder/app/builder/features/sidebar-left/panels/pages/pages.tsx
index 76892c3fe1..a098cdbec0 100644
--- a/apps/builder/app/builder/features/sidebar-left/panels/pages/pages.tsx
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/pages.tsx
@@ -210,13 +210,13 @@ const PagesPanel = ({
onSelect={selectTreeNode}
itemData={pagesTree}
renderItem={renderItem}
- getItemChildren={(nodeId) => {
+ getItemChildren={([nodeId]) => {
if (nodeId === pagesTree.id && pagesTree.type === "folder") {
return pagesTree.children;
}
return [];
}}
- isItemHidden={(itemId) => itemId === pagesTree.id}
+ isItemHidden={([itemId]) => itemId === pagesTree.id}
getIsExpanded={() => true}
/>
</Box>
diff --git a/apps/builder/app/builder/shared/navigator-tree.tsx b/apps/builder/app/builder/shared/navigator-tree.tsx
index 7bed57094d..dcbd6faf58 100644
--- a/apps/builder/app/builder/shared/navigator-tree.tsx
+++ b/apps/builder/app/builder/shared/navigator-tree.tsx
@@ -2,7 +2,6 @@ import { useCallback, useMemo } from "react";
import { useStore } from "@nanostores/react";
import { shallowEqual } from "shallow-equal";
import { toast } from "@webstudio-is/design-system";
-import type { Instance } from "@webstudio-is/sdk";
import {
hoveredInstanceSelectorStore,
instancesStore,
@@ -86,7 +85,7 @@ export const NavigatorTree = () => {
);
const isItemHidden = useCallback(
- (instanceId: Instance["id"]) =>
+ ([instanceId]: InstanceSelector) =>
// fragment is internal component to group other instances
// for example to support multiple children in slots
instances.get(instanceId)?.component === "Fragment",
diff --git a/apps/builder/app/builder/shared/tree/index.tsx b/apps/builder/app/builder/shared/tree/index.tsx
index 71e6da04a3..38dfaa1d55 100644
--- a/apps/builder/app/builder/shared/tree/index.tsx
+++ b/apps/builder/app/builder/shared/tree/index.tsx
@@ -19,6 +19,7 @@ import { MetaIcon } from "../meta-icon";
import { useContentEditable } from "~/shared/dom-hooks";
import { getInstanceLabel } from "~/shared/instance-utils";
import { serverSyncStore } from "~/shared/sync";
+import type { InstanceSelector } from "~/shared/tree-utils";
export const InstanceTree = (
props: Omit<
@@ -31,7 +32,7 @@ export const InstanceTree = (
const editingItemId = useStore(editingItemIdStore);
const canLeaveParent = useCallback(
- (instanceId: Instance["id"]) => {
+ ([instanceId]: InstanceSelector) => {
const instance = instances.get(instanceId);
if (instance === undefined) {
return false;
@@ -43,7 +44,7 @@ export const InstanceTree = (
);
const getItemChildren = useCallback(
- (instanceId: Instance["id"]) => {
+ ([instanceId]: InstanceSelector) => {
const instance = instances.get(instanceId);
const children: Instance[] = [];
if (instance === undefined) {
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 049f647b81..b650bc7e08 100644
--- a/packages/design-system/src/components/tree/horizontal-shift.test.ts
+++ b/packages/design-system/src/components/tree/horizontal-shift.test.ts
@@ -114,9 +114,9 @@ const render = (
(findItemById(tree, itemSelector[0])?.children.length ?? 0) > 0,
canAcceptChild: (itemSelector: ItemSelector) =>
findItemById(tree, itemSelector[0])?.canAcceptChildren ?? false,
- getItemChildren: (itemId: ItemId) =>
- findItemById(tree, itemId)?.children ?? [],
- isItemHidden: (_itemId: ItemId) => false,
+ getItemChildren: (itemSelector: ItemSelector) =>
+ findItemById(tree, itemSelector[0])?.children ?? [],
+ isItemHidden: ([_itemId]: ItemSelector) => false,
},
});
diff --git a/packages/design-system/src/components/tree/horizontal-shift.ts b/packages/design-system/src/components/tree/horizontal-shift.ts
index bf1cb5d49e..e0726876b5 100644
--- a/packages/design-system/src/components/tree/horizontal-shift.ts
+++ b/packages/design-system/src/components/tree/horizontal-shift.ts
@@ -18,9 +18,9 @@ export const useHorizontalShift = <Data extends { id: ItemId }>({
isItemHidden,
getItemChildren,
}: {
- getItemChildren: (itemId: ItemId) => Data[];
+ getItemChildren: (itemSelector: ItemSelector) => Data[];
canAcceptChild: (itemSelector: ItemSelector) => boolean;
- isItemHidden: (itemId: ItemId) => boolean;
+ isItemHidden: (itemSelector: ItemSelector) => boolean;
dragItemSelector: undefined | ItemSelector;
dropTarget: ItemDropTarget | undefined;
placementIndicator: undefined | Placement;
@@ -58,11 +58,11 @@ export const useHorizontalShift = <Data extends { id: ItemId }>({
}
let dropHiddenCount = 0;
- for (const itemId of dropItemSelector) {
- if (isItemHidden(itemId)) {
+ dropItemSelector.forEach((_itemId, index) => {
+ if (isItemHidden(dropItemSelector.slice(index))) {
dropHiddenCount += 1;
}
- }
+ });
const dragItemDepth = dragItemSelector.length - 1;
const currentDepth = dropItemSelector.length;
@@ -81,8 +81,8 @@ export const useHorizontalShift = <Data extends { id: ItemId }>({
const [dragItemId] = dragItemSelector;
const isDragItem = (item: Data | undefined) => item?.id === dragItemId;
- const isAtTheBottom = (parentId: ItemId, index: number) => {
- const children = getItemChildren(parentId);
+ const isAtTheBottom = (parentSelector: ItemSelector, index: number) => {
+ const children = getItemChildren(parentSelector);
// There's a special case when the placement line is above the drag item.
// For reparenting, above and below the drag item means the same.
const indexCorrected = isDragItem(children[index]) ? index + 1 : index;
@@ -103,14 +103,15 @@ export const useHorizontalShift = <Data extends { id: ItemId }>({
for (let index = 1; index < dropItemSelector.length; index += 1) {
if (
index > currentDepth - desiredDepth ||
- isAtTheBottom(dropItemSelector[index - 1], newPosition) === false
+ isAtTheBottom(dropItemSelector.slice(index - 1), newPosition) ===
+ false
) {
break;
}
const currentItemSelector = dropItemSelector.slice(index);
if (canAcceptChild(currentItemSelector)) {
newParentSelector = currentItemSelector;
- const children = getItemChildren(dropItemSelector[index]);
+ const children = getItemChildren(dropItemSelector.slice(index));
const childId = dropItemSelector[index - 1] ?? children.at(-1)?.id;
const childPosition = children.findIndex(
(item) => item.id === childId
@@ -147,7 +148,7 @@ export const useHorizontalShift = <Data extends { id: ItemId }>({
let deepestAtTheBottomParentId: undefined | string =
deepestAtTheBottomItemSelector[0];
let deepestAtTheBottomChildren = getItemChildren(
- deepestAtTheBottomParentId
+ deepestAtTheBottomItemSelector
);
let deepestAtTheBottomPosition = indexWithinChildren - 1;
// eslint-disable-next-line no-constant-condition
@@ -167,7 +168,9 @@ export const useHorizontalShift = <Data extends { id: ItemId }>({
break;
}
deepestAtTheBottomItemSelector = newItemSelector;
- deepestAtTheBottomChildren = getItemChildren(deepestAtTheBottomParentId);
+ deepestAtTheBottomChildren = getItemChildren(
+ deepestAtTheBottomItemSelector
+ );
deepestAtTheBottomPosition = deepestAtTheBottomChildren.length - 1;
}
@@ -191,7 +194,7 @@ export const useHorizontalShift = <Data extends { id: ItemId }>({
if (canAcceptChild(currentItemSelector)) {
newParentSelector = currentItemSelector;
const children = getItemChildren(
- deepestAtTheBottomItemSelector[index]
+ deepestAtTheBottomItemSelector.slice(index)
);
const childId =
deepestAtTheBottomItemSelector[index - 1] ?? children.at(-1)?.id;
diff --git a/packages/design-system/src/components/tree/tree-node.tsx b/packages/design-system/src/components/tree/tree-node.tsx
index bf01afc696..ca469e03b5 100644
--- a/packages/design-system/src/components/tree/tree-node.tsx
+++ b/packages/design-system/src/components/tree/tree-node.tsx
@@ -392,8 +392,8 @@ export const TreeItemLabel = forwardRef(TreeItemLabelBase);
export type TreeNodeProps<Data extends { id: ItemId }> = {
itemData: Data;
- getItemChildren: (itemId: ItemId) => Data[];
- isItemHidden: (itemId: ItemId) => boolean;
+ getItemChildren: (itemSelector: ItemSelector) => Data[];
+ isItemHidden: (itemSelector: ItemSelector) => boolean;
renderItem: (props: TreeItemRenderProps<Data>) => React.ReactNode;
getIsExpanded: (itemSelector: ItemSelector) => boolean;
@@ -433,11 +433,11 @@ export const TreeNode = <Data extends { id: string }>({
isItemHidden,
} = commonProps;
- const itemChildren = getItemChildren(itemData.id);
-
const itemSelector = [itemData.id, ...(parentSelector ?? [])];
- const itemIsHidden = isItemHidden(itemData.id);
+ const itemChildren = getItemChildren(itemSelector);
+
+ const itemIsHidden = isItemHidden(itemSelector);
// hidden items and root are always expanded
const isAlwaysExpanded = itemIsHidden || level === 0;
diff --git a/packages/design-system/src/components/tree/tree.stories.tsx b/packages/design-system/src/components/tree/tree.stories.tsx
index 3516dceac0..c1b7ace3d0 100644
--- a/packages/design-system/src/components/tree/tree.stories.tsx
+++ b/packages/design-system/src/components/tree/tree.stories.tsx
@@ -95,7 +95,9 @@ export const StressTest = () => {
});
}}
canLeaveParent={() => true}
- getItemChildren={(itemId) => findItemById(root, itemId)?.children ?? []}
+ getItemChildren={(itemSelector) =>
+ findItemById(root, itemSelector[0])?.children ?? []
+ }
isItemHidden={(itemSelector) =>
findItemById(root, itemSelector[0])?.isHidden ?? false
}
diff --git a/packages/design-system/src/components/tree/tree.tsx b/packages/design-system/src/components/tree/tree.tsx
index 217db11054..c1f2019606 100644
--- a/packages/design-system/src/components/tree/tree.tsx
+++ b/packages/design-system/src/components/tree/tree.tsx
@@ -30,10 +30,10 @@ export type TreeProps<Data extends { id: string }> = {
dragItemSelector: undefined | ItemSelector;
dropTarget: undefined | ItemDropTarget;
- canLeaveParent: (itemId: ItemId) => boolean;
+ canLeaveParent: (itemSelector: ItemSelector) => boolean;
findClosestDroppableIndex: (itemSelector: ItemSelector) => number;
- getItemChildren: (itemId: ItemId) => Data[];
- isItemHidden: (itemId: ItemId) => boolean;
+ getItemChildren: (itemSelector: ItemSelector) => Data[];
+ isItemHidden: (itemSelector: ItemSelector) => boolean;
renderItem: (props: TreeItemRenderProps<Data>) => React.ReactNode;
onSelect?: (itemSelector: ItemSelector) => void;
@@ -211,8 +211,7 @@ export const Tree = <Data extends { id: string }>({
return false;
}
- const [dragItemId] = dragItemSelector;
- if (canLeaveParent(dragItemId) === false) {
+ if (canLeaveParent(dragItemSelector) === false) {
return false;
}
@@ -336,8 +335,8 @@ const useKeyboardNavigation = <Data extends { id: string }>({
}: {
root: Data;
selectedItemSelector: undefined | ItemSelector;
- getItemChildren: (itemId: ItemId) => Data[];
- isItemHidden: (itemId: ItemId) => boolean;
+ getItemChildren: (itemSelector: ItemSelector) => Data[];
+ isItemHidden: (itemSelector: ItemSelector) => boolean;
getIsExpanded: (itemSelector: ItemSelector) => boolean;
setIsExpanded: (
itemSelector: ItemSelector,
@@ -350,12 +349,11 @@ const useKeyboardNavigation = <Data extends { id: string }>({
const flatCurrentlyExpandedTree = useMemo(() => {
const result: ItemSelector[] = [];
const traverse = (itemSelector: ItemSelector) => {
- const [itemId] = itemSelector;
- if (isItemHidden(itemId) === false) {
+ if (isItemHidden(itemSelector) === false) {
result.push(itemSelector);
}
if (getIsExpanded(itemSelector)) {
- for (const child of getItemChildren(itemId)) {
+ for (const child of getItemChildren(itemSelector)) {
traverse([child.id, ...itemSelector]);
}
}
@@ -495,7 +493,7 @@ const useExpandState = <Data extends { id: string }>({
getItemChildren,
}: {
selectedItemSelector: undefined | ItemSelector;
- getItemChildren: (itemId: string) => Data[];
+ getItemChildren: (itemSelector: ItemSelector) => Data[];
}) => {
const [record, setRecord] = useState<Record<string, boolean>>({});
@@ -548,7 +546,7 @@ const useExpandState = <Data extends { id: string }>({
if (all) {
const newRecord = { ...record };
const addChildren = (parentSelector: string[]) => {
- for (const child of getItemChildren(parentSelector[0])) {
+ for (const child of getItemChildren(parentSelector)) {
const itemSelector = [child.id, ...parentSelector];
newRecord[itemSelector.join()] = value;
addChildren(itemSelector);