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.

feat: Implement collaborative highlight for AI-modified elements (#2484)

Ivan Starkovbfab8be9d473
diff --git a/apps/builder/app/builder/features/ai/ai-command-bar.tsx b/apps/builder/app/builder/features/ai/ai-command-bar.tsx
index c27d777d25..dc2ae1e602 100644
--- a/apps/builder/app/builder/features/ai/ai-command-bar.tsx
+++ b/apps/builder/app/builder/features/ai/ai-command-bar.tsx
@@ -35,7 +35,12 @@ import {
type MouseEvent,
type ComponentPropsWithoutRef,
} from "react";
-import { $isAiCommandBarVisible } from "~/shared/nano-states";
+import {
+ $collaborativeInstanceSelector,
+ $isAiCommandBarVisible,
+ selectedInstanceSelectorStore,
+ selectedPageStore,
+} from "~/shared/nano-states";
import { useMediaRecorder } from "./hooks/media-recorder";
import { useLongPressToggle } from "./hooks/long-press-toggle";
import { AiCommandBarButton } from "./ai-button";
@@ -172,7 +177,22 @@ export const AiCommandBar = ({ isPreviewMode }: { isPreviewMode: boolean }) => {
// Skip Abort Logic for now
try {
- await fetchResult(prompt, abortController.current.signal);
+ const page = selectedPageStore.get();
+ const rootInstanceSelector = page?.rootInstanceId
+ ? [page.rootInstanceId]
+ : [];
+ const instanceSelector =
+ selectedInstanceSelectorStore.get() ?? rootInstanceSelector;
+
+ const [instanceId] = instanceSelector;
+
+ if (instanceId === undefined) {
+ // Must not happen, we always have root instance
+ throw new Error("No element selected");
+ }
+
+ $collaborativeInstanceSelector.set(instanceSelector);
+ await fetchResult(prompt, instanceId, abortController.current.signal);
if (localAbortController !== abortController.current) {
// skip
@@ -219,6 +239,7 @@ export const AiCommandBar = ({ isPreviewMode }: { isPreviewMode: boolean }) => {
}
} finally {
abortController.current = undefined;
+ $collaborativeInstanceSelector.set(undefined);
setIsAiRequesting(false);
}
};
diff --git a/apps/builder/app/builder/features/ai/ai-fetch-result.ts b/apps/builder/app/builder/features/ai/ai-fetch-result.ts
index afe6ab4e1d..cb1ed2935f 100644
--- a/apps/builder/app/builder/features/ai/ai-fetch-result.ts
+++ b/apps/builder/app/builder/features/ai/ai-fetch-result.ts
@@ -14,7 +14,7 @@ import {
idAttribute,
componentAttribute,
} from "@webstudio-is/react-sdk";
-import { createScope, findTreeInstanceIds } from "@webstudio-is/sdk";
+import { Instance, createScope, findTreeInstanceIds } from "@webstudio-is/sdk";
import { computed } from "nanostores";
import { getMapValuesByKeysSet } from "~/shared/array-utils";
import {
@@ -58,6 +58,7 @@ const onResponseReceived = async (response: Response) => {
export const fetchResult = async (
prompt: string,
+ instanceId: Instance["id"],
abortSignal: AbortSignal
): Promise<void> => {
const commandsResponse = await handleAiRequest<commandDetect.Response>(
@@ -83,7 +84,7 @@ export const fetchResult = async (
}
const project = projectStore.get();
- const selectedInstanceSelector = selectedInstanceSelectorStore.get();
+
const availableComponentsNames = $availableComponentsNames.get();
const [styles, jsx] = $jsx.get() || ["", ""];
@@ -91,7 +92,7 @@ export const fetchResult = async (
jsx: `${styles}${jsx}`,
components: availableComponentsNames,
projectId: project?.id,
- instanceId: selectedInstanceSelector?.[0],
+ instanceId,
prompt,
};
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 5b3f8c8811..186864c92e 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
@@ -7,7 +7,11 @@ import {
$isPreviewMode,
$dragAndDropState,
} from "~/shared/nano-states";
-import { HoveredInstanceOutline, SelectedInstanceOutline } from "./outline";
+import {
+ CollaborativeInstanceOutline,
+ HoveredInstanceOutline,
+ SelectedInstanceOutline,
+} from "./outline";
import { TextToolbar } from "./text-toolbar";
import { Label } from "./outline/label";
import { Outline } from "./outline/outline";
@@ -74,6 +78,7 @@ export const CanvasTools = ({ publish }: CanvasToolsProps) => {
<div className={containerStyle({ overflow: "hidden" })}>
<SelectedInstanceOutline />
<HoveredInstanceOutline />
+ <CollaborativeInstanceOutline />
</div>
<TextToolbar publish={publish} />
</>
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/outline/collaborative-instance-outline.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/outline/collaborative-instance-outline.tsx
index c26ad0e708..dbbd7334f8 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/outline/collaborative-instance-outline.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/outline/collaborative-instance-outline.tsx
@@ -1,16 +1,19 @@
import { useStore } from "@nanostores/react";
-import { $collaborativeInstanceOutlineAndInstance } from "~/shared/nano-states";
+import { $collaborativeInstanceRect } from "~/shared/nano-states";
import { Outline } from "./outline";
import { applyScale } from "./apply-scale";
import { scaleStore } from "~/builder/shared/nano-states";
// Outline of an instance that is being edited by AI or a human collaborator.
export const CollaborativeInstanceOutline = () => {
- const outline = useStore($collaborativeInstanceOutlineAndInstance);
const scale = useStore(scaleStore);
- if (outline === undefined) {
+ const instanceRect = useStore($collaborativeInstanceRect);
+
+ if (instanceRect === undefined) {
return null;
}
- const rect = applyScale(outline.rect, scale);
- return <Outline rect={rect}></Outline>;
+
+ const rect = applyScale(instanceRect, scale);
+
+ return <Outline variant="collaboration" rect={rect}></Outline>;
};
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsx
index 109a364903..dc4248d8de 100644
--- a/apps/builder/app/canvas/canvas.tsx
+++ b/apps/builder/app/canvas/canvas.tsx
@@ -53,6 +53,7 @@ import { useSelectedInstance } from "./instance-selected-react";
import { subscribeInterceptedEvents } from "./interceptor";
import type { ImageLoader } from "@webstudio-is/image";
import { subscribeCommands } from "~/canvas/shared/commands";
+import { updateCollaborativeInstanceRect } from "./collaborative-instance";
registerContainers();
@@ -153,6 +154,7 @@ const DesignMode = ({ params }: { params: Params }) => {
useCopyPaste();
useSelectedInstance();
+ useEffect(updateCollaborativeInstanceRect, []);
useEffect(subscribeInstanceSelection, []);
useEffect(subscribeInstanceHovering, []);
diff --git a/apps/builder/app/canvas/collaborative-instance.ts b/apps/builder/app/canvas/collaborative-instance.ts
new file mode 100644
index 0000000000..bb50c7ac5a
--- /dev/null
+++ b/apps/builder/app/canvas/collaborative-instance.ts
@@ -0,0 +1,50 @@
+import {
+ getAllElementsBoundingBox,
+ getElementsByInstanceSelector,
+} from "~/shared/dom-utils";
+import {
+ $collaborativeInstanceSelector,
+ $collaborativeInstanceRect,
+} from "~/shared/nano-states";
+
+export const updateCollaborativeInstanceRect = () => {
+ let frameHandler: number = -1;
+ let elements: HTMLElement[] = [];
+
+ const frameLoop = () => {
+ const newRect = getAllElementsBoundingBox(elements);
+ const prevRect = $collaborativeInstanceRect.get();
+
+ if (
+ newRect.x !== prevRect?.x ||
+ newRect.y !== prevRect?.y ||
+ newRect.width !== prevRect?.width ||
+ newRect.height !== prevRect?.height
+ ) {
+ $collaborativeInstanceRect.set(newRect);
+ }
+
+ frameHandler = requestAnimationFrame(frameLoop);
+ };
+
+ const unsubscribe = $collaborativeInstanceSelector.subscribe((selector) => {
+ if (selector === undefined) {
+ cancelAnimationFrame(frameHandler);
+ $collaborativeInstanceRect.set(undefined);
+ elements = [];
+ return;
+ }
+
+ elements = getElementsByInstanceSelector(selector);
+
+ if (elements.length > 0) {
+ cancelAnimationFrame(frameHandler);
+ frameLoop();
+ }
+ });
+
+ return () => {
+ unsubscribe();
+ cancelAnimationFrame(frameHandler);
+ };
+};
diff --git a/apps/builder/app/shared/nano-states/canvas.ts b/apps/builder/app/shared/nano-states/canvas.ts
index 6652574c85..739b943b7c 100644
--- a/apps/builder/app/shared/nano-states/canvas.ts
+++ b/apps/builder/app/shared/nano-states/canvas.ts
@@ -1,6 +1,7 @@
import { atom, computed } from "nanostores";
import type { Instance, Instances } from "@webstudio-is/sdk";
import { instancesStore } from "./instances";
+import type { InstanceSelector } from "../tree-utils";
export type TextToolbarState = {
selectionRect: undefined | DOMRect;
@@ -55,13 +56,16 @@ export const hoveredInstanceOutlineAndInstanceStore = computed(
getInstanceOutlineAndInstance
);
-// @todo implement like above
-export const $collaborativeInstanceOutlineAndInstance = atom<
- undefined | { instance: Instance; rect: DOMRect }
+export const $collaborativeInstanceSelector = atom<
+ undefined | InstanceSelector
>(undefined);
+export const $collaborativeInstanceRect = atom<undefined | DOMRect>(undefined);
+
export const synchronizedCanvasStores = [
["textToolbar", textToolbarStore],
["selectedInstanceOutline", selectedInstanceOutlineStore],
["hoveredInstanceOutline", hoveredInstanceOutlineStore],
+ ["$collaborativeInstanceSelector", $collaborativeInstanceSelector],
+ ["$collaborativeInstanceRect", $collaborativeInstanceRect],
] as const;