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.

fix: Scroll new instance into view (#2976)

Oleg Isonen9f113a5f0a25
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsx
index 21cf19d92f..1328eafcbb 100644
--- a/apps/builder/app/canvas/canvas.tsx
+++ b/apps/builder/app/canvas/canvas.tsx
@@ -49,12 +49,13 @@ import { subscribeInstanceSelection } from "./instance-selection";
import { subscribeInstanceHovering } from "./instance-hovering";
import { useHashLinkSync } from "~/shared/pages";
import { useMount } from "~/shared/hook-utils/use-mount";
-import { useSelectedInstance } from "./instance-selected-react";
+import { useSelectedInstance } from "./use-selected-instance";
import { subscribeInterceptedEvents } from "./interceptor";
import type { ImageLoader } from "@webstudio-is/image";
import { subscribeCommands } from "~/canvas/shared/commands";
import { updateCollaborativeInstanceRect } from "./collaborative-instance";
import { $params } from "./stores";
+import { useScrollNewInstanceIntoView } from "./shared/use-scroll-new-instance-into-view";
registerContainers();
@@ -123,11 +124,11 @@ const DesignMode = ({ params }: { params: Params }) => {
// in both places
useCopyPaste();
+ useScrollNewInstanceIntoView();
useSelectedInstance();
useEffect(updateCollaborativeInstanceRect, []);
useEffect(subscribeInstanceSelection, []);
useEffect(subscribeInstanceHovering, []);
-
return null;
};
@@ -136,10 +137,7 @@ type CanvasProps = {
imageLoader: ImageLoader;
};
-export const Canvas = ({
- params,
- imageLoader,
-}: CanvasProps): JSX.Element | null => {
+export const Canvas = ({ params, imageLoader }: CanvasProps) => {
useCanvasStore(publish);
const isPreviewMode = useStore($isPreviewMode);
diff --git a/apps/builder/app/canvas/instance-selected-react.ts b/apps/builder/app/canvas/instance-selected-react.ts
deleted file mode 100644
index 91918f7217..0000000000
--- a/apps/builder/app/canvas/instance-selected-react.ts
+++ /dev/null
@@ -1,11 +0,0 @@
-import { useEffect } from "react";
-import { subscribeSelected } from "./instance-selected";
-import { useEffectQueue } from "~/shared/hook-utils/use-effect-queue";
-
-export const useSelectedInstance = () => {
- const execTaskInEffect = useEffectQueue();
-
- useEffect(() => {
- return subscribeSelected(execTaskInEffect);
- }, [execTaskInEffect]);
-};
diff --git a/apps/builder/app/canvas/instance-selected.ts b/apps/builder/app/canvas/instance-selected.ts
index 0fd2e874bb..d9718d0c78 100644
--- a/apps/builder/app/canvas/instance-selected.ts
+++ b/apps/builder/app/canvas/instance-selected.ts
@@ -77,7 +77,7 @@ const calculateUnitSizes = (element: HTMLElement): UnitSizes => {
const subscribeSelectedInstance = (
selectedInstanceSelector: Readonly<InstanceSelector>,
- queueTask: (task: () => void) => void
+ debounceEffect: (callback: () => void) => void
) => {
if (selectedInstanceSelector.length === 0) {
return;
@@ -192,7 +192,7 @@ const subscribeSelectedInstance = (
};
const update = () => {
- queueTask(() => {
+ debounceEffect(() => {
updateElements();
// Having hover etc, element can have no size because of that
// Newly created element can have 0 size
@@ -297,7 +297,9 @@ const subscribeSelectedInstance = (
};
};
-export const subscribeSelected = (queueTask: (task: () => void) => void) => {
+export const subscribeSelected = (
+ debounceEffect: (callback: () => void) => void
+) => {
let previousSelectedInstance: readonly string[] | undefined = undefined;
let unsubscribeSelectedInstance = () => {};
@@ -306,7 +308,7 @@ export const subscribeSelected = (queueTask: (task: () => void) => void) => {
if (instanceSelector !== previousSelectedInstance) {
unsubscribeSelectedInstance();
unsubscribeSelectedInstance =
- subscribeSelectedInstance(instanceSelector ?? [], queueTask) ??
+ subscribeSelectedInstance(instanceSelector ?? [], debounceEffect) ??
(() => {});
previousSelectedInstance = instanceSelector;
}
diff --git a/apps/builder/app/canvas/shared/scroll-new-instance-into-view.ts b/apps/builder/app/canvas/shared/scroll-new-instance-into-view.ts
new file mode 100644
index 0000000000..653a642eff
--- /dev/null
+++ b/apps/builder/app/canvas/shared/scroll-new-instance-into-view.ts
@@ -0,0 +1,39 @@
+import { idAttribute } from "@webstudio-is/react-sdk";
+import type { Instances } from "@webstudio-is/sdk";
+import { $instances } from "~/shared/nano-states";
+
+/**
+ * When a new instance is added to the canvas, scroll it into view.
+ */
+export const subscribeScrollNewInstanceIntoView = (
+ debounceEffect: (callback: () => void) => void,
+ previousInstances: { current?: Instances }
+) => {
+ return $instances.subscribe((instances) => {
+ if (previousInstances.current === undefined) {
+ previousInstances.current = instances;
+ return;
+ }
+ let newInstanceId: string | undefined;
+ for (const [id] of instances) {
+ if (previousInstances.current.has(id)) {
+ continue;
+ }
+ newInstanceId = id;
+ break;
+ }
+ if (newInstanceId === undefined) {
+ return;
+ }
+ previousInstances.current = instances;
+ debounceEffect(() => {
+ const element = document.querySelector(
+ `[${idAttribute}="${newInstanceId}"]`
+ );
+ element?.scrollIntoView({
+ behavior: "smooth",
+ block: "nearest",
+ });
+ });
+ });
+};
diff --git a/apps/builder/app/canvas/shared/use-scroll-new-instance-into-view.ts b/apps/builder/app/canvas/shared/use-scroll-new-instance-into-view.ts
new file mode 100644
index 0000000000..6d7ebb4e90
--- /dev/null
+++ b/apps/builder/app/canvas/shared/use-scroll-new-instance-into-view.ts
@@ -0,0 +1,12 @@
+import { useEffect, useRef } from "react";
+import { useDebounceEffect } from "~/shared/hook-utils/use-debounce-effect";
+import { subscribeScrollNewInstanceIntoView } from "./scroll-new-instance-into-view";
+import type { Instances } from "@webstudio-is/sdk";
+
+export const useScrollNewInstanceIntoView = () => {
+ const debounceEffect = useDebounceEffect();
+ const ref = useRef<Instances>();
+ useEffect(() => {
+ return subscribeScrollNewInstanceIntoView(debounceEffect, ref);
+ }, [debounceEffect]);
+};
diff --git a/apps/builder/app/canvas/use-selected-instance.ts b/apps/builder/app/canvas/use-selected-instance.ts
new file mode 100644
index 0000000000..1a53e13e7c
--- /dev/null
+++ b/apps/builder/app/canvas/use-selected-instance.ts
@@ -0,0 +1,11 @@
+import { useEffect } from "react";
+import { subscribeSelected } from "./instance-selected";
+import { useDebounceEffect } from "~/shared/hook-utils/use-debounce-effect";
+
+export const useSelectedInstance = () => {
+ const debounceEffect = useDebounceEffect();
+
+ useEffect(() => {
+ return subscribeSelected(debounceEffect);
+ }, [debounceEffect]);
+};
diff --git a/apps/builder/app/shared/hook-utils/use-effect-queue.ts b/apps/builder/app/shared/hook-utils/use-debounce-effect.ts
similarity index 64%
rename from apps/builder/app/shared/hook-utils/use-effect-queue.ts
rename to apps/builder/app/shared/hook-utils/use-debounce-effect.ts
index 334fb2a6dd..776ed01813 100644
--- a/apps/builder/app/shared/hook-utils/use-effect-queue.ts
+++ b/apps/builder/app/shared/hook-utils/use-debounce-effect.ts
@@ -1,12 +1,12 @@
import { useCallback, useEffect, useState } from "react";
/**
- * Debounce task execution until useEffect
+ * Debounce callback execution until useEffect
* Example:
- * const scheduleEffect = useEffectQueue();
+ * const scheduleEffect = useDebounceEffect();
* scheduleEffect(() => { ... })
*/
-export const useEffectQueue = () => {
+export const useDebounceEffect = () => {
const [updateCallback, setUpdateCallback] = useState(() => () => {
/* empty */
});
@@ -17,7 +17,7 @@ export const useEffectQueue = () => {
updateCallback();
}, [updateCallback]);
- return useCallback((task: () => void) => {
- setUpdateCallback(() => task);
+ return useCallback((callback: () => void) => {
+ setUpdateCallback(() => callback);
}, []);
};