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.

Update hovered rect when scroll ends (#650)

Bogdan Chadkinbb0e3153387f
diff --git a/apps/designer/app/canvas/canvas.tsx b/apps/designer/app/canvas/canvas.tsx
index b22a7b3ae4..004fd079ce 100644
--- a/apps/designer/app/canvas/canvas.tsx
+++ b/apps/designer/app/canvas/canvas.tsx
@@ -21,8 +21,6 @@ import {
usePublishSelectedInstanceData,
usePublishTextEditingInstanceId,
useReparentInstance,
- useSetHoveredInstance,
- usePublishHoveredInstanceData,
useUnselectInstance,
useUpdateSelectedInstance,
} from "./shared/instance";
@@ -54,6 +52,7 @@ import {
import { useInstanceCopyPaste } from "~/shared/copy-paste";
import { useSelectedInstance } from "./shared/nano-states";
import { customComponents } from "./custom-components";
+import { useHoveredInstanceConnector } from "./hovered-instance-connector";
registerContainers();
@@ -145,8 +144,6 @@ const DesignMode = ({ treeId, buildId }: DesignModeProps) => {
useDeleteInstance();
usePublishRootInstance();
useTrackSelectedElement();
- useSetHoveredInstance();
- usePublishHoveredInstanceData();
useSync({ buildId, treeId });
useUpdateSelectedInstance();
useUnselectInstance();
@@ -156,6 +153,8 @@ const DesignMode = ({ treeId, buildId }: DesignModeProps) => {
useDragAndDrop();
useCopyPaste();
+ useHoveredInstanceConnector();
+
return null;
};
diff --git a/apps/designer/app/canvas/hovered-instance-connector.ts b/apps/designer/app/canvas/hovered-instance-connector.ts
new file mode 100644
index 0000000000..e4c0955dc4
--- /dev/null
+++ b/apps/designer/app/canvas/hovered-instance-connector.ts
@@ -0,0 +1,107 @@
+import { useEffect } from "react";
+import debounce from "lodash.debounce";
+import { type Instance, idAttribute } from "@webstudio-is/react-sdk";
+import { utils } from "@webstudio-is/project";
+import { publish, subscribe } from "~/shared/pubsub";
+import { useRootInstance } from "~/shared/nano-states";
+import { subscribeScrollState } from "~/shared/dom-hooks";
+
+const startHoveredInstanceConnection = (rootInstance: Instance) => {
+ let hoveredElement: undefined | Element = undefined;
+
+ // debounce is used to avoid laggy hover because of iframe message delay
+ const publishHover = debounce((element: Element) => {
+ const id = element.getAttribute(idAttribute) ?? undefined;
+ if (id === undefined) {
+ return;
+ }
+ const instance = utils.tree.findInstanceById(rootInstance, id);
+ if (instance === undefined) {
+ return;
+ }
+ publish({
+ type: "hoveredInstanceRect",
+ payload: element.getBoundingClientRect(),
+ });
+ publish({
+ type: "hoverInstance",
+ payload: {
+ id: instance.id,
+ component: instance.component,
+ },
+ });
+ }, 50);
+
+ const handleMouseOver = (event: MouseEvent) => {
+ const element = event.target;
+ if (element instanceof Element) {
+ // store hovered element locally to update outline when scroll ends
+ hoveredElement = element;
+ publishHover(element);
+ }
+ };
+
+ const handleMouseOut = () => {
+ hoveredElement = undefined;
+ publish({
+ type: "hoverInstance",
+ payload: undefined,
+ });
+ };
+
+ const eventOptions = { passive: true };
+ window.addEventListener("mouseover", handleMouseOver, eventOptions);
+ window.addEventListener("mouseout", handleMouseOut, eventOptions);
+
+ const unsubscribeNavigatorHoveredInstance = subscribe(
+ "navigatorHoveredInstance",
+ (navigatorHoveredInstance) => {
+ if (navigatorHoveredInstance === undefined) {
+ return;
+ }
+ const id = navigatorHoveredInstance.id;
+ const element =
+ document.querySelector(`[${idAttribute}="${id}"]`) ?? undefined;
+ if (element !== undefined) {
+ publishHover(element);
+ }
+ }
+ );
+
+ // remove hover outline when scroll starts
+ // and show it with new rect when scroll ends
+ const unsubscribeScrollState = subscribeScrollState({
+ onScrollStart() {
+ publish({
+ type: "hoverInstance",
+ payload: undefined,
+ });
+ },
+ onScrollEnd() {
+ if (hoveredElement !== undefined) {
+ publishHover(hoveredElement);
+ }
+ },
+ });
+
+ return () => {
+ publishHover.cancel();
+ window.removeEventListener("mouseover", handleMouseOver);
+ window.removeEventListener("mouseout", handleMouseOut);
+ unsubscribeNavigatorHoveredInstance();
+ unsubscribeScrollState();
+ };
+};
+
+export const useHoveredInstanceConnector = () => {
+ const [rootInstance] = useRootInstance();
+
+ useEffect(() => {
+ if (rootInstance === undefined) {
+ return;
+ }
+
+ const disconnect = startHoveredInstanceConnection(rootInstance);
+ return disconnect;
+ }, [rootInstance]);
+};
diff --git a/apps/designer/app/canvas/shared/instance.ts b/apps/designer/app/canvas/shared/instance.ts
index 0331a795fc..63ad223c35 100644
--- a/apps/designer/app/canvas/shared/instance.ts
+++ b/apps/designer/app/canvas/shared/instance.ts
@@ -1,4 +1,4 @@
-import { useCallback, useEffect, useState } from "react";
+import { useEffect, useState } from "react";
import {
type Instance,
type UserProp,
@@ -15,19 +15,14 @@ import {
type SelectedInstanceData,
} from "@webstudio-is/project";
import store from "immerhin";
-import { useSelectedInstance, useHoveredInstance } from "./nano-states";
+import { useSelectedInstance } from "./nano-states";
import {
rootInstanceContainer,
useBreakpoints,
useRootInstance,
useTextEditingInstanceId,
} from "~/shared/nano-states";
-import {
- findInstanceByElement,
- getInstanceElementById,
-} from "~/shared/dom-utils";
import { publish } from "~/shared/pubsub";
-import { useTrackHoveredElement } from "./use-track-hovered-element";
declare module "~/shared/pubsub" {
export interface PubsubMap {
@@ -195,23 +190,6 @@ export const usePublishSelectedInstanceData = () => {
}, [instance]);
};
-export const usePublishHoveredInstanceData = () => {
- const [instance] = useHoveredInstance();
-
- useEffect(() => {
- const payload = instance
- ? {
- id: instance.id,
- component: instance.component,
- }
- : undefined;
- publish({
- type: "hoverInstance",
- payload,
- });
- }, [instance]);
-};
-
export const usePublishRootInstance = () => {
const [rootInstance] = useRootInstance();
useEffect(() => {
@@ -222,44 +200,6 @@ export const usePublishRootInstance = () => {
}, [rootInstance]);
};
-export const useSetHoveredInstance = () => {
- const [rootInstance] = useRootInstance();
- const [, setHoveredInstance] = useHoveredInstance();
-
- const [hoveredElement, setHoveredElement] = useState<HTMLElement | undefined>(
- undefined
- );
-
- useTrackHoveredElement(setHoveredElement);
-
- useSubscribe(
- "navigatorHoveredInstance",
- useCallback((instance) => {
- setHoveredElement(
- instance && (getInstanceElementById(instance.id) || undefined)
- );
- }, [])
- );
-
- useEffect(() => {
- if (hoveredElement === undefined) {
- return;
- }
- publish({
- type: "hoveredInstanceRect",
- payload: hoveredElement.getBoundingClientRect(),
- });
- }, [hoveredElement]);
-
- useEffect(() => {
- let instance;
- if (rootInstance !== undefined && hoveredElement) {
- instance = findInstanceByElement(rootInstance, hoveredElement);
- }
- setHoveredInstance(instance);
- }, [rootInstance, hoveredElement, setHoveredInstance]);
-};
-
/**
* We need to set the selected instance after a any root instance update,
* because anything that we change on the selected instance is actually done on the root, so
diff --git a/apps/designer/app/canvas/shared/nano-states.ts b/apps/designer/app/canvas/shared/nano-states.ts
index 1249e17f1b..62ed9e1539 100644
--- a/apps/designer/app/canvas/shared/nano-states.ts
+++ b/apps/designer/app/canvas/shared/nano-states.ts
@@ -5,8 +5,3 @@ export const selectedInstanceContainer = createValueContainer<
Instance | undefined
>();
export const useSelectedInstance = () => useValue(selectedInstanceContainer);
-
-export const hoveredInstanceContainer = createValueContainer<
- Instance | undefined
->();
-export const useHoveredInstance = () => useValue(hoveredInstanceContainer);
diff --git a/apps/designer/app/canvas/shared/use-track-hovered-element.ts b/apps/designer/app/canvas/shared/use-track-hovered-element.ts
deleted file mode 100644
index 7559e1baa7..0000000000
--- a/apps/designer/app/canvas/shared/use-track-hovered-element.ts
+++ /dev/null
@@ -1,47 +0,0 @@
-import { useEffect, useState } from "react";
-import { useRootInstance } from "~/shared/nano-states";
-
-// @todo: importing normally doesn't work in Jest for some reason
-// import { useDebounce } from "react-use";
-import useDebounce from "react-use/lib/useDebounce"; // eslint-disable-line
-
-const eventOptions = {
- passive: true,
-};
-
-export const useTrackHoveredElement = (
- onChange: (element: HTMLElement | undefined) => void
-) => {
- const [rootInstance] = useRootInstance();
- const [hoveredElement, setHoveredElement] = useState<HTMLElement>();
-
- useDebounce(
- () => {
- onChange(hoveredElement);
- },
- 50,
- [hoveredElement]
- );
-
- useEffect(() => {
- const handleMouseOver = (event: MouseEvent) => {
- const element = event.target;
- if (rootInstance === undefined || !(element instanceof HTMLElement)) {
- return;
- }
- setHoveredElement(element);
- };
-
- const handleMouseOut = () => {
- setHoveredElement(undefined);
- };
-
- window.addEventListener("mouseover", handleMouseOver, eventOptions);
- window.addEventListener("mouseout", handleMouseOut, eventOptions);
-
- return () => {
- window.removeEventListener("mouseover", handleMouseOver);
- window.removeEventListener("mouseout", handleMouseOut);
- };
- }, [rootInstance, onChange]);
-};
diff --git a/apps/designer/app/shared/dom-hooks/use-scroll-state.ts b/apps/designer/app/shared/dom-hooks/use-scroll-state.ts
index c3f950e938..395f887d4d 100644
--- a/apps/designer/app/shared/dom-hooks/use-scroll-state.ts
+++ b/apps/designer/app/shared/dom-hooks/use-scroll-state.ts
@@ -10,29 +10,29 @@ if (typeof window === "object") {
passive: true,
capture: true,
};
+
+ let timeoutId = 0;
+ let isScrolling = false;
+
window.addEventListener(
"scroll",
() => {
+ if (isScrolling === false) {
+ emitter.emit("scrollStart");
+ }
emitter.emit("scroll");
+ isScrolling = true;
+ clearTimeout(timeoutId);
+ timeoutId = window.setTimeout(() => {
+ if (isScrolling === false) {
+ return;
+ }
+ isScrolling = false;
+ emitter.emit("scrollEnd");
+ }, 150);
},
eventOptions
);
-
- let timeoutId = 0;
- let isScrolling = false;
-
- emitter.on("scroll", () => {
- isScrolling = true;
- emitter.emit("scrollStart");
- clearTimeout(timeoutId);
- timeoutId = window.setTimeout(() => {
- if (isScrolling === false) {
- return;
- }
- isScrolling = false;
- emitter.emit("scrollEnd");
- }, 150);
- });
}
type UseScrollState = {
@@ -41,24 +41,37 @@ type UseScrollState = {
onScrollEnd?: () => void;
};
+export const subscribeScrollState = ({
+ onScroll = noop,
+ onScrollStart = noop,
+ onScrollEnd = noop,
+}: UseScrollState) => {
+ emitter.on("scrollStart", onScrollStart);
+ emitter.on("scroll", onScroll);
+ emitter.on("scrollEnd", onScrollEnd);
+
+ return () => {
+ emitter.off("scrollStart", onScrollStart);
+ emitter.off("scroll", onScroll);
+ emitter.off("scrollEnd", onScrollEnd);
+ };
+};
+
/**
* Scroll state abstraction that can handle a lot of subscribers well.
* Potentially could add rate limiting and actual scroll top/left values.
*/
export const useScrollState = ({
- onScroll = noop,
- onScrollStart = noop,
- onScrollEnd = noop,
+ onScroll,
+ onScrollStart,
+ onScrollEnd,
}: UseScrollState) => {
useEffect(() => {
- emitter.on("scrollStart", onScrollStart);
- emitter.on("scroll", onScroll);
- emitter.on("scrollEnd", onScrollEnd);
-
- return () => {
- emitter.off("scrollStart", onScrollStart);
- emitter.off("scroll", onScroll);
- emitter.off("scrollEnd", onScrollEnd);
- };
+ const unsubscribe = subscribeScrollState({
+ onScrollStart,
+ onScroll,
+ onScrollEnd,
+ });
+ return unsubscribe;
}, [onScroll, onScrollEnd, onScrollStart]);
};
diff --git a/apps/designer/app/shared/pubsub/index.ts b/apps/designer/app/shared/pubsub/index.ts
index bab035aff5..fe67044142 100644
--- a/apps/designer/app/shared/pubsub/index.ts
+++ b/apps/designer/app/shared/pubsub/index.ts
@@ -9,6 +9,7 @@ export const {
usePublish,
useSubscribe,
useSubscribeAll,
+ subscribe,
subscribeAll,
} = createPubsub<PubsubMap>();
export type Publish = typeof publish;
diff --git a/packages/react-sdk/src/pubsub/create.ts b/packages/react-sdk/src/pubsub/create.ts
index 212ddbcee1..3f650da080 100644
--- a/packages/react-sdk/src/pubsub/create.ts
+++ b/packages/react-sdk/src/pubsub/create.ts
@@ -83,6 +83,16 @@ export const createPubsub = <PublishMap>() => {
}, [onAction]);
},
+ subscribe<Type extends keyof PublishMap>(
+ type: Type,
+ onAction: (payload: PublishMap[Type]) => void
+ ) {
+ emitter.on(type, onAction);
+ return () => {
+ emitter.off(type, onAction);
+ };
+ },
+
subscribeAll(
onAction: <Type extends keyof PublishMap>(
type: Type,