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.
TypeScript accessibilityalternativecloudflarecloudflare-workersdesignfreefrontendopen-sourceradix-uireactremixweb-developmentwebflowwebsite-builderwebsite-developmentwebsiteswebstudio
Refactor tree node with selectors (#1264)
Bogdan Chadkincde929f344d1
diff --git a/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsx b/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsxindex b61e49e682..bb98efa91f 100644--- a/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsx+++ b/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsx@@ -1,20 +1,15 @@import { useCallback } from "react";import { useStore } from "@nanostores/react";import { Flex } from "@webstudio-is/design-system";-import type { Instance } from "@webstudio-is/project-build";import {selectedInstanceSelectorStore,hoveredInstanceSelectorStore,useRootInstance,- instancesStore,} from "~/shared/nano-states";import { InstanceTree } from "~/builder/shared/tree";import { reparentInstance } from "~/shared/instance-utils";+import type { InstanceSelector } from "~/shared/tree-utils";import { Header, CloseButton } from "../header";-import {- getInstanceSelector,- type InstanceSelector,-} from "~/shared/tree-utils";type NavigatorProps = {isClosable?: boolean;@@ -25,12 +20,6 @@ export const Navigator = ({ isClosable, onClose }: NavigatorProps) => {const selectedInstanceSelector = useStore(selectedInstanceSelectorStore);const [rootInstance] = useRootInstance();- const handleSelect = useCallback((instanceId: Instance["id"]) => {- const instances = instancesStore.get();- const instanceSelector = getInstanceSelector(instances, instanceId);- selectedInstanceSelectorStore.set(instanceSelector);- }, []);-const handleDragEnd = useCallback((payload: {itemSelector: InstanceSelector;@@ -44,16 +33,6 @@ export const Navigator = ({ isClosable, onClose }: NavigatorProps) => {[]);- const handleHover = useCallback((instance: Instance | undefined) => {- if (instance) {- const instances = instancesStore.get();- const instanceSelector = getInstanceSelector(instances, instance.id);- hoveredInstanceSelectorStore.set(instanceSelector);- } else {- hoveredInstanceSelectorStore.set(undefined);- }- }, []);-if (rootInstance === undefined) {return null;}@@ -67,9 +46,8 @@ export const Navigator = ({ isClosable, onClose }: NavigatorProps) => {<InstanceTreeroot={rootInstance}selectedItemSelector={selectedInstanceSelector}- // @todo provide in callback instance selector instead of just id- onSelect={handleSelect}- onHover={handleHover}+ onSelect={selectedInstanceSelectorStore.set}+ onHover={hoveredInstanceSelectorStore.set}onDragEnd={handleDragEnd}/></Flex>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.tsxindex b349a010a1..712bb311c6 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@@ -6,6 +6,7 @@ import {TreeItemBody,TreeNode,type TreeItemRenderProps,+ type ItemSelector,styled,Flex,Tooltip,@@ -150,7 +151,7 @@ const PagesPanel = ({suffix={onEdit && (<ItemSuffix- isParentSelected={props.selectedItemId === props.itemData.id}+ isParentSelected={props.parentIsSelected ?? false}itemId={props.itemData.id}editingItemId={editingPageId}onEdit={onEdit}@@ -169,6 +170,11 @@ const PagesPanel = ({[editingPageId, onEdit]);+ const selectTreeNode = useCallback(+ ([pageId]: ItemSelector) => onSelect(pageId),+ [onSelect]+ );+if (pagesTree === undefined) {return null;}@@ -204,8 +210,8 @@ const PagesPanel = ({/><TreeNodehideRoot- selectedItemId={selectedPageId}- onSelect={onSelect}+ selectedItemSelector={[selectedPageId, pagesTree.id]}+ onSelect={selectTreeNode}itemData={pagesTree}renderItem={renderItem}getItemChildren={(nodeId) => {diff --git a/apps/builder/app/builder/features/tree-preview/tree-preview.tsx b/apps/builder/app/builder/features/tree-preview/tree-preview.tsxindex 1d5fc6181f..5f60856944 100644--- a/apps/builder/app/builder/features/tree-preview/tree-preview.tsx+++ b/apps/builder/app/builder/features/tree-preview/tree-preview.tsx@@ -11,6 +11,7 @@ import {} from "~/shared/nano-states";import { InstanceTreeNode } from "~/builder/shared/tree";import {+ type InstanceSelector,createInstancesIndex,getInstanceAncestorsAndSelf,insertInstanceMutableDeprecated,@@ -58,6 +59,13 @@ export const TreePrevew = () => {}})(rootInstance);+ const dragItemSelector = getInstanceAncestorsAndSelf(+ createInstancesIndex(instance),+ dropTargetInstanceId+ )+ .map((item) => item.id)+ .reverse();+const dropTargetPath = getInstanceAncestorsAndSelf(instancesIndex,dropTargetInstanceId@@ -65,9 +73,9 @@ export const TreePrevew = () => {return {itemData: instance,- selectedItemId: dragItemInstance.id,- getIsExpanded: (instance: Instance) =>- dropTargetPath.includes(instance.id),+ selectedItemSelector: dragItemSelector,+ getIsExpanded: ([instanceId]: InstanceSelector) =>+ dropTargetPath.includes(instanceId),animate: false,};}, [diff --git a/packages/design-system/src/components/tree/index.ts b/packages/design-system/src/components/tree/index.tsindex 040ff37e1a..173fbc95cf 100644--- a/packages/design-system/src/components/tree/index.ts+++ b/packages/design-system/src/components/tree/index.ts@@ -1,2 +1,3 @@+export type { ItemSelector } from "./item-utils";export * from "./tree";export * from "./tree-node";diff --git a/packages/design-system/src/components/tree/tree-node.tsx b/packages/design-system/src/components/tree/tree-node.tsxindex 6c10ae63b9..5451c2d721 100644--- a/packages/design-system/src/components/tree/tree-node.tsx+++ b/packages/design-system/src/components/tree/tree-node.tsx@@ -7,7 +7,11 @@ import { Flex } from "../flex";import { DeprecatedText2 } from "../__DEPRECATED__/text2";import { keyframes, styled } from "../../stitches.config";import { theme } from "../../stitches.config";-import type { ItemId } from "./item-utils";+import {+ type ItemId,+ type ItemSelector,+ areItemSelectorsEqual,+} from "./item-utils";export const INDENT = 16;const ITEM_HEIGHT = 32;@@ -241,13 +245,14 @@ const useScrollIntoView = (};export type TreeItemRenderProps<Data extends { id: string }> = {- dropTargetItemId?: string;- onMouseEnter?: (item: Data) => void;- onMouseLeave?: (item: Data) => void;+ onMouseEnter?: (itemSelector: ItemSelector) => void;+ onMouseLeave?: (itemSelector: ItemSelector) => void;itemData: Data;+ itemSelector: ItemSelector;+ dropTargetItemSelector?: ItemSelector;parentIsSelected?: boolean;- selectedItemId?: string;- onSelect?: (itemId: string) => void;+ isSelected?: boolean;+ onSelect?: (itemSelector: ItemSelector) => void;level: number;isAlwaysExpanded: boolean;shouldRenderExpandButton: boolean;@@ -256,13 +261,14 @@ export type TreeItemRenderProps<Data extends { id: string }> = {export const TreeItemBody = <Data extends { id: string }>({isAlwaysExpanded,- selectedItemId,onSelect,- parentIsSelected,- dropTargetItemId,+ parentIsSelected = false,+ isSelected = false,+ dropTargetItemSelector,onMouseEnter,onMouseLeave,itemData,+ itemSelector,level,shouldRenderExpandButton,isExpanded,@@ -305,13 +311,15 @@ export const TreeItemBody = <Data extends { id: string }>({return {};}return selectionEvent === "click"- ? { handleClick: () => onSelect(itemData.id) }- : { handleFocus: () => onSelect(itemData.id) };- }, [selectionEvent, onSelect, itemData.id]);-- const isSelected = itemData.id === selectedItemId;- const isDragging = dropTargetItemId !== undefined;- const isDropTarget = dropTargetItemId === itemData.id;+ ? { handleClick: () => onSelect(itemSelector) }+ : { handleFocus: () => onSelect(itemSelector) };+ }, [selectionEvent, onSelect, itemSelector]);++ const isDragging = dropTargetItemSelector !== undefined;+ const isDropTarget = areItemSelectorsEqual(+ dropTargetItemSelector,+ itemSelector+ );useScrollIntoView(itemButtonRef.current, {isSelected,@@ -321,8 +329,8 @@ export const TreeItemBody = <Data extends { id: string }>({return (<ItemContainer- onMouseEnter={onMouseEnter && (() => onMouseEnter(itemData))}- onMouseLeave={onMouseLeave && (() => onMouseLeave(itemData))}+ onMouseEnter={onMouseEnter && (() => onMouseEnter(itemSelector))}+ onMouseLeave={onMouseLeave && (() => onMouseLeave(itemSelector))}isSelected={isSelected}parentIsSelected={parentIsSelected}enableHoverState={isDragging === false}@@ -389,40 +397,40 @@ export type TreeNodeProps<Data extends { id: ItemId }> = {getItemChildren: (itemId: ItemId) => Data[];renderItem: (props: TreeItemRenderProps<Data>) => React.ReactNode;- getIsExpanded: (item: Data) => boolean;- setIsExpanded?: (item: Data, expanded: boolean) => void;+ getIsExpanded: (itemSelector: ItemSelector) => boolean;+ setIsExpanded?: (itemSelector: ItemSelector, expanded: boolean) => void;onExpandTransitionEnd?: () => void;- selectedItemId?: string;+ selectedItemSelector?: ItemSelector;+ dropTargetItemSelector?: ItemSelector;+ parentSelector?: ItemSelector;+parentIsSelected?: boolean;- onSelect?: (itemId: string) => void;- onMouseEnter?: (item: Data) => void;- onMouseLeave?: (item: Data) => void;+ onSelect?: (itemSelector: ItemSelector) => void;+ onMouseEnter?: (itemSelector: ItemSelector) => void;+ onMouseLeave?: (itemSelector: ItemSelector) => void;- level?: number;animate?: boolean;- dropTargetItemId?: string;-hideRoot?: boolean;};export const TreeNode = <Data extends { id: string }>({itemData,- level = 0,+ parentSelector,parentIsSelected,- hideRoot,+ hideRoot = false,...commonProps}: TreeNodeProps<Data>) => {const {getIsExpanded,animate = true,setIsExpanded,- selectedItemId,+ selectedItemSelector,onSelect,onMouseEnter,onMouseLeave,onExpandTransitionEnd,- dropTargetItemId,+ dropTargetItemSelector,renderItem,getItemChildren,} = commonProps;@@ -431,10 +439,21 @@ export const TreeNode = <Data extends { id: string }>({const itemChildren = getItemChildren(itemData.id);- const isAlwaysExpanded = level === 0;+ const itemSelector = [itemData.id, ...(parentSelector ?? [])];++ const isAlwaysExpanded =+ // root is always expanded+ parentSelector === undefined ||+ // or root children when root is hidden+ (hideRoot && parentSelector.length === 1);+ let level = parentSelector?.length ?? 0;+ // reduce level when root is hidden+ if (hideRoot && level !== 0) {+ level -= 1;+ }const isExpandable = itemChildren.length > 0;- const isExpanded = getIsExpanded(itemData) || isAlwaysExpanded;- const isSelected = itemData.id === selectedItemId;+ const isExpanded = getIsExpanded(itemSelector) || isAlwaysExpanded;+ const isSelected = areItemSelectorsEqual(itemSelector, selectedItemSelector);const shouldRenderExpandButton = isExpandable && isAlwaysExpanded === false;@@ -463,17 +482,19 @@ export const TreeNode = <Data extends { id: string }>({return (<Collapsible.Rootopen={isExpanded}- onOpenChange={(isOpen) => setIsExpanded?.(itemData, isOpen)}+ onOpenChange={(isOpen) => setIsExpanded?.(itemSelector, isOpen)}data-drop-target-id={itemData.id}>- {hideRoot !== true &&+ {/* optionally prevent rendering root item */}+ {(parentSelector !== undefined || hideRoot !== true) &&renderItem({- dropTargetItemId,+ dropTargetItemSelector,onMouseEnter,onMouseLeave,itemData,+ itemSelector,parentIsSelected,- selectedItemId,+ isSelected,onSelect,level,isAlwaysExpanded,@@ -492,8 +513,9 @@ export const TreeNode = <Data extends { id: string }>({<TreeNodekey={child.id}itemData={child}- level={hideRoot ? level : level + 1}+ parentSelector={itemSelector}parentIsSelected={isSelected || parentIsSelected}+ hideRoot={hideRoot}{...commonProps}/>))diff --git a/packages/design-system/src/components/tree/tree.stories.tsx b/packages/design-system/src/components/tree/tree.stories.tsxindex abd09ed26b..01e8d84297 100644--- a/packages/design-system/src/components/tree/tree.stories.tsx+++ b/packages/design-system/src/components/tree/tree.stories.tsx@@ -83,13 +83,7 @@ export const StressTest = ({ animate }: { animate: boolean }) => {animate={animate}root={root}selectedItemSelector={selectedItemSelector}- onSelect={(instanceId) => {- setSelectedItemSelector(- getItemPath(root, instanceId)- .reverse()- .map((item) => item.id)- );- }}+ onSelect={setSelectedItemSelector}renderItem={(props) => (<TreeItemBody {...props}><TreeItemLabel>{props.itemData.id}</TreeItemLabel>diff --git a/packages/design-system/src/components/tree/tree.tsx b/packages/design-system/src/components/tree/tree.tsxindex 47bee21c5e..cc69d378a4 100644--- a/packages/design-system/src/components/tree/tree.tsx+++ b/packages/design-system/src/components/tree/tree.tsx@@ -32,8 +32,8 @@ export type TreeProps<Data extends { id: string }> = {getItemChildren: (itemId: ItemId) => Data[];renderItem: (props: TreeItemRenderProps<Data>) => React.ReactNode;- onSelect?: (itemId: string) => void;- onHover?: (item: Data | undefined) => void;+ onSelect?: (itemSelector: ItemSelector) => void;+ onHover?: (itemSelector: undefined | ItemSelector) => void;animate?: boolean;onDragEnd: (event: {itemSelector: ItemSelector;@@ -206,12 +206,11 @@ export const Tree = <Data extends { id: string }>({return instance;},onStart: ({ data }) => {- onSelect?.(data.id);- setDragItemSelector(- getItemPath(root, data.id)- .reverse()- .map((item) => item.id)- );+ const itemSelector = getItemPath(root, data.id)+ .reverse()+ .map((item) => item.id);+ onSelect?.(itemSelector);+ setDragItemSelector(itemSelector);dropHandlers.handleStart();autoScrollHandlers.setEnabled(true);},@@ -255,13 +254,6 @@ export const Tree = <Data extends { id: string }>({onEsc: dragHandlers.cancelCurrentDrag,});- const [onMouseEnter, onMouseLeave] = useMemo(() => {- if (onHover === undefined) {- return [undefined, undefined];- }- return [(item: Data) => onHover(item), () => onHover(undefined)] as const;- }, [onHover]);-return (<Boxcss={{@@ -290,25 +282,14 @@ export const Tree = <Data extends { id: string }>({getItemChildren={getItemChildren}animate={animate}onSelect={onSelect}- onMouseEnter={onMouseEnter}- onMouseLeave={onMouseLeave}- selectedItemId={selectedItemSelector?.[0]}+ onMouseEnter={onHover}+ onMouseLeave={onHover}+ selectedItemSelector={selectedItemSelector}itemData={root}- level={0}- 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);- }}+ getIsExpanded={getIsExpanded}+ setIsExpanded={setIsExpanded}onExpandTransitionEnd={dropHandlers.handleDomMutation}- dropTargetItemId={shiftedDropTarget?.itemSelector[0]}+ dropTargetItemSelector={shiftedDropTarget?.itemSelector}/></Box>