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 selected outline with store (#1317)

Bogdan Chadkin2c7184c06903
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/canvas-tools.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/canvas-tools.tsx
index f5620bd7b4..29f9efbbcb 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/canvas-tools.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/canvas-tools.tsx
@@ -10,7 +10,6 @@ import {
} from "~/shared/nano-states";
import { HoveredInstanceOutline, SelectedInstanceOutline } from "./outline";
import { TextToolbar } from "./text-toolbar";
-import { useSubscribeInstanceRect } from "./hooks/use-subscribe-instance-rect";
import { useSubscribeSwitchPage } from "~/shared/pages";
import { Label } from "./outline/label";
import { Outline } from "./outline/outline";
@@ -31,7 +30,6 @@ type CanvasToolsProps = {
export const CanvasTools = ({ publish }: CanvasToolsProps) => {
// @todo try to setup cross-frame atoms to vaoid this
- useSubscribeInstanceRect();
useSubscribeDragAndDropState();
useSubscribeSwitchPage();
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/hooks/use-subscribe-instance-rect.ts b/apps/builder/app/builder/features/workspace/canvas-tools/hooks/use-subscribe-instance-rect.ts
deleted file mode 100644
index 3f02ba8991..0000000000
--- a/apps/builder/app/builder/features/workspace/canvas-tools/hooks/use-subscribe-instance-rect.ts
+++ /dev/null
@@ -1,10 +0,0 @@
-import { useSubscribe } from "~/shared/pubsub";
-import { useSelectedInstanceOutline } from "~/shared/nano-states";
-
-export const useSubscribeInstanceRect = () => {
- const [selectedInstanceOutline, setSelectedInstanceOutline] =
- useSelectedInstanceOutline();
- useSubscribe("updateSelectedInstanceOutline", (value) => {
- setSelectedInstanceOutline({ ...selectedInstanceOutline, ...value });
- });
-};
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/outline/hovered-instance-outline.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/outline/hovered-instance-outline.tsx
index c66cf0cd25..adb87392fb 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/outline/hovered-instance-outline.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/outline/hovered-instance-outline.tsx
@@ -1,18 +1,18 @@
import { useStore } from "@nanostores/react";
import {
hoveredInstanceSelectorStore,
- hoveredInstanceOutlineStore,
selectedInstanceSelectorStore,
} from "~/shared/nano-states";
import { textEditingInstanceSelectorStore } from "~/shared/nano-states/instances";
import { areInstanceSelectorsEqual } from "~/shared/tree-utils";
import { Outline } from "./outline";
import { Label } from "./label";
+import { hoveredInstanceOutlineAndInstanceStore } from "~/shared/nano-states/canvas";
export const HoveredInstanceOutline = () => {
const selectedInstanceSelector = useStore(selectedInstanceSelectorStore);
const hoveredInstanceSelector = useStore(hoveredInstanceSelectorStore);
- const instanceOutline = useStore(hoveredInstanceOutlineStore);
+ const outline = useStore(hoveredInstanceOutlineAndInstanceStore);
const textEditingInstanceSelector = useStore(
textEditingInstanceSelectorStore
);
@@ -23,17 +23,13 @@ export const HoveredInstanceOutline = () => {
hoveredInstanceSelector
);
- if (
- instanceOutline === undefined ||
- isHoveringSelectedInstance ||
- isEditingText
- ) {
+ if (outline === undefined || isHoveringSelectedInstance || isEditingText) {
return null;
}
return (
- <Outline rect={instanceOutline.rect}>
- <Label instance={instanceOutline} instanceRect={instanceOutline.rect} />
+ <Outline rect={outline.rect}>
+ <Label instance={outline.instance} instanceRect={outline.rect} />
</Outline>
);
};
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/outline/selected-instance-outline.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/outline/selected-instance-outline.tsx
index 65fe4fb019..c1e6c76298 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/outline/selected-instance-outline.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/outline/selected-instance-outline.tsx
@@ -1,18 +1,14 @@
import { useStore } from "@nanostores/react";
-import {
- selectedInstanceSelectorStore,
- selectedInstanceStore,
- useSelectedInstanceOutline,
-} from "~/shared/nano-states";
+import { selectedInstanceSelectorStore } from "~/shared/nano-states";
import { textEditingInstanceSelectorStore } from "~/shared/nano-states/instances";
+import { selectedInstanceOutlineAndInstanceStore } from "~/shared/nano-states/canvas";
import { areInstanceSelectorsEqual } from "~/shared/tree-utils";
import { Outline } from "./outline";
import { Label } from "./label";
export const SelectedInstanceOutline = () => {
- const [{ rect, visible }] = useSelectedInstanceOutline();
+ const outline = useStore(selectedInstanceOutlineAndInstanceStore);
const selectedInstanceSelector = useStore(selectedInstanceSelectorStore);
- const selectedInstance = useStore(selectedInstanceStore);
const textEditingInstanceSelector = useStore(
textEditingInstanceSelectorStore
);
@@ -24,18 +20,13 @@ export const SelectedInstanceOutline = () => {
selectedInstanceSelector
);
- if (
- selectedInstance === undefined ||
- isEditingCurrentInstance ||
- visible === false ||
- rect === undefined
- ) {
+ if (isEditingCurrentInstance || outline === undefined) {
return null;
}
return (
- <Outline rect={rect}>
- <Label instance={selectedInstance} instanceRect={rect} />
+ <Outline rect={outline.rect}>
+ <Label instance={outline.instance} instanceRect={outline.rect} />
</Outline>
);
};
diff --git a/apps/builder/app/canvas/features/webstudio-component/selected-instance-connector.ts b/apps/builder/app/canvas/features/webstudio-component/selected-instance-connector.ts
index dd5dc60560..66a447002f 100644
--- a/apps/builder/app/canvas/features/webstudio-component/selected-instance-connector.ts
+++ b/apps/builder/app/canvas/features/webstudio-component/selected-instance-connector.ts
@@ -2,7 +2,7 @@ import { useEffect } from "react";
import { useStore } from "@nanostores/react";
import type { Instance, Prop, StyleDecl } from "@webstudio-is/project-build";
import { getBrowserStyle } from "@webstudio-is/react-sdk";
-import { publish, subscribe } from "~/shared/pubsub";
+import { subscribe } from "~/shared/pubsub";
import { subscribeWindowResize } from "~/shared/dom-hooks";
import {
rootInstanceContainer,
@@ -10,42 +10,17 @@ import {
} from "~/shared/nano-states";
import { getAllElementsBoundingBox } from "~/shared/dom-utils";
import { subscribeScrollState } from "~/canvas/shared/scroll-state";
+import { selectedInstanceOutlineStore } from "~/shared/nano-states/canvas";
-declare module "~/shared/pubsub" {
- export interface PubsubMap {
- updateSelectedInstanceOutline: {
- visible?: boolean;
- rect?: DOMRect;
- };
- }
-}
-
-const updateOutlineRect = (element: HTMLElement) => {
- publish({
- type: "updateSelectedInstanceOutline",
- payload: {
- rect: getAllElementsBoundingBox(element),
- },
- });
-};
-
-const showOutline = (element: HTMLElement) => {
- publish({
- type: "updateSelectedInstanceOutline",
- payload: {
- visible: true,
- rect: getAllElementsBoundingBox(element),
- },
+const setOutline = (instanceId: Instance["id"], element: HTMLElement) => {
+ selectedInstanceOutlineStore.set({
+ instanceId,
+ rect: getAllElementsBoundingBox(element),
});
};
const hideOutline = () => {
- publish({
- type: "updateSelectedInstanceOutline",
- payload: {
- visible: false,
- },
- });
+ selectedInstanceOutlineStore.set(undefined);
};
export const SelectedInstanceConnector = ({
@@ -68,19 +43,19 @@ export const SelectedInstanceConnector = ({
// effect close to rendered element also catches dnd remounts
// so actual state is always provided here
- showOutline(element);
+ setOutline(instance.id, element);
const resizeObserver = new ResizeObserver(() => {
// contentRect has wrong x/y values for absolutely positioned element.
// getBoundingClientRect is used instead.
- updateOutlineRect(element);
+ setOutline(instance.id, element);
});
resizeObserver.observe(element);
// detect movement of the element within same parent
// React prevent remount when key stays the same
const mutationObserver = new window.MutationObserver(() => {
- updateOutlineRect(element);
+ setOutline(instance.id, element);
});
const parent = element?.parentElement;
if (parent) {
@@ -99,7 +74,7 @@ export const SelectedInstanceConnector = ({
hideOutline();
},
onScrollEnd() {
- showOutline(element);
+ setOutline(instance.id, element);
},
});
@@ -108,7 +83,7 @@ export const SelectedInstanceConnector = ({
hideOutline();
},
onResizeEnd() {
- showOutline(element);
+ setOutline(instance.id, element);
},
});
diff --git a/apps/builder/app/canvas/instance-hovering.ts b/apps/builder/app/canvas/instance-hovering.ts
index b935ddf651..9d772ea2b2 100644
--- a/apps/builder/app/canvas/instance-hovering.ts
+++ b/apps/builder/app/canvas/instance-hovering.ts
@@ -2,9 +2,9 @@ import debounce from "lodash.debounce";
import { idAttribute } from "@webstudio-is/react-sdk";
import {
hoveredInstanceSelectorStore,
- hoveredInstanceOutlineStore,
instancesStore,
} from "~/shared/nano-states";
+import { hoveredInstanceOutlineStore } from "~/shared/nano-states/canvas";
import {
getAllElementsBoundingBox,
getElementByInstanceSelector,
@@ -62,8 +62,7 @@ export const subscribeInstanceHovering = () => {
return;
}
hoveredInstanceOutlineStore.set({
- label: instance.label,
- component: instance.component,
+ instanceId: instance.id,
rect: getAllElementsBoundingBox(element),
});
}, 50);
diff --git a/apps/builder/app/shared/nano-states/canvas.ts b/apps/builder/app/shared/nano-states/canvas.ts
index 5eced90969..0e90dcabc9 100644
--- a/apps/builder/app/shared/nano-states/canvas.ts
+++ b/apps/builder/app/shared/nano-states/canvas.ts
@@ -1,4 +1,6 @@
-import { atom } from "nanostores";
+import { atom, computed } from "nanostores";
+import type { Instance, Instances } from "@webstudio-is/project-build";
+import { instancesStore } from "./nano-states";
export type TextToolbarState = {
selectionRect: undefined | DOMRect;
@@ -12,6 +14,49 @@ export type TextToolbarState = {
export const textToolbarStore = atom<undefined | TextToolbarState>(undefined);
+type InstanceOutline = {
+ instanceId: Instance["id"];
+ rect: DOMRect;
+};
+
+const getInstanceOutlineAndInstance = (
+ instances: Instances,
+ instanceOutline: undefined | InstanceOutline
+) => {
+ if (instanceOutline === undefined) {
+ return;
+ }
+ const { instanceId, rect } = instanceOutline;
+ const instance = instances.get(instanceId);
+ if (instance === undefined) {
+ return;
+ }
+ return {
+ instance,
+ rect,
+ };
+};
+
+export const selectedInstanceOutlineStore = atom<undefined | InstanceOutline>(
+ undefined
+);
+
+export const selectedInstanceOutlineAndInstanceStore = computed(
+ [instancesStore, selectedInstanceOutlineStore],
+ getInstanceOutlineAndInstance
+);
+
+export const hoveredInstanceOutlineStore = atom<undefined | InstanceOutline>(
+ undefined
+);
+
+export const hoveredInstanceOutlineAndInstanceStore = computed(
+ [instancesStore, hoveredInstanceOutlineStore],
+ getInstanceOutlineAndInstance
+);
+
export const synchronizedCanvasStores = [
["textToolbar", textToolbarStore],
+ ["selectedInstanceOutline", selectedInstanceOutlineStore],
+ ["hoveredInstanceOutline", hoveredInstanceOutlineStore],
] as const;
diff --git a/apps/builder/app/shared/nano-states/nano-states.ts b/apps/builder/app/shared/nano-states/nano-states.ts
index 292ec75bc1..48a7829c77 100644
--- a/apps/builder/app/shared/nano-states/nano-states.ts
+++ b/apps/builder/app/shared/nano-states/nano-states.ts
@@ -382,9 +382,6 @@ export const selectedStyleSourceStore = computed(
export const hoveredInstanceSelectorStore = atom<undefined | InstanceSelector>(
undefined
);
-export const hoveredInstanceOutlineStore = atom<
- undefined | { label?: string; component: string; rect: DOMRect }
->(undefined);
export const isPreviewModeStore = atom<boolean>(false);
export const useIsPreviewMode = () => useValue(isPreviewModeStore);
@@ -410,16 +407,6 @@ export const useSetAuthToken = (authToken: string | undefined) => {
});
};
-const selectedInstanceOutlineContainer = atom<{
- visible: boolean;
- rect?: DOMRect;
-}>({
- visible: false,
- rect: undefined,
-});
-export const useSelectedInstanceOutline = () =>
- useValue(selectedInstanceOutlineContainer);
-
export type DragAndDropState = {
isDragging: boolean;
dropTarget?: ItemDropTarget;
diff --git a/apps/builder/app/shared/sync/sync-stores.ts b/apps/builder/app/shared/sync/sync-stores.ts
index 7c681fcb9c..0d237f13bd 100644
--- a/apps/builder/app/shared/sync/sync-stores.ts
+++ b/apps/builder/app/shared/sync/sync-stores.ts
@@ -16,7 +16,6 @@ import {
selectedInstanceSelectorStore,
selectedInstanceBrowserStyleStore,
hoveredInstanceSelectorStore,
- hoveredInstanceOutlineStore,
isPreviewModeStore,
} from "~/shared/nano-states";
import { synchronizedBreakpointsStores } from "~/shared/nano-states/breakpoints";
@@ -68,7 +67,6 @@ export const registerContainers = () => {
selectedInstanceBrowserStyleStore
);
clientStores.set("hoveredInstanceSelector", hoveredInstanceSelectorStore);
- clientStores.set("hoveredInstanceOutline", hoveredInstanceOutlineStore);
clientStores.set("isPreviewMode", isPreviewModeStore);
for (const [name, store] of synchronizedBreakpointsStores) {
clientStores.set(name, store);