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.

Support pasting embed templates (#1936)

Bogdan Chadkineb0bc5ff77a5
diff --git a/apps/builder/app/shared/copy-paste/init-copy-paste.ts b/apps/builder/app/shared/copy-paste/init-copy-paste.ts
index bcde3f634d..8494f79c32 100644
--- a/apps/builder/app/shared/copy-paste/init-copy-paste.ts
+++ b/apps/builder/app/shared/copy-paste/init-copy-paste.ts
@@ -28,57 +28,54 @@ const isValidClipboardEvent = (event: ClipboardEvent) => {
return true;
};
-type Options = {
+const defaultMimeType = "application/json";
+
+type Plugin = {
mimeType?: string;
onCopy?: () => undefined | string;
onCut?: () => undefined | string;
- onPaste?: (data: string) => void;
+ onPaste?: (data: string) => boolean;
};
-export const initCopyPaste = (options: Options) => {
- const { mimeType = "application/json", onCopy, onCut, onPaste } = options;
-
+export const initCopyPaste = (plugins: Plugin[]) => {
const handleCopy = (event: ClipboardEvent) => {
if (
- onCopy === undefined ||
event.clipboardData === null ||
isValidClipboardEvent(event) === false
) {
return;
}
-
- const data = onCopy();
- if (data === undefined) {
- return;
+ for (const { mimeType = defaultMimeType, onCopy } of plugins) {
+ const data = onCopy?.();
+ if (data) {
+ // must prevent default, otherwise setData() will not work
+ event.preventDefault();
+ event.clipboardData.setData(mimeType, data);
+ break;
+ }
}
-
- // must prevent default, otherwise setData() will not work
- event.preventDefault();
- event.clipboardData.setData(mimeType, data);
};
const handleCut = (event: ClipboardEvent) => {
if (
- onCut === undefined ||
event.clipboardData === null ||
isValidClipboardEvent(event) === false
) {
return;
}
-
- const data = onCut();
- if (data === undefined) {
- return;
+ for (const { mimeType = defaultMimeType, onCut } of plugins) {
+ const data = onCut?.();
+ if (data) {
+ // must prevent default, otherwise setData() will not work
+ event.preventDefault();
+ event.clipboardData.setData(mimeType, data);
+ break;
+ }
}
-
- // must prevent default, otherwise setData() will not work
- event.preventDefault();
- event.clipboardData.setData(mimeType, data);
};
const handlePaste = (event: ClipboardEvent) => {
if (
- onPaste === undefined ||
event.clipboardData === null ||
// we might want a separate predicate for paste,
// but for now the logic is the same
@@ -87,35 +84,25 @@ export const initCopyPaste = (options: Options) => {
return;
}
- // this shouldn't matter, but just in case
- event.preventDefault();
- const data = event.clipboardData.getData(mimeType).trim();
- if (data) {
- onPaste(data);
+ for (const { mimeType = defaultMimeType, onPaste } of plugins) {
+ // this shouldn't matter, but just in case
+ event.preventDefault();
+ const data = event.clipboardData.getData(mimeType).trim();
+ if (data && onPaste?.(data)) {
+ break;
+ }
}
};
- if (onCopy) {
- document.addEventListener("copy", handleCopy);
- }
- if (onCut) {
- document.addEventListener("cut", handleCut);
- }
- if (onPaste) {
- // Capture is required so we get the element before content-editable removes it
- // This way we can detect when we are inside content-editable and ignore the event
- document.addEventListener("paste", handlePaste, { capture: true });
- }
+ document.addEventListener("copy", handleCopy);
+ document.addEventListener("cut", handleCut);
+ // Capture is required so we get the element before content-editable removes it
+ // This way we can detect when we are inside content-editable and ignore the event
+ document.addEventListener("paste", handlePaste, { capture: true });
return () => {
- if (onCopy) {
- document.removeEventListener("copy", handleCopy);
- }
- if (onCut) {
- document.removeEventListener("cut", handleCut);
- }
- if (onPaste) {
- document.removeEventListener("paste", handlePaste, { capture: true });
- }
+ document.removeEventListener("copy", handleCopy);
+ document.removeEventListener("cut", handleCut);
+ document.removeEventListener("paste", handlePaste, { capture: true });
};
};
diff --git a/apps/builder/app/shared/copy-paste/plugin-embed-template.ts b/apps/builder/app/shared/copy-paste/plugin-embed-template.ts
new file mode 100644
index 0000000000..e44ba18603
--- /dev/null
+++ b/apps/builder/app/shared/copy-paste/plugin-embed-template.ts
@@ -0,0 +1,71 @@
+import { z } from "zod";
+import {
+ WsEmbedTemplate,
+ generateDataFromEmbedTemplate,
+} from "@webstudio-is/react-sdk";
+import {
+ selectedInstanceSelectorStore,
+ instancesStore,
+ selectedPageStore,
+ registeredComponentMetasStore,
+ breakpointsStore,
+} from "../nano-states";
+import {
+ findClosestDroppableTarget,
+ insertTemplateData,
+} from "../instance-utils";
+import { isBaseBreakpoint } from "../breakpoints";
+
+const version = "@webstudio/template";
+
+const ClipboardData = z.object({ [version]: WsEmbedTemplate });
+
+const parse = (clipboardData: string): WsEmbedTemplate | undefined => {
+ try {
+ const data = ClipboardData.parse(JSON.parse(clipboardData));
+ return data[version];
+ } catch {
+ return;
+ }
+};
+
+export const mimeType = "text/plain";
+
+export const onPaste = (clipboardData: string): boolean => {
+ const template = parse(clipboardData);
+
+ const selectedPage = selectedPageStore.get();
+
+ if (template === undefined || selectedPage === undefined) {
+ return false;
+ }
+
+ // paste to the root if nothing is selected
+ const instanceSelector = selectedInstanceSelectorStore.get() ?? [
+ selectedPage.rootInstanceId,
+ ];
+ const breakpoints = breakpointsStore.get();
+ const breakpointValues = Array.from(breakpoints.values());
+ const baseBreakpoint = breakpointValues.find(isBaseBreakpoint);
+ if (baseBreakpoint === undefined) {
+ return false;
+ }
+ const templateData = generateDataFromEmbedTemplate(
+ template,
+ baseBreakpoint.id
+ );
+ const dragComponents = Array.from(
+ new Set(templateData.instances.map((instance) => instance.component))
+ );
+ const dropTarget = findClosestDroppableTarget(
+ registeredComponentMetasStore.get(),
+ instancesStore.get(),
+ instanceSelector,
+ dragComponents
+ );
+ if (dropTarget === undefined) {
+ return false;
+ }
+ insertTemplateData(templateData, dropTarget);
+ return true;
+};
diff --git a/apps/builder/app/shared/copy-paste/plugin-instance.ts b/apps/builder/app/shared/copy-paste/plugin-instance.ts
index 72f204f19a..e8ed5d4157 100644
--- a/apps/builder/app/shared/copy-paste/plugin-instance.ts
+++ b/apps/builder/app/shared/copy-paste/plugin-instance.ts
@@ -252,7 +252,7 @@ const parse = (clipboardData: string): InstanceData | undefined => {
export const mimeType = "application/json";
-export const onPaste = (clipboardData: string) => {
+export const onPaste = (clipboardData: string): boolean => {
const data = parse(clipboardData);
const selectedPage = selectedPageStore.get();
@@ -263,7 +263,7 @@ export const onPaste = (clipboardData: string) => {
selectedPage === undefined ||
project === undefined
) {
- return;
+ return false;
}
// paste to the root if nothing is selected
@@ -280,7 +280,7 @@ export const onPaste = (clipboardData: string) => {
dragComponents
);
if (dropTarget === undefined) {
- return;
+ return false;
}
store.createTransaction(
@@ -350,6 +350,7 @@ export const onPaste = (clipboardData: string) => {
);
}
);
+ return true;
};
export const onCopy = () => {
diff --git a/apps/builder/app/shared/copy-paste/plugin-markdown.ts b/apps/builder/app/shared/copy-paste/plugin-markdown.ts
index 4b79584857..9c91797d9c 100644
--- a/apps/builder/app/shared/copy-paste/plugin-markdown.ts
+++ b/apps/builder/app/shared/copy-paste/plugin-markdown.ts
@@ -196,11 +196,11 @@ export const parse = (clipboardData: string, options?: Options) => {
return { props, instances, children };
};
-export const onPaste = (clipboardData: string) => {
+export const onPaste = (clipboardData: string): boolean => {
const data = parse(clipboardData);
const selectedPage = selectedPageStore.get();
if (data === undefined || selectedPage === undefined) {
- return;
+ return false;
}
// paste to the root if nothing is selected
const instanceSelector = selectedInstanceSelectorStore.get() ?? [
@@ -216,7 +216,7 @@ export const onPaste = (clipboardData: string) => {
dragComponents
);
if (dropTarget === undefined) {
- return;
+ return false;
}
store.createTransaction([instancesStore, propsStore], (instances, props) => {
insertInstancesMutable(
@@ -231,4 +231,5 @@ export const onPaste = (clipboardData: string) => {
props.set(prop.id, prop);
}
});
+ return true;
};
diff --git a/apps/builder/app/shared/copy-paste/plugins.ts b/apps/builder/app/shared/copy-paste/plugins.ts
deleted file mode 100644
index 4f80f0cf8d..0000000000
--- a/apps/builder/app/shared/copy-paste/plugins.ts
+++ /dev/null
@@ -1,2 +0,0 @@
-export * as instance from "./plugin-instance";
-export * as mardkown from "./plugin-markdown";
diff --git a/apps/builder/app/shared/copy-paste/use-copy-paste.ts b/apps/builder/app/shared/copy-paste/use-copy-paste.ts
index 9f5b331498..0cf93224ac 100644
--- a/apps/builder/app/shared/copy-paste/use-copy-paste.ts
+++ b/apps/builder/app/shared/copy-paste/use-copy-paste.ts
@@ -1,23 +1,11 @@
import { useEffect } from "react";
import { initCopyPaste } from "./init-copy-paste";
-import * as plugins from "./plugins";
-
-const initPlugins = () => {
- const cleanups: Array<() => void> = [];
-
- for (const plugin of Object.values(plugins)) {
- cleanups.push(initCopyPaste(plugin));
- }
-
- return () => {
- for (const cleanup of cleanups) {
- cleanup();
- }
- };
-};
+import * as instance from "./plugin-instance";
+import * as embedTemplate from "./plugin-embed-template";
+import * as markdown from "./plugin-markdown";
export const useCopyPaste = () => {
useEffect(() => {
- return initPlugins();
+ return initCopyPaste([instance, embedTemplate, markdown]);
}, []);
};
diff --git a/apps/builder/app/shared/instance-utils.ts b/apps/builder/app/shared/instance-utils.ts
index cc623b5d9b..4bca92ab2d 100644
--- a/apps/builder/app/shared/instance-utils.ts
+++ b/apps/builder/app/shared/instance-utils.ts
@@ -4,9 +4,9 @@ import {
findTreeInstanceIdsExcludingSlotDescendants,
} from "@webstudio-is/project-build";
import {
- type WsEmbedTemplate,
type WsComponentMeta,
generateDataFromEmbedTemplate,
+ type EmbedTemplateData,
} from "@webstudio-is/react-sdk";
import {
propsStore,
@@ -162,16 +162,10 @@ export const findClosestDroppableTarget = (
};
};
-export const insertTemplate = (
- template: WsEmbedTemplate,
+export const insertTemplateData = (
+ templateData: EmbedTemplateData,
dropTarget: DroppableTarget
) => {
- const breakpoints = breakpointsStore.get();
- const breakpointValues = Array.from(breakpoints.values());
- const baseBreakpoint = breakpointValues.find(isBaseBreakpoint);
- if (baseBreakpoint === undefined) {
- return;
- }
const {
children,
instances: insertedInstances,
@@ -180,7 +174,7 @@ export const insertTemplate = (
styleSourceSelections: insertedStyleSourceSelections,
styleSources: insertedStyleSources,
styles: insertedStyles,
- } = generateDataFromEmbedTemplate(template, baseBreakpoint.id);
+ } = templateData;
const rootInstanceId = insertedInstances[0].id;
store.createTransaction(
[
@@ -247,7 +241,17 @@ export const insertNewComponentInstance = (
children: [],
},
];
- insertTemplate(template, dropTarget);
+ const breakpoints = breakpointsStore.get();
+ const breakpointValues = Array.from(breakpoints.values());
+ const baseBreakpoint = breakpointValues.find(isBaseBreakpoint);
+ if (baseBreakpoint === undefined) {
+ return;
+ }
+ const templateData = generateDataFromEmbedTemplate(
+ template,
+ baseBreakpoint.id
+ );
+ insertTemplateData(templateData, dropTarget);
};
export const reparentInstance = (
diff --git a/packages/react-sdk/src/embed-template.ts b/packages/react-sdk/src/embed-template.ts
index 1c634440bb..10ceacb571 100644
--- a/packages/react-sdk/src/embed-template.ts
+++ b/packages/react-sdk/src/embed-template.ts
@@ -297,3 +297,7 @@ export const generateDataFromEmbedTemplate = (
styles,
};
};
+
+export type EmbedTemplateData = ReturnType<
+ typeof generateDataFromEmbedTemplate
+>;