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.

Improve instance hovering (#1236)

Bogdan Chadkine0553200e967
diff --git a/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsx b/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsx
index 9fae7421d3..914ba9748b 100644
--- a/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsx
+++ b/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsx
@@ -4,7 +4,7 @@ import { Flex } from "@webstudio-is/design-system";
import type { Instance } from "@webstudio-is/project-build";
import {
selectedInstanceSelectorStore,
- hoveredInstanceIdStore,
+ hoveredInstanceSelectorStore,
useRootInstance,
instancesStore,
} from "~/shared/nano-states";
@@ -43,7 +43,13 @@ export const Navigator = ({ isClosable, onClose }: NavigatorProps) => {
);
const handleHover = useCallback((instance: Instance | undefined) => {
- hoveredInstanceIdStore.set(instance?.id);
+ if (instance) {
+ const instances = instancesStore.get();
+ const instanceSelector = getInstanceSelector(instances, instance.id);
+ hoveredInstanceSelectorStore.set(instanceSelector);
+ } else {
+ hoveredInstanceSelectorStore.set(undefined);
+ }
}, []);
if (rootInstance === undefined) {
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 5d4dbb64f0..cd56c89eb3 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,31 +1,27 @@
import { useStore } from "@nanostores/react";
import {
- hoveredInstanceIdStore,
+ hoveredInstanceSelectorStore,
hoveredInstanceOutlineStore,
- instancesStore,
selectedInstanceSelectorStore,
useTextEditingInstanceId,
} from "~/shared/nano-states";
+import { areInstanceSelectorsEqual } from "~/shared/tree-utils";
import { Outline } from "./outline";
import { Label } from "./label";
export const HoveredInstanceOutline = () => {
const selectedInstanceSelector = useStore(selectedInstanceSelectorStore);
- const hoveredInstanceId = useStore(hoveredInstanceIdStore);
+ const hoveredInstanceSelector = useStore(hoveredInstanceSelectorStore);
const instanceOutline = useStore(hoveredInstanceOutlineStore);
const [textEditingInstanceId] = useTextEditingInstanceId();
- const instances = useStore(instancesStore);
const isEditingText = textEditingInstanceId !== undefined;
- // @todo compare instance selectors
- const isHoveringSelectedInstance =
- selectedInstanceSelector?.[0] === hoveredInstanceId;
- const instance = hoveredInstanceId
- ? instances.get(hoveredInstanceId)
- : undefined;
+ const isHoveringSelectedInstance = areInstanceSelectorsEqual(
+ selectedInstanceSelector,
+ hoveredInstanceSelector
+ );
if (
- instance === undefined ||
instanceOutline === undefined ||
isHoveringSelectedInstance ||
isEditingText
@@ -35,7 +31,7 @@ export const HoveredInstanceOutline = () => {
return (
<Outline rect={instanceOutline.rect}>
- <Label instance={instance} instanceRect={instanceOutline.rect} />
+ <Label instance={instanceOutline} instanceRect={instanceOutline.rect} />
</Outline>
);
};
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsx
index b25ab02aba..e533999e0c 100644
--- a/apps/builder/app/canvas/canvas.tsx
+++ b/apps/builder/app/canvas/canvas.tsx
@@ -34,10 +34,10 @@ import { usePublishScrollState } from "./shared/use-publish-scroll-state";
import { useDragAndDrop } from "./shared/use-drag-drop";
import { useSubscribeBuilderReady } from "./shared/use-builder-ready";
import { useCopyPaste } from "~/shared/copy-paste";
-import { useHoveredInstanceConnector } from "./hovered-instance-connector";
import { setDataCollapsed, subscribeCollapsedToPubSub } from "./collapsed";
import { useWindowResizeDebounced } from "~/shared/dom-hooks";
import { subscribeInstanceSelection } from "./instance-selection";
+import { subscribeInstanceHovering } from "./instance-hovering";
registerContainers();
@@ -82,9 +82,9 @@ const DesignMode = () => {
// @todo we need to forward the events from canvas to builder and avoid importing this
// in both places
useCopyPaste();
- useHoveredInstanceConnector();
useEffect(subscribeInstanceSelection, []);
+ useEffect(subscribeInstanceHovering, []);
return null;
};
diff --git a/apps/builder/app/canvas/hovered-instance-connector.ts b/apps/builder/app/canvas/instance-hovering.ts
similarity index 73%
rename from apps/builder/app/canvas/hovered-instance-connector.ts
rename to apps/builder/app/canvas/instance-hovering.ts
index 9e47128a22..3663475a67 100644
--- a/apps/builder/app/canvas/hovered-instance-connector.ts
+++ b/apps/builder/app/canvas/instance-hovering.ts
@@ -1,23 +1,26 @@
-import { useEffect } from "react";
import debounce from "lodash.debounce";
import { idAttribute } from "@webstudio-is/react-sdk";
import {
- hoveredInstanceIdStore,
+ hoveredInstanceSelectorStore,
hoveredInstanceOutlineStore,
+ instancesStore,
} from "~/shared/nano-states";
import { subscribeScrollState } from "~/shared/dom-hooks";
+import {
+ getElementByInstanceSelector,
+ getInstanceSelectorFromElement,
+} from "~/shared/dom-utils";
type TimeoutId = undefined | ReturnType<typeof setTimeout>;
-const startHoveredInstanceConnection = () => {
+export const subscribeInstanceHovering = () => {
let hoveredElement: undefined | Element = undefined;
const updateHoveredInstance = (element: Element) => {
- const id = element.getAttribute(idAttribute) ?? undefined;
- if (id === undefined) {
- return;
+ const instanceSelector = getInstanceSelectorFromElement(element);
+ if (instanceSelector) {
+ hoveredInstanceSelectorStore.set(instanceSelector);
}
- hoveredInstanceIdStore.set(id);
};
let mouseOutTimeoutId: TimeoutId = undefined;
@@ -37,7 +40,7 @@ const startHoveredInstanceConnection = () => {
const handleMouseOut = () => {
mouseOutTimeoutId = setTimeout(() => {
hoveredElement = undefined;
- hoveredInstanceIdStore.set(undefined);
+ hoveredInstanceSelectorStore.set(undefined);
}, 100);
};
@@ -51,8 +54,14 @@ const startHoveredInstanceConnection = () => {
if (instanceId === undefined) {
return;
}
+ const instances = instancesStore.get();
+ const instance = instances.get(instanceId);
+ if (instance === undefined) {
+ return;
+ }
hoveredInstanceOutlineStore.set({
- instanceId,
+ label: instance.label,
+ component: instance.component,
rect: element.getBoundingClientRect(),
});
}, 50);
@@ -71,10 +80,12 @@ const startHoveredInstanceConnection = () => {
});
// update rect whenever hovered instance is changed
- const unsubscribeHoveredInstanceId = hoveredInstanceIdStore.subscribe(
- (id) => {
- const element =
- document.querySelector(`[${idAttribute}="${id}"]`) ?? undefined;
+ const unsubscribeHoveredInstanceId = hoveredInstanceSelectorStore.subscribe(
+ (instanceSelector) => {
+ if (instanceSelector === undefined) {
+ return;
+ }
+ const element = getElementByInstanceSelector(instanceSelector);
if (element !== undefined) {
updateHoveredRect(element);
}
@@ -90,10 +101,3 @@ const startHoveredInstanceConnection = () => {
unsubscribeHoveredInstanceId();
};
};
-
-export const useHoveredInstanceConnector = () => {
- useEffect(() => {
- const disconnect = startHoveredInstanceConnection();
- return disconnect;
- }, []);
-};
diff --git a/apps/builder/app/canvas/instance-selection.ts b/apps/builder/app/canvas/instance-selection.ts
index f9215445c0..ddf26820b7 100644
--- a/apps/builder/app/canvas/instance-selection.ts
+++ b/apps/builder/app/canvas/instance-selection.ts
@@ -1,4 +1,5 @@
-import { getComponentMeta, idAttribute } from "@webstudio-is/react-sdk";
+import { getComponentMeta } from "@webstudio-is/react-sdk";
+import { getInstanceSelectorFromElement } from "~/shared/dom-utils";
import {
instancesStore,
selectedInstanceSelectorStore,
@@ -16,24 +17,6 @@ declare module "~/shared/pubsub" {
}
}
-// traverse dom to the root and find all instances
-const getInstanceSelectorFromElement = (element: Element) => {
- const instanceSelector: InstanceSelector = [];
- let matched: undefined | Element =
- element.closest(`[${idAttribute}]`) ?? undefined;
- while (matched) {
- const instanceId = matched.getAttribute(idAttribute) ?? undefined;
- if (instanceId !== undefined) {
- instanceSelector.push(instanceId);
- }
- matched = matched.parentElement?.closest(`[${idAttribute}]`) ?? undefined;
- }
- if (instanceSelector.length === 0) {
- return;
- }
- return instanceSelector;
-};
-
const findClosestRichTextInstanceSelector = (
instanceSelector: InstanceSelector
) => {
diff --git a/apps/builder/app/shared/dom-utils.ts b/apps/builder/app/shared/dom-utils.ts
index f116ff60e9..75681dd610 100644
--- a/apps/builder/app/shared/dom-utils.ts
+++ b/apps/builder/app/shared/dom-utils.ts
@@ -1,5 +1,6 @@
import type { Instance } from "@webstudio-is/project-build";
import { idAttribute } from "@webstudio-is/react-sdk";
+import type { InstanceSelector } from "./tree-utils";
export const getInstanceElementById = (id: Instance["id"]) => {
return document.querySelector(`[${idAttribute}="${id}"]`);
@@ -10,3 +11,32 @@ export const getInstanceIdFromElement = (
): Instance["id"] | undefined => {
return element.getAttribute(idAttribute) ?? undefined;
};
+
+// traverse dom to the root and find all instances
+export const getInstanceSelectorFromElement = (element: Element) => {
+ const instanceSelector: InstanceSelector = [];
+ let matched: undefined | Element =
+ element.closest(`[${idAttribute}]`) ?? undefined;
+ while (matched) {
+ const instanceId = matched.getAttribute(idAttribute) ?? undefined;
+ if (instanceId !== undefined) {
+ instanceSelector.push(instanceId);
+ }
+ matched = matched.parentElement?.closest(`[${idAttribute}]`) ?? undefined;
+ }
+ if (instanceSelector.length === 0) {
+ return;
+ }
+ return instanceSelector;
+};
+
+export const getElementByInstanceSelector = (
+ instanceSelector: InstanceSelector | Readonly<InstanceSelector>
+) => {
+ // query instance from root to target
+ const domSelector = instanceSelector
+ .map((id) => `[${idAttribute}="${id}"]`)
+ .reverse()
+ .join(" ");
+ return document.querySelector(domSelector) ?? undefined;
+};
diff --git a/apps/builder/app/shared/nano-states/nano-states.ts b/apps/builder/app/shared/nano-states/nano-states.ts
index 082ae8d4f3..6bcbfc0dfc 100644
--- a/apps/builder/app/shared/nano-states/nano-states.ts
+++ b/apps/builder/app/shared/nano-states/nano-states.ts
@@ -371,11 +371,11 @@ export const selectedStyleSourceStore = computed(
}
);
-export const hoveredInstanceIdStore = atom<undefined | Instance["id"]>(
+export const hoveredInstanceSelectorStore = atom<undefined | InstanceSelector>(
undefined
);
export const hoveredInstanceOutlineStore = atom<
- undefined | { instanceId: Instance["id"]; rect: DOMRect }
+ undefined | { label?: string; component: string; rect: DOMRect }
>(undefined);
export const isPreviewModeStore = atom<boolean>(false);
diff --git a/apps/builder/app/shared/sync/sync-stores.ts b/apps/builder/app/shared/sync/sync-stores.ts
index 9b2d18f6b2..78dc0efc7a 100644
--- a/apps/builder/app/shared/sync/sync-stores.ts
+++ b/apps/builder/app/shared/sync/sync-stores.ts
@@ -15,7 +15,7 @@ import {
assetContainersStore,
selectedInstanceSelectorStore,
selectedInstanceBrowserStyleStore,
- hoveredInstanceIdStore,
+ hoveredInstanceSelectorStore,
hoveredInstanceOutlineStore,
isPreviewModeStore,
} from "~/shared/nano-states";
@@ -65,9 +65,9 @@ export const registerContainers = () => {
"selectedInstanceBrowserStyle",
selectedInstanceBrowserStyleStore
);
- clientStores.set("hoveredInstanceIdStore", hoveredInstanceIdStore);
- clientStores.set("hoveredInstanceOutlineStore", hoveredInstanceOutlineStore);
- clientStores.set("isPreviewModeStore", isPreviewModeStore);
+ clientStores.set("hoveredInstanceSelector", hoveredInstanceSelectorStore);
+ clientStores.set("hoveredInstanceOutline", hoveredInstanceOutlineStore);
+ clientStores.set("isPreviewMode", isPreviewModeStore);
for (const [name, store] of synchronizedBreakpointsStores) {
clientStores.set(name, store);
}
diff --git a/apps/builder/app/shared/tree-utils.ts b/apps/builder/app/shared/tree-utils.ts
index 875248b26f..fb0d80477b 100644
--- a/apps/builder/app/shared/tree-utils.ts
+++ b/apps/builder/app/shared/tree-utils.ts
@@ -34,6 +34,16 @@ export const getAncestorInstanceSelector = (
return instanceSelector.slice(ancestorIndex);
};
+export const areInstanceSelectorsEqual = (
+ left?: InstanceSelector,
+ right?: InstanceSelector
+) => {
+ if (left === undefined || right === undefined) {
+ return false;
+ }
+ return left.join(",") === right.join(",");
+};
+
// this utility is temporary solution to compute instance selectors
// before all logic is migrated to get it from rendered context
// @todo should be deleted before adding slots