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.

Namespace component libraries (#2005)

Bogdan Chadkin381a9624372c
diff --git a/apps/builder/app/builder/features/settings-panel/props-section/props-section.stories.tsx b/apps/builder/app/builder/features/settings-panel/props-section/props-section.stories.tsx
index 8ad72b83d9..7757e7aaef 100644
--- a/apps/builder/app/builder/features/settings-panel/props-section/props-section.stories.tsx
+++ b/apps/builder/app/builder/features/settings-panel/props-section/props-section.stories.tsx
@@ -6,7 +6,7 @@ import {
instancesStore,
pagesStore,
propsStore,
- registerComponentPropsMetas,
+ registerComponentLibrary,
selectedPageIdStore,
} from "~/shared/nano-states";
import { setMockEnv } from "~/shared/env";
@@ -204,57 +204,61 @@ const checkProp = (options = defaultOptions, label?: string): PropMeta => ({
label,
});
-registerComponentPropsMetas({
- Box: {
- props: {
- initialText: textProp("", "multi\nline"),
- initialShortText: shortTextProp(),
- initialNumber: numberProp(),
- initialBoolean: booleanProp(),
- initialColor: colorProp(),
- initialRadio: radioProp(),
- initialSelect: selectProp(),
- initialCheck: checkProp(),
- initialUrl: urlProp(),
- initialFile: fileProp("Initial File (PNG only)", ".png"),
- addedText: textProp(),
- addedShortText: shortTextProp(),
- addedNumber: numberProp(),
- addedBoolean: booleanProp(),
- addedColor: colorProp(),
- addedRadio: radioProp(),
- addedSelect: selectProp(),
- addedCheck: checkProp(),
- addedUrlUrl: urlProp("Added URL (URL)"),
- addedUrlPage: urlProp("Added URL (Page)"),
- addedUrlSection: urlProp("Added URL (Section)"),
- addedUrlEmail: urlProp("Added URL (Email)"),
- addedUrlPhone: urlProp("Added URL (Phone)"),
- addedUrlAttachment: urlProp("Added URL (Attachment)"),
- addedFile: fileProp(),
- availableText: textProp(),
- availableShortText: shortTextProp(),
- availableNumber: numberProp(),
- availableBoolean: booleanProp(),
- availableColor: colorProp(),
- availableRadio: radioProp(),
- availableSelect: selectProp(),
- availableCheck: checkProp(),
- availableUrl: urlProp(),
- availableFile: fileProp(),
+registerComponentLibrary({
+ components: {},
+ metas: {},
+ propsMetas: {
+ Box: {
+ props: {
+ initialText: textProp("", "multi\nline"),
+ initialShortText: shortTextProp(),
+ initialNumber: numberProp(),
+ initialBoolean: booleanProp(),
+ initialColor: colorProp(),
+ initialRadio: radioProp(),
+ initialSelect: selectProp(),
+ initialCheck: checkProp(),
+ initialUrl: urlProp(),
+ initialFile: fileProp("Initial File (PNG only)", ".png"),
+ addedText: textProp(),
+ addedShortText: shortTextProp(),
+ addedNumber: numberProp(),
+ addedBoolean: booleanProp(),
+ addedColor: colorProp(),
+ addedRadio: radioProp(),
+ addedSelect: selectProp(),
+ addedCheck: checkProp(),
+ addedUrlUrl: urlProp("Added URL (URL)"),
+ addedUrlPage: urlProp("Added URL (Page)"),
+ addedUrlSection: urlProp("Added URL (Section)"),
+ addedUrlEmail: urlProp("Added URL (Email)"),
+ addedUrlPhone: urlProp("Added URL (Phone)"),
+ addedUrlAttachment: urlProp("Added URL (Attachment)"),
+ addedFile: fileProp(),
+ availableText: textProp(),
+ availableShortText: shortTextProp(),
+ availableNumber: numberProp(),
+ availableBoolean: booleanProp(),
+ availableColor: colorProp(),
+ availableRadio: radioProp(),
+ availableSelect: selectProp(),
+ availableCheck: checkProp(),
+ availableUrl: urlProp(),
+ availableFile: fileProp(),
+ },
+ initialProps: [
+ "initialText",
+ "initialShortText",
+ "initialNumber",
+ "initialBoolean",
+ "initialColor",
+ "initialRadio",
+ "initialSelect",
+ "initialCheck",
+ "initialUrl",
+ "initialFile",
+ ],
},
- initialProps: [
- "initialText",
- "initialShortText",
- "initialNumber",
- "initialBoolean",
- "initialColor",
- "initialRadio",
- "initialSelect",
- "initialCheck",
- "initialUrl",
- "initialFile",
- ],
},
});
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsx
index b4b39da42f..0cc1297389 100644
--- a/apps/builder/app/canvas/canvas.tsx
+++ b/apps/builder/app/canvas/canvas.tsx
@@ -33,10 +33,11 @@ import {
instancesStore,
useIsPreviewMode,
selectedPageStore,
- registerComponentMetas,
- registerComponentPropsMetas,
+ registerComponentLibrary,
dataSourceValuesStore,
dataSourceVariablesStore,
+ type ComponentsRecord,
+ registeredComponentsStore,
} from "~/shared/nano-states";
import { useDragAndDrop } from "./shared/use-drag-drop";
import { useCopyPaste } from "~/shared/copy-paste";
@@ -46,6 +47,7 @@ import { subscribeInstanceSelection } from "./instance-selection";
import { subscribeInstanceHovering } from "./instance-hovering";
import { useHashLinkSync } from "~/shared/pages";
import { useMount } from "~/shared/hook-utils/use-mount";
+import { Scripts, ScrollRestoration } from "@remix-run/react";
registerContainers();
@@ -54,19 +56,6 @@ const propsByInstanceIdStore = computed(
(propsIndex) => propsIndex.propsByInstanceId
);
-const temporaryRootInstanceId = "temporaryRootInstance";
-const temporaryInstances: Instances = new Map([
- [
- temporaryRootInstanceId,
- {
- type: "instance",
- id: temporaryRootInstanceId,
- component: "Body",
- children: [],
- },
- ],
-]);
-
const executeEffectfulExpressionWithDecodedVariables: typeof executeEffectfulExpression =
(code, args, values) => {
return decodeVariablesMap(
@@ -82,11 +71,14 @@ const onDataSourceUpdate = (newValues: Map<DataSource["id"], unknown>) => {
dataSourceVariablesStore.set(dataSourceVariables);
};
-const useElementsTree = (components: Components, params: Params) => {
- const instances = useStore(instancesStore);
+const useElementsTree = (
+ components: Components,
+ instances: Instances,
+ params: Params
+) => {
const page = useStore(selectedPageStore);
const [isPreviewMode] = useIsPreviewMode();
- const rootInstanceId = page?.rootInstanceId;
+ const rootInstanceId = page?.rootInstanceId ?? "";
if (typeof window === "undefined") {
// @todo remove after https://github.com/webstudio-is/webstudio-builder/issues/1313 now its needed to be sure that no leaks exists
@@ -116,10 +108,10 @@ const useElementsTree = (components: Components, params: Params) => {
renderer: isPreviewMode ? "preview" : "canvas",
imageBaseUrl: params.imageBaseUrl,
assetBaseUrl: params.assetBaseUrl,
- instances: instances.size === 0 ? temporaryInstances : instances,
+ instances,
// fallback to temporary root instance to render scripts
// and receive real data from builder
- rootInstanceId: rootInstanceId ?? temporaryRootInstanceId,
+ rootInstanceId,
propsByInstanceIdStore,
assetsStore,
pagesStore: pagesMapStore,
@@ -164,14 +156,17 @@ export const Canvas = ({ params }: CanvasProps): JSX.Element | null => {
useCanvasStore(publish);
const [isPreviewMode] = useIsPreviewMode();
- const components = new Map(
- Object.entries({ ...baseComponents, ...remixComponents })
- ) as Components;
useMount(() => {
- registerComponentMetas(baseComponentMetas);
- registerComponentPropsMetas(baseComponentPropsMetas);
- registerComponentMetas(remixComponentMetas);
- registerComponentPropsMetas(remixComponentPropsMetas);
+ registerComponentLibrary({
+ components: baseComponents as unknown as ComponentsRecord,
+ metas: baseComponentMetas,
+ propsMetas: baseComponentPropsMetas,
+ });
+ registerComponentLibrary({
+ components: remixComponents as unknown as ComponentsRecord,
+ metas: remixComponentMetas,
+ propsMetas: remixComponentPropsMetas,
+ });
});
// e.g. toggling preview is still needed in both modes
@@ -197,7 +192,18 @@ export const Canvas = ({ params }: CanvasProps): JSX.Element | null => {
useHashLinkSync();
- const elements = useElementsTree(components, params);
+ const components = useStore(registeredComponentsStore);
+ const instances = useStore(instancesStore);
+ const elements = useElementsTree(components, instances, params);
+
+ if (components.size === 0 || instances.size === 0) {
+ return (
+ <body>
+ <ScrollRestoration />
+ <Scripts />
+ </body>
+ );
+ }
return (
<>
diff --git a/apps/builder/app/shared/nano-states/components-meta.ts b/apps/builder/app/shared/nano-states/components-meta.ts
deleted file mode 100644
index e9e40b4dd9..0000000000
--- a/apps/builder/app/shared/nano-states/components-meta.ts
+++ /dev/null
@@ -1,51 +0,0 @@
-import { atom } from "nanostores";
-import type {
- WsComponentMeta,
- WsComponentPropsMeta,
-} from "@webstudio-is/react-sdk";
-
-export const registeredComponentMetasStore = atom(
- new Map<string, WsComponentMeta>()
-);
-
-export const registerComponentMetas = (
- newMetas: Record<string, WsComponentMeta>
-) => {
- const prevMetas = registeredComponentMetasStore.get();
- const nextMetas = new Map(prevMetas);
- for (const [componentName, meta] of Object.entries(newMetas)) {
- nextMetas.set(componentName, meta);
- }
- registeredComponentMetasStore.set(nextMetas);
-};
-
-export const registeredComponentPropsMetasStore = atom(
- new Map<string, WsComponentPropsMeta>()
-);
-
-export const registerComponentPropsMetas = (
- newPropsMetas: Record<string, WsComponentPropsMeta>
-) => {
- const prevPropsMetas = registeredComponentPropsMetasStore.get();
- const nextPropsMetas = new Map(prevPropsMetas);
- for (const [componentName, propsMeta] of Object.entries(newPropsMetas)) {
- const { initialProps = [], props } = propsMeta;
- const requiredProps: string[] = [];
- for (const [name, value] of Object.entries(props)) {
- if (value.required && initialProps.includes(name) === false) {
- requiredProps.push(name);
- }
- }
- nextPropsMetas.set(componentName, {
- // order of initialProps must be preserved
- initialProps: [...initialProps, ...requiredProps],
- props,
- });
- }
- registeredComponentPropsMetasStore.set(nextPropsMetas);
-};
-
-export const synchronizedComponentsMetaStores = [
- ["registeredComponentMetas", registeredComponentMetasStore],
- ["registeredComponentPropsMetas", registeredComponentPropsMetasStore],
-] as const;
diff --git a/apps/builder/app/shared/nano-states/components.ts b/apps/builder/app/shared/nano-states/components.ts
new file mode 100644
index 0000000000..ab370da85e
--- /dev/null
+++ b/apps/builder/app/shared/nano-states/components.ts
@@ -0,0 +1,79 @@
+import { atom } from "nanostores";
+import {
+ namespaceEmbedTemplateComponents,
+ type AnyComponent,
+ type WsComponentMeta,
+ type WsComponentPropsMeta,
+} from "@webstudio-is/react-sdk";
+import type { Instance } from "@webstudio-is/project-build";
+
+export type ComponentsRecord = Record<Instance["component"], AnyComponent>;
+
+export const registeredComponentsStore = atom(new Map<string, AnyComponent>());
+
+export const registeredComponentMetasStore = atom(
+ new Map<string, WsComponentMeta>()
+);
+
+export const registeredComponentPropsMetasStore = atom(
+ new Map<string, WsComponentPropsMeta>()
+);
+
+export const registerComponentLibrary = ({
+ namespace,
+ components,
+ metas,
+ propsMetas,
+}: {
+ namespace?: string;
+ components: ComponentsRecord;
+ metas: Record<Instance["component"], WsComponentMeta>;
+ propsMetas: Record<Instance["component"], WsComponentPropsMeta>;
+}) => {
+ const prefix = namespace === undefined ? "" : `${namespace}:`;
+
+ const prevComponents = registeredComponentsStore.get();
+ const nextComponents = new Map(prevComponents);
+ for (const [componentName, component] of Object.entries(components)) {
+ nextComponents.set(`${prefix}${componentName}`, component);
+ }
+ registeredComponentsStore.set(nextComponents);
+
+ const prevMetas = registeredComponentMetasStore.get();
+ const nextMetas = new Map(prevMetas);
+ for (const [componentName, meta] of Object.entries(metas)) {
+ const newMeta = { ...meta };
+ if (meta.template !== undefined && namespace !== undefined) {
+ meta.template = namespaceEmbedTemplateComponents(
+ meta.template,
+ namespace,
+ new Set(Object.keys(metas))
+ );
+ }
+ nextMetas.set(`${prefix}${componentName}`, newMeta);
+ }
+ registeredComponentMetasStore.set(nextMetas);
+
+ const prevPropsMetas = registeredComponentPropsMetasStore.get();
+ const nextPropsMetas = new Map(prevPropsMetas);
+ for (const [componentName, propsMeta] of Object.entries(propsMetas)) {
+ const { initialProps = [], props } = propsMeta;
+ const requiredProps: string[] = [];
+ for (const [name, value] of Object.entries(props)) {
+ if (value.required && initialProps.includes(name) === false) {
+ requiredProps.push(name);
+ }
+ }
+ nextPropsMetas.set(`${prefix}${componentName}`, {
+ // order of initialProps must be preserved
+ initialProps: [...initialProps, ...requiredProps],
+ props,
+ });
+ }
+ registeredComponentPropsMetasStore.set(nextPropsMetas);
+};
+
+export const synchronizedComponentsMetaStores = [
+ ["registeredComponentMetas", registeredComponentMetasStore],
+ ["registeredComponentPropsMetas", registeredComponentPropsMetasStore],
+] as const;
diff --git a/apps/builder/app/shared/nano-states/index.ts b/apps/builder/app/shared/nano-states/index.ts
index 3ed9982fe0..546810d68b 100644
--- a/apps/builder/app/shared/nano-states/index.ts
+++ b/apps/builder/app/shared/nano-states/index.ts
@@ -3,4 +3,4 @@ export * from "./breakpoints";
export * from "./instances";
export * from "./canvas";
export * from "./pages";
-export * from "./components-meta";
+export * from "./components";
diff --git a/packages/react-sdk/src/embed-template.test.ts b/packages/react-sdk/src/embed-template.test.ts
index 1f9365771d..4f38c9ceef 100644
--- a/packages/react-sdk/src/embed-template.test.ts
+++ b/packages/react-sdk/src/embed-template.test.ts
@@ -1,5 +1,8 @@
import { expect, test } from "@jest/globals";
-import { generateDataFromEmbedTemplate } from "./embed-template";
+import {
+ generateDataFromEmbedTemplate,
+ namespaceEmbedTemplateComponents,
+} from "./embed-template";
import { showAttribute } from "./tree";
const expectString = expect.any(String);
@@ -489,3 +492,51 @@ test("generate data for embedding from action props", () => {
styles: [],
});
});
+
+test("add namespace to selected components in embed template", () => {
+ expect(
+ namespaceEmbedTemplateComponents(
+ [
+ {
+ type: "instance",
+ component: "Tooltip",
+ children: [
+ { type: "text", value: "Some text" },
+ {
+ type: "instance",
+ component: "Box",
+ children: [
+ {
+ type: "instance",
+ component: "Button",
+ children: [],
+ },
+ ],
+ },
+ ],
+ },
+ ],
+ "my-namespace",
+ new Set(["Tooltip", "Button"])
+ )
+ ).toEqual([
+ {
+ type: "instance",
+ component: "my-namespace:Tooltip",
+ children: [
+ { type: "text", value: "Some text" },
+ {
+ type: "instance",
+ component: "Box",
+ children: [
+ {
+ type: "instance",
+ component: "my-namespace:Button",
+ children: [],
+ },
+ ],
+ },
+ ],
+ },
+ ]);
+});
diff --git a/packages/react-sdk/src/embed-template.ts b/packages/react-sdk/src/embed-template.ts
index 781cf7ee35..b7b9a8ffd3 100644
--- a/packages/react-sdk/src/embed-template.ts
+++ b/packages/react-sdk/src/embed-template.ts
@@ -1,7 +1,7 @@
import { z } from "zod";
import { nanoid } from "nanoid";
import {
- type Instance,
+ Instance,
type InstancesList,
PropsList,
StyleSourceSelectionsList,
@@ -308,3 +308,29 @@ export const generateDataFromEmbedTemplate = (
export type EmbedTemplateData = ReturnType<
typeof generateDataFromEmbedTemplate
>;
+
+export const namespaceEmbedTemplateComponents = (
+ template: WsEmbedTemplate,
+ namespace: string,
+ components: Set<EmbedTemplateInstance["component"]>
+): WsEmbedTemplate => {
+ return template.map((item) => {
+ if (item.type === "text") {
+ return item;
+ }
+ if (item.type === "instance") {
+ const prefix = components.has(item.component) ? `${namespace}:` : "";
+ return {
+ ...item,
+ component: `${prefix}${item.component}`,
+ children: namespaceEmbedTemplateComponents(
+ item.children,
+ namespace,
+ components
+ ),
+ };
+ }
+ item satisfies never;
+ throw Error("Impossible case");
+ });
+};