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.

Allow to specify tree template in component meta (#1517)

Bogdan Chadkin30be97deef5d
diff --git a/apps/builder/app/shared/instance-utils.ts b/apps/builder/app/shared/instance-utils.ts
index 8c3b970803..fc5961b92e 100644
--- a/apps/builder/app/shared/instance-utils.ts
+++ b/apps/builder/app/shared/instance-utils.ts
@@ -25,13 +25,19 @@ export const insertNewComponentInstance = (
component: string,
dropTarget: DroppableTarget
) => {
- const instance = createComponentInstance(component);
+ const insertedInstances = createComponentInstance(component);
+ const rootInstanceId = insertedInstances[0].id;
store.createTransaction([instancesStore], (instances) => {
- insertInstancesMutable(instances, [instance], [instance.id], dropTarget);
+ insertInstancesMutable(
+ instances,
+ insertedInstances,
+ [rootInstanceId],
+ dropTarget
+ );
});
selectedInstanceSelectorStore.set([
- instance.id,
+ rootInstanceId,
...dropTarget.parentSelector,
]);
selectedStyleSourceSelectorStore.set(undefined);
diff --git a/apps/builder/app/shared/tree-utils.ts b/apps/builder/app/shared/tree-utils.ts
index 2218daa9ac..1d6f42ac51 100644
--- a/apps/builder/app/shared/tree-utils.ts
+++ b/apps/builder/app/shared/tree-utils.ts
@@ -16,7 +16,10 @@ import {
StyleSourceSelection,
StyleSourceSelections,
} from "@webstudio-is/project-build";
-import { getComponentMeta } from "@webstudio-is/react-sdk";
+import {
+ generateDataFromEmbedTemplate,
+ getComponentMeta,
+} from "@webstudio-is/react-sdk";
import { equalMedia } from "@webstudio-is/css-engine";
// slots can have multiple parents so instance should be addressed
@@ -48,17 +51,19 @@ export const areInstanceSelectorsEqual = (
return left.join(",") === right.join(",");
};
-export const createComponentInstance = (
- component: Instance["component"]
-): Instance => {
+export const createComponentInstance = (component: Instance["component"]) => {
const componentMeta = getComponentMeta(component);
- return {
+ const { children, instances } = generateDataFromEmbedTemplate(
+ componentMeta?.children ?? []
+ );
+ // put first to be interpreted as root
+ instances.unshift({
type: "instance",
id: nanoid(),
component,
- children:
- componentMeta?.children?.map((value) => ({ type: "text", value })) ?? [],
- };
+ children,
+ });
+ return instances;
};
const isInstanceDroppable = (instance: Instance) => {
diff --git a/packages/react-sdk/package.json b/packages/react-sdk/package.json
index 2438f53520..071e502a1a 100644
--- a/packages/react-sdk/package.json
+++ b/packages/react-sdk/package.json
@@ -55,6 +55,7 @@
"detect-font": "^0.1.5",
"html-tags": "^3.2.0",
"nanoevents": "^7.0.1",
+ "nanoid": "^3.2.0",
"nanostores": "^0.7.1"
},
"exports": {
diff --git a/packages/react-sdk/src/components/blockquote.ws.tsx b/packages/react-sdk/src/components/blockquote.ws.tsx
index 075e92d284..97889ff6d6 100644
--- a/packages/react-sdk/src/components/blockquote.ws.tsx
+++ b/packages/react-sdk/src/components/blockquote.ws.tsx
@@ -74,7 +74,7 @@ export const meta: WsComponentMeta = {
label: "Blockquote",
Icon: BlockquoteIcon,
presetStyle,
- children: ["Blockquote you can edit"],
+ children: [{ type: "text", value: "Blockquote you can edit" }],
};
export const propsMeta: WsComponentPropsMeta = {
diff --git a/packages/react-sdk/src/components/code.ws.tsx b/packages/react-sdk/src/components/code.ws.tsx
index 3d80c9d1ac..b63439d05f 100644
--- a/packages/react-sdk/src/components/code.ws.tsx
+++ b/packages/react-sdk/src/components/code.ws.tsx
@@ -46,7 +46,7 @@ export const meta: WsComponentMeta = {
label: "Code",
Icon: CodeIcon,
presetStyle,
- children: ["Code you can edit"],
+ children: [{ type: "text", value: "Code you can edit" }],
};
export const propsMeta: WsComponentPropsMeta = {
diff --git a/packages/react-sdk/src/components/component-meta.ts b/packages/react-sdk/src/components/component-meta.ts
index a0af78a464..ae83dab616 100644
--- a/packages/react-sdk/src/components/component-meta.ts
+++ b/packages/react-sdk/src/components/component-meta.ts
@@ -4,6 +4,7 @@ import type { IconProps } from "@webstudio-is/icons";
import type { Style } from "@webstudio-is/css-data";
import { PropMeta } from "@webstudio-is/generate-arg-types";
import type { htmlTags as HtmlTags } from "html-tags";
+import { WsEmbedTemplate } from "../embed-template";
type PresetStyle = Partial<Record<HtmlTags, Style>>;
@@ -48,7 +49,7 @@ const WsComponentMeta = z.object({
Icon: z.function(),
presetStyle: z.optional(z.any()),
states: z.optional(z.array(ComponentState)),
- children: z.optional(z.array(z.string())),
+ children: z.optional(WsEmbedTemplate),
});
export type WsComponentMeta = Omit<
diff --git a/packages/react-sdk/src/components/form.ws.tsx b/packages/react-sdk/src/components/form.ws.tsx
index 71211811fd..425828c2ad 100644
--- a/packages/react-sdk/src/components/form.ws.tsx
+++ b/packages/react-sdk/src/components/form.ws.tsx
@@ -22,6 +22,14 @@ export const meta: WsComponentMeta = {
label: "Form",
Icon: FormIcon,
presetStyle,
+ children: [
+ { type: "instance", component: "Input", children: [] },
+ {
+ type: "instance",
+ component: "Button",
+ children: [{ type: "text", value: "Submit" }],
+ },
+ ],
};
export const propsMeta: WsComponentPropsMeta = {
diff --git a/packages/react-sdk/src/components/heading.ws.tsx b/packages/react-sdk/src/components/heading.ws.tsx
index ccaf676cc2..183f789bce 100644
--- a/packages/react-sdk/src/components/heading.ws.tsx
+++ b/packages/react-sdk/src/components/heading.ws.tsx
@@ -22,7 +22,7 @@ export const meta: WsComponentMeta = {
type: "rich-text",
label: "Heading",
Icon: HeadingIcon,
- children: ["Heading you can edit"],
+ children: [{ type: "text", value: "Heading you can edit" }],
presetStyle,
};
diff --git a/packages/react-sdk/src/components/link.ws.tsx b/packages/react-sdk/src/components/link.ws.tsx
index ae169c0bd1..c532fdd97b 100644
--- a/packages/react-sdk/src/components/link.ws.tsx
+++ b/packages/react-sdk/src/components/link.ws.tsx
@@ -27,7 +27,7 @@ export const meta: WsComponentMeta = {
Icon: LinkIcon,
presetStyle,
states: [{ selector: "[aria-current=page]", label: "Current page" }],
- children: ["Link text you can edit"],
+ children: [{ type: "text", value: "Link text you can edit" }],
};
export const propsMeta: WsComponentPropsMeta = {
diff --git a/packages/react-sdk/src/components/list-item.ws.tsx b/packages/react-sdk/src/components/list-item.ws.tsx
index 5fd0138e4f..edccf98a39 100644
--- a/packages/react-sdk/src/components/list-item.ws.tsx
+++ b/packages/react-sdk/src/components/list-item.ws.tsx
@@ -14,7 +14,7 @@ export const meta: WsComponentMeta = {
type: "rich-text",
label: "List Item",
Icon: ListItemIcon,
- children: ["List Item you can edit"],
+ children: [{ type: "text", value: "List Item you can edit" }],
presetStyle,
};
diff --git a/packages/react-sdk/src/components/paragraph.ws.tsx b/packages/react-sdk/src/components/paragraph.ws.tsx
index 6d4687c2d6..1b6993e939 100644
--- a/packages/react-sdk/src/components/paragraph.ws.tsx
+++ b/packages/react-sdk/src/components/paragraph.ws.tsx
@@ -14,7 +14,7 @@ export const meta: WsComponentMeta = {
type: "rich-text",
label: "Paragraph",
Icon: TextAlignLeftIcon,
- children: ["Pragraph you can edit"],
+ children: [{ type: "text", value: "Pragraph you can edit" }],
presetStyle,
};
diff --git a/packages/react-sdk/src/components/text-block.ws.tsx b/packages/react-sdk/src/components/text-block.ws.tsx
index d4a1780764..4f3a0394c3 100644
--- a/packages/react-sdk/src/components/text-block.ws.tsx
+++ b/packages/react-sdk/src/components/text-block.ws.tsx
@@ -23,7 +23,7 @@ export const meta: WsComponentMeta = {
label: "Text Block",
Icon: TextBlockIcon,
presetStyle,
- children: ["Block of text you can edit"],
+ children: [{ type: "text", value: "Block of text you can edit" }],
};
export const propsMeta: WsComponentPropsMeta = {
diff --git a/packages/react-sdk/src/embed-template.test.ts b/packages/react-sdk/src/embed-template.test.ts
new file mode 100644
index 0000000000..4b782a5c04
--- /dev/null
+++ b/packages/react-sdk/src/embed-template.test.ts
@@ -0,0 +1,42 @@
+import { expect, test } from "@jest/globals";
+import { generateDataFromEmbedTemplate } from "./embed-template";
+
+const expectString = expect.any(String) as unknown as string;
+
+test("generate tree from template", () => {
+ expect(
+ generateDataFromEmbedTemplate([
+ { type: "text", value: "hello" },
+ {
+ type: "instance",
+ component: "Box1",
+ children: [
+ { type: "instance", component: "Box2", children: [] },
+ { type: "text", value: "world" },
+ ],
+ },
+ ])
+ ).toEqual({
+ children: [
+ { type: "text", value: "hello" },
+ { type: "id", value: expectString },
+ ],
+ instances: [
+ {
+ type: "instance",
+ id: expectString,
+ component: "Box1",
+ children: [
+ { type: "id", value: expectString },
+ { type: "text", value: "world" },
+ ],
+ },
+ {
+ type: "instance",
+ id: expectString,
+ component: "Box2",
+ children: [],
+ },
+ ],
+ });
+});
diff --git a/packages/react-sdk/src/embed-template.ts b/packages/react-sdk/src/embed-template.ts
new file mode 100644
index 0000000000..9f399ac692
--- /dev/null
+++ b/packages/react-sdk/src/embed-template.ts
@@ -0,0 +1,68 @@
+import { z } from "zod";
+import { nanoid } from "nanoid";
+import type { Instance, InstancesList } from "@webstudio-is/project-build";
+
+const EmbedTemplateText = z.object({
+ type: z.literal("text"),
+ value: z.string(),
+});
+
+type EmbedTemplateText = z.infer<typeof EmbedTemplateText>;
+
+type EmbedTemplateInstance = {
+ type: "instance";
+ component: string;
+ children: Array<EmbedTemplateInstance | EmbedTemplateText>;
+};
+
+const EmbedTemplateInstancen: z.ZodType<EmbedTemplateInstance> = z.object({
+ type: z.literal("instance"),
+ component: z.string(),
+ children: z.lazy(() => WsEmbedTemplate),
+});
+
+export const WsEmbedTemplate = z.array(
+ z.union([z.lazy(() => EmbedTemplateInstancen), EmbedTemplateText])
+);
+
+export type WsEmbedTemplate = z.infer<typeof WsEmbedTemplate>;
+
+const createInstancesFromTemplate = (
+ treeTemplate: WsEmbedTemplate,
+ instances: InstancesList
+) => {
+ const parentChildren: Instance["children"] = [];
+ for (const item of treeTemplate) {
+ if (item.type === "instance") {
+ const instanceId = nanoid();
+ const instance: Instance = {
+ type: "instance",
+ id: instanceId,
+ component: item.component,
+ children: [],
+ };
+ instances.push(instance);
+ // traverse children after to preserve top down order
+ instance.children = createInstancesFromTemplate(item.children, instances);
+ parentChildren.push({
+ type: "id",
+ value: instanceId,
+ });
+ }
+ if (item.type === "text") {
+ parentChildren.push({
+ type: "text",
+ value: item.value,
+ });
+ }
+ }
+ return parentChildren;
+};
+
+export const generateDataFromEmbedTemplate = (
+ treeTemplate: WsEmbedTemplate
+) => {
+ const instances: InstancesList = [];
+ const children = createInstancesFromTemplate(treeTemplate, instances);
+ return { children, instances };
+};
diff --git a/packages/react-sdk/src/index.ts b/packages/react-sdk/src/index.ts
index 980fc8cc17..bc439268c5 100644
--- a/packages/react-sdk/src/index.ts
+++ b/packages/react-sdk/src/index.ts
@@ -16,3 +16,4 @@ export {
type ComponentState,
componentCategories,
} from "./components/component-meta";
+export * from "./embed-template";
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index faf6c425cb..3b6688bda4 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -1177,6 +1177,9 @@ importers:
nanoevents:
specifier: ^7.0.1
version: 7.0.1
+ nanoid:
+ specifier: ^3.2.0
+ version: 3.3.4
nanostores:
specifier: ^0.7.1
version: 0.7.1