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
Replace tree preview with navigator tree (#1239)
Bogdan Chadkin863ca7468816
diff --git a/apps/builder/app/builder/builder.tsx b/apps/builder/app/builder/builder.tsxindex 43670b67cb..a9739a5b61 100644--- a/apps/builder/app/builder/builder.tsx+++ b/apps/builder/app/builder/builder.tsx@@ -11,7 +11,7 @@ import interFont from "@fontsource/inter/variable.css";// eslint-disable-next-line import/no-internal-modulesimport robotoMonoFont from "@fontsource/roboto-mono/index.css";import { useSharedShortcuts } from "~/shared/shortcuts";-import { SidebarLeft } from "./features/sidebar-left";+import { SidebarLeft, Navigator } from "./features/sidebar-left";import { Inspector } from "./features/inspector";import {isCanvasPointerEventsEnabledStore,@@ -20,7 +20,6 @@ import {import { Topbar } from "./features/topbar";import builderStyles from "./builder.css";import { Footer } from "./features/footer";-import { TreePrevew } from "./features/tree-preview";import { useUpdateCanvasWidth } from "./features/breakpoints";import {CanvasIframe,@@ -30,7 +29,6 @@ import {import { usePublishShortcuts } from "./shared/shortcuts";import {selectedPageIdStore,- useDragAndDropState,useIsPreviewMode,useSetAssets,useSetAuthPermit,@@ -44,8 +42,7 @@ import {useSetStyleSources,useSetStyleSourceSelections,} from "~/shared/nano-states";-import { useClientSettings } from "./shared/client-settings";-import { Navigator } from "./features/sidebar-left";+import { type Settings, useClientSettings } from "./shared/client-settings";import { getBuildUrl } from "~/shared/router-utils";import { useCopyPaste } from "~/shared/copy-paste";import { AssetsProvider } from "./shared/assets";@@ -155,7 +152,7 @@ const getChromeLayout = ({navigatorLayout,}: {isPreviewMode: boolean;- navigatorLayout: "docked" | "undocked";+ navigatorLayout: Settings["navigatorLayout"];}) => {if (isPreviewMode) {return {@@ -212,11 +209,15 @@ const ChromeWrapper = ({ children, isPreviewMode }: ChromeWrapperProps) => {);};-type NavigatorPanelProps = { isPreviewMode: boolean };--const NavigatorPanel = ({ isPreviewMode }: NavigatorPanelProps) => {- const navigatorLayout = useNavigatorLayout();+type NavigatorPanelProps = {+ isPreviewMode: boolean;+ navigatorLayout: "docked" | "undocked";+};+const NavigatorPanel = ({+ isPreviewMode,+ navigatorLayout,+}: NavigatorPanelProps) => {if (navigatorLayout === "docked") {return null;}@@ -292,7 +293,6 @@ export const Builder = ({usePublishShortcuts(publish);const onRefReadCanvasWidth = useUpdateCanvasWidth();const { onRef: onRefReadCanvas, onTransitionEnd } = useReadCanvasRect();- const [dragAndDropState] = useDragAndDropState();useSubscribeCanvasReady(publish);// We need to initialize this in both canvas and builder,// because the events will fire in either one, depending on where the focus is@@ -310,6 +310,8 @@ export const Builder = ({isCanvasPointerEventsEnabledStore);+ const navigatorLayout = useNavigatorLayout();+const canvasUrl = getBuildUrl({buildOrigin,project,@@ -338,17 +340,16 @@ export const Builder = ({<SidePanel gridArea="sidebar" isPreviewMode={isPreviewMode}><SidebarLeft publish={publish} /></SidePanel>- <NavigatorPanel isPreviewMode={isPreviewMode} />+ <NavigatorPanel+ isPreviewMode={isPreviewMode}+ navigatorLayout={navigatorLayout}+ /><SidePanelgridArea="inspector"isPreviewMode={isPreviewMode}css={{ overflow: "hidden" }}>- {dragAndDropState.isDragging ? (- <TreePrevew />- ) : (- <Inspector publish={publish} />- )}+ <Inspector publish={publish} navigatorLayout={navigatorLayout} /></SidePanel>{isPreviewMode === false && <Footer />}<BlockingAlerts />diff --git a/apps/builder/app/builder/features/inspector/inspector.tsx b/apps/builder/app/builder/features/inspector/inspector.tsxindex 6f4d33a39f..faf97048a4 100644--- a/apps/builder/app/builder/features/inspector/inspector.tsx+++ b/apps/builder/app/builder/features/inspector/inspector.tsx@@ -17,11 +17,17 @@ import { StylePanel } from "~/builder/features/style-panel";import { PropsPanelContainer } from "~/builder/features/props-panel";import { FloatingPanelProvider } from "~/builder/shared/floating-panel";import { theme } from "@webstudio-is/design-system";-import { selectedInstanceStore } from "~/shared/nano-states";+import {+ selectedInstanceStore,+ useDragAndDropState,+} from "~/shared/nano-states";import { SettingsPanel } from "../settings-panel";+import { NavigatorTree } from "~/builder/shared/navigator-tree";+import type { Settings } from "~/builder/shared/client-settings";type InspectorProps = {publish: Publish;+ navigatorLayout: Settings["navigatorLayout"];};const contentStyle = {@@ -30,10 +36,23 @@ const contentStyle = {overflow: "auto",};-export const Inspector = ({ publish }: InspectorProps) => {+// separate component to avoid inspetor updates on drag when navigator is undocked+const NavigatorTreePreview = () => {+ const [dragAndDropState] = useDragAndDropState();+ if (dragAndDropState.isDragging) {+ return <NavigatorTree />;+ }+ return null;+};++export const Inspector = ({ publish, navigatorLayout }: InspectorProps) => {const selectedInstance = useStore(selectedInstanceStore);const tabsRef = useRef<HTMLDivElement>(null);+ if (navigatorLayout === "docked") {+ return <NavigatorTreePreview />;+ }+if (selectedInstance === undefined) {return (<Box css={{ p: theme.spacing[5], flexBasis: "100%" }}>diff --git a/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsx b/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsxindex a06ce85ce8..e0d7b3723f 100644--- a/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsx+++ b/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsx@@ -1,16 +1,5 @@-import { useCallback, useMemo } from "react";-import { useStore } from "@nanostores/react";-import { Flex, type ItemDropTarget } from "@webstudio-is/design-system";-import {- rootInstanceStore,- selectedInstanceSelectorStore,- hoveredInstanceSelectorStore,- useDragAndDropState,- instancesStore,-} from "~/shared/nano-states";-import { InstanceTree } from "~/builder/shared/tree";-import { reparentInstance } from "~/shared/instance-utils";-import { getInstanceSelector, InstanceSelector } from "~/shared/tree-utils";+import { Flex } from "@webstudio-is/design-system";+import { NavigatorTree } from "~/builder/shared/navigator-tree";import { Header, CloseButton } from "../header";type NavigatorProps = {@@ -19,48 +8,6 @@ type NavigatorProps = {};export const Navigator = ({ isClosable, onClose }: NavigatorProps) => {- const selectedInstanceSelector = useStore(selectedInstanceSelectorStore);- const instances = useStore(instancesStore);- const rootInstance = useStore(rootInstanceStore);- const [state, setState] = useDragAndDropState();-- const dragItemSelector = useMemo(() => {- if (state.dragItem?.id === undefined) {- return;- }- return getInstanceSelector(instances, state.dragItem.id);- }, [state.dragItem, instances]);-- const dropTarget = useMemo((): undefined | ItemDropTarget => {- if (state.dropTarget === undefined) {- return;- }- return {- placement: state.dropTarget.placement,- indexWithinChildren: state.dropTarget.position,- itemSelector: getInstanceSelector(- instances,- state.dropTarget.instance.id- ),- };- }, [state.dropTarget, instances]);-- const handleDragEnd = useCallback(- (payload: {- itemSelector: InstanceSelector;- dropTarget: { itemSelector: InstanceSelector; position: number | "end" };- }) => {- reparentInstance(payload.itemSelector[0], {- parentId: payload.dropTarget.itemSelector[0],- position: payload.dropTarget.position,- });- },- []- );-- if (rootInstance === undefined) {- return null;- }return (<Flex css={{ height: "100%", flexDirection: "column" }}><Header@@ -68,38 +15,7 @@ export const Navigator = ({ isClosable, onClose }: NavigatorProps) => {suffix={isClosable && <CloseButton onClick={() => onClose?.()} />}/><Flex css={{ flexGrow: 1, flexDirection: "column" }}>- <InstanceTree- root={rootInstance}- selectedItemSelector={selectedInstanceSelector}- dragItemSelector={dragItemSelector}- dropTarget={dropTarget}- onSelect={selectedInstanceSelectorStore.set}- onHover={hoveredInstanceSelectorStore.set}- onDragItemChange={(dragItemSelector) => {- const instances = instancesStore.get();- const instance = instances.get(dragItemSelector[0]);- if (instance === undefined) {- return;- }- setState({ ...state, dragItem: instance });- }}- onDropTargetChange={(dropTarget) => {- const instances = instancesStore.get();- const instance = instances.get(dropTarget.itemSelector[0]);- if (instance === undefined) {- return;- }- setState({- ...state,- dropTarget: {- placement: dropTarget.placement,- position: dropTarget.indexWithinChildren,- instance,- },- });- }}- onDragEnd={handleDragEnd}- />+ <NavigatorTree /></Flex></Flex>);diff --git a/apps/builder/app/builder/features/tree-preview/index.ts b/apps/builder/app/builder/features/tree-preview/index.tsdeleted file mode 100644index 7b0c3f2f2e..0000000000--- a/apps/builder/app/builder/features/tree-preview/index.ts+++ /dev/null@@ -1 +0,0 @@-export * from "./tree-preview";diff --git a/apps/builder/app/builder/features/tree-preview/tree-preview.tsx b/apps/builder/app/builder/features/tree-preview/tree-preview.tsxdeleted file mode 100644index 5f60856944..0000000000--- a/apps/builder/app/builder/features/tree-preview/tree-preview.tsx+++ /dev/null@@ -1,99 +0,0 @@-import produce from "immer";-import { useMemo } from "react";-import { useStore } from "@nanostores/react";-import type { Instance } from "@webstudio-is/project-build";-import { theme, Flex } from "@webstudio-is/design-system";-import { utils } from "@webstudio-is/project";-import {- useRootInstance,- useDragAndDropState,- instancesIndexStore,-} from "~/shared/nano-states";-import { InstanceTreeNode } from "~/builder/shared/tree";-import {- type InstanceSelector,- createInstancesIndex,- getInstanceAncestorsAndSelf,- insertInstanceMutableDeprecated,- reparentInstanceMutableDeprecated,-} from "~/shared/tree-utils";--export const TreePrevew = () => {- const [rootInstance] = useRootInstance();- const instancesIndex = useStore(instancesIndexStore);- const [dragAndDropState] = useDragAndDropState();-- const dragItemInstance = dragAndDropState.dragItem;- const dropTargetInstanceId = dragAndDropState.dropTarget?.instance.id;- const dropTargetPosition = dragAndDropState.dropTarget?.position;-- const treeProps = useMemo(() => {- if (- dragItemInstance === undefined ||- dropTargetInstanceId === undefined ||- dropTargetPosition === undefined ||- rootInstance === undefined- ) {- return null;- }-- const { instancesById } = instancesIndex;- const isNew = instancesById.get(dragItemInstance.id) === undefined;-- const instance: Instance = produce<Instance>((draft) => {- const instancesIndex = createInstancesIndex(draft);- if (isNew) {- insertInstanceMutableDeprecated(- instancesIndex,- utils.tree.createInstance({ component: dragItemInstance.component }),- {- parentId: dropTargetInstanceId,- position: dropTargetPosition,- }- );- } else {- reparentInstanceMutableDeprecated(instancesIndex, dragItemInstance.id, {- parentId: dropTargetInstanceId,- position: dropTargetPosition,- });- }- })(rootInstance);-- const dragItemSelector = getInstanceAncestorsAndSelf(- createInstancesIndex(instance),- dropTargetInstanceId- )- .map((item) => item.id)- .reverse();-- const dropTargetPath = getInstanceAncestorsAndSelf(- instancesIndex,- dropTargetInstanceId- ).map((item) => item.id);-- return {- itemData: instance,- selectedItemSelector: dragItemSelector,- getIsExpanded: ([instanceId]: InstanceSelector) =>- dropTargetPath.includes(instanceId),- animate: false,- };- }, [- rootInstance,- instancesIndex,- dragItemInstance,- dropTargetInstanceId,- dropTargetPosition,- ]);-- return (- treeProps && (- <Flex- direction="column"- css={{ pt: theme.spacing[3], pb: theme.spacing[3], width: "100%" }}- >- <InstanceTreeNode {...treeProps} />- </Flex>- )- );-};diff --git a/apps/builder/app/builder/shared/client-settings/settings.ts b/apps/builder/app/builder/shared/client-settings/settings.tsindex 856b77e00f..a9479cceb4 100644--- a/apps/builder/app/builder/shared/client-settings/settings.ts+++ b/apps/builder/app/builder/shared/client-settings/settings.ts@@ -6,7 +6,7 @@ import * as config from "./config";type Name = keyof typeof config;type Value = (typeof config)[Name]["values"][number];-type Settings = Record<Name, Value>;+export type Settings = Record<Name, Value>;const defaultSettings = (Object.keys(config) as Array<Name>).reduce((acc, settingName) => {diff --git a/apps/builder/app/builder/shared/navigator-tree.tsx b/apps/builder/app/builder/shared/navigator-tree.tsxnew file mode 100644index 0000000000..bfb3dfe5de--- /dev/null+++ b/apps/builder/app/builder/shared/navigator-tree.tsx@@ -0,0 +1,93 @@+import { useCallback, useMemo } from "react";+import { useStore } from "@nanostores/react";+import {+ hoveredInstanceSelectorStore,+ instancesStore,+ rootInstanceStore,+ selectedInstanceSelectorStore,+ useDragAndDropState,+} from "~/shared/nano-states";+import { getInstanceSelector, InstanceSelector } from "~/shared/tree-utils";+import { InstanceTree } from "./tree";+import type { ItemDropTarget } from "@webstudio-is/design-system";+import { reparentInstance } from "~/shared/instance-utils";++export const NavigatorTree = () => {+ const instances = useStore(instancesStore);+ const selectedInstanceSelector = useStore(selectedInstanceSelectorStore);+ const rootInstance = useStore(rootInstanceStore);+ const [state, setState] = useDragAndDropState();++ const dragItemSelector = useMemo(() => {+ if (state.dragItem?.id === undefined) {+ return;+ }+ return getInstanceSelector(instances, state.dragItem.id);+ }, [state.dragItem, instances]);++ const dropTarget = useMemo((): undefined | ItemDropTarget => {+ if (state.dropTarget === undefined) {+ return;+ }+ return {+ placement: state.dropTarget.placement,+ indexWithinChildren: state.dropTarget.position,+ itemSelector: getInstanceSelector(+ instances,+ state.dropTarget.instance.id+ ),+ };+ }, [state.dropTarget, instances]);++ const handleDragEnd = useCallback(+ (payload: {+ itemSelector: InstanceSelector;+ dropTarget: { itemSelector: InstanceSelector; position: number | "end" };+ }) => {+ reparentInstance(payload.itemSelector[0], {+ parentId: payload.dropTarget.itemSelector[0],+ position: payload.dropTarget.position,+ });+ },+ []+ );++ if (rootInstance === undefined) {+ return null;+ }++ return (+ <InstanceTree+ root={rootInstance}+ selectedItemSelector={selectedInstanceSelector}+ dragItemSelector={dragItemSelector}+ dropTarget={dropTarget}+ onSelect={selectedInstanceSelectorStore.set}+ onHover={hoveredInstanceSelectorStore.set}+ onDragItemChange={(dragItemSelector) => {+ const instances = instancesStore.get();+ const instance = instances.get(dragItemSelector[0]);+ if (instance === undefined) {+ return;+ }+ setState({ ...state, dragItem: instance });+ }}+ onDropTargetChange={(dropTarget) => {+ const instances = instancesStore.get();+ const instance = instances.get(dropTarget.itemSelector[0]);+ if (instance === undefined) {+ return;+ }+ setState({+ ...state,+ dropTarget: {+ placement: dropTarget.placement,+ position: dropTarget.indexWithinChildren,+ instance,+ },+ });+ }}+ onDragEnd={handleDragEnd}+ />+ );+};diff --git a/apps/builder/app/builder/shared/tree/index.tsx b/apps/builder/app/builder/shared/tree/index.tsxindex 0b609ac383..03a50269f3 100644--- a/apps/builder/app/builder/shared/tree/index.tsx+++ b/apps/builder/app/builder/shared/tree/index.tsx@@ -1,11 +1,9 @@-import { useCallback, useMemo } from "react";+import { useCallback } from "react";import { useStore } from "@nanostores/react";import {Tree,TreeItemLabel,TreeItemBody,- TreeNode,- type TreeNodeProps,type TreeProps,type TreeItemRenderProps,} from "@webstudio-is/design-system";@@ -15,10 +13,9 @@ import {type WsComponentMeta,} from "@webstudio-is/react-sdk";import { instancesStore } from "~/shared/nano-states";-import { createInstancesIndex } from "~/shared/tree-utils";const instanceRelatedProps = {- renderItem(props: TreeItemRenderProps<InstancesItem | Instance>) {+ renderItem(props: TreeItemRenderProps<InstancesItem>) {const meta = getComponentMeta(props.itemData.component);if (meta === undefined) {return <></>;@@ -33,28 +30,6 @@ const instanceRelatedProps = {},} as const;-const getInstanceChildren = (instance: undefined | Instance) => {- if (instance === undefined) {- return [];- }- const meta = getComponentMeta(instance.component);-- // We want to avoid calling .filter() unnecessarily, because this is a hot path for performance.- // We rely on the fact that only rich-text or rich-text-child components may have `string` children.- if (- meta?.type === "body" ||- meta?.type === "container" ||- meta?.type === "control" ||- meta?.type === "embed"- ) {- return instance.children as Instance[];- }-- return instance.children.filter(- (child): child is Instance => child.type === "instance"- );-};-export const InstanceTree = (props: Omit<TreeProps<InstancesItem>,@@ -124,30 +99,6 @@ export const InstanceTree = ();};-export const InstanceTreeNode = (- props: Omit<TreeNodeProps<Instance>, "getItemChildren" | "renderItem">-) => {- const instancesIndex = useMemo(- () => createInstancesIndex(props.itemData),- [props.itemData]- );- const getItemChildren = useCallback(- (instanceId: Instance["id"]) => {- const instance = instancesIndex.instancesById.get(instanceId);- return getInstanceChildren(instance);- },- [instancesIndex]- );-- return (- <TreeNode- {...props}- getItemChildren={getItemChildren}- renderItem={instanceRelatedProps.renderItem}- />- );-};-export const getInstanceLabel = (instance: { label?: string },meta: WsComponentMetadiff --git a/apps/builder/app/shared/tree-utils.ts b/apps/builder/app/shared/tree-utils.tsindex fb0d80477b..ccb9d3acf5 100644--- a/apps/builder/app/shared/tree-utils.ts+++ b/apps/builder/app/shared/tree-utils.ts@@ -170,68 +170,6 @@ export const findClosestDroppableTarget = (};};-export const insertInstanceMutableDeprecated = (- instancesIndex: InstancesIndex,- instance: Instance,- dropTarget?: DroppableTarget-) => {- if (dropTarget === undefined) {- return;- }- const parentInstance = instancesIndex.instancesById.get(dropTarget.parentId);- if (parentInstance === undefined) {- return;- }- const { position } = dropTarget;- if (position === "end") {- parentInstance.children.push(instance);- } else {- parentInstance.children.splice(position, 0, instance);- }-};--export const reparentInstanceMutableDeprecated = (- instancesIndex: InstancesIndex,- instanceId: Instance["id"],- dropTarget: DroppableTarget-) => {- const prevParent = instancesIndex.parentInstancesById.get(instanceId);- const nextParent = instancesIndex.instancesById.get(dropTarget.parentId);- const instance = instancesIndex.instancesById.get(instanceId);- if (- prevParent === undefined ||- nextParent === undefined ||- instance === undefined- ) {- return;- }-- const prevPosition = prevParent.children.findIndex(- (child) => child.type === "instance" && child.id === instanceId- );- if (prevPosition === -1) {- return;- }-- // if parent is the same, we need to adjust the position- // to account for the removal of the instance.- let nextPosition = dropTarget.position;- if (- nextPosition !== "end" &&- prevParent.id === nextParent.id &&- prevPosition < nextPosition- ) {- nextPosition -= 1;- }-- prevParent.children.splice(prevPosition, 1);- if (nextPosition === "end") {- nextParent.children.push(instance);- } else {- nextParent.children.splice(nextPosition, 0, instance);- }-};-export const reparentInstanceMutable = (instances: Instances,instanceSelector: InstanceSelector,