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.

refactor: move canvas renderer into builder (#4382)

Bogdan Chadkin4234f88db817
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsx
index 3c2c9551c6..da55731cb2 100644
--- a/apps/builder/app/canvas/canvas.tsx
+++ b/apps/builder/app/canvas/canvas.tsx
@@ -5,10 +5,10 @@ import type { Instances } from "@webstudio-is/sdk";
import {
type Params,
type Components,
- createElementsTree,
coreMetas,
corePropsMetas,
} from "@webstudio-is/react-sdk";
+import { ReactSdkContext } from "@webstudio-is/react-sdk/runtime";
import * as baseComponents from "@webstudio-is/sdk-components-react";
import * as baseComponentMetas from "@webstudio-is/sdk-components-react/metas";
import * as baseComponentPropsMetas from "@webstudio-is/sdk-components-react/props";
@@ -66,6 +66,7 @@ import { useDebounceEffect } from "~/shared/hook-utils/use-debounce-effect";
import { subscribeSelected } from "./instance-selected";
import { subscribeScrollNewInstanceIntoView } from "./shared/scroll-new-instance-into-view";
import { $selectedPage } from "~/shared/awareness";
+import { createInstanceElement } from "./elements";
registerContainers();
@@ -108,18 +109,27 @@ const useElementsTree = (
}
return useMemo(() => {
- return createElementsTree({
- renderer: isPreviewMode ? "preview" : "canvas",
- imageBaseUrl: params.imageBaseUrl,
- assetBaseUrl: params.assetBaseUrl,
- imageLoader,
- instances,
- rootInstanceId,
- Component: isPreviewMode
- ? WebstudioComponentPreview
- : WebstudioComponentCanvas,
- components,
- });
+ return (
+ <ReactSdkContext.Provider
+ value={{
+ renderer: isPreviewMode ? "preview" : "canvas",
+ imageBaseUrl: params.imageBaseUrl,
+ assetBaseUrl: params.assetBaseUrl,
+ imageLoader,
+ resources: {},
+ }}
+ >
+ {createInstanceElement({
+ instances,
+ instanceId: rootInstanceId,
+ instanceSelector: [rootInstanceId],
+ Component: isPreviewMode
+ ? WebstudioComponentPreview
+ : WebstudioComponentCanvas,
+ components,
+ })}
+ </ReactSdkContext.Provider>
+ );
}, [
params,
instances,
diff --git a/apps/builder/app/canvas/elements.tsx b/apps/builder/app/canvas/elements.tsx
new file mode 100644
index 0000000000..77b782994d
--- /dev/null
+++ b/apps/builder/app/canvas/elements.tsx
@@ -0,0 +1,93 @@
+import {
+ Fragment,
+ type ForwardRefExoticComponent,
+ type RefAttributes,
+} from "react";
+import type { Instance, Instances } from "@webstudio-is/sdk";
+import type { Components } from "@webstudio-is/react-sdk";
+import type { InstanceSelector } from "~/shared/tree-utils";
+
+export type WebstudioComponentProps = {
+ instance: Instance;
+ instanceSelector: Instance["id"][];
+ components: Components;
+};
+
+export const createInstanceElement = ({
+ instances,
+ instanceId,
+ instanceSelector,
+ Component,
+ components,
+}: {
+ instances: Instances;
+ instanceId: Instance["id"];
+ instanceSelector: InstanceSelector;
+ Component: ForwardRefExoticComponent<
+ WebstudioComponentProps & RefAttributes<HTMLElement>
+ >;
+ components: Components;
+}) => {
+ const instance = instances.get(instanceId);
+ if (instance === undefined) {
+ return null;
+ }
+ return (
+ <Component
+ key={instance.id}
+ instance={instance}
+ instanceSelector={instanceSelector}
+ components={components}
+ />
+ );
+};
+
+const renderText = (text: string): Array<JSX.Element> => {
+ const lines = text.split("\n");
+ return lines.map((line, index) => (
+ <Fragment key={index}>
+ {line}
+ {index < lines.length - 1 && <br />}
+ </Fragment>
+ ));
+};
+
+export const createInstanceChildrenElements = ({
+ instances,
+ instanceSelector,
+ children,
+ Component,
+ components,
+}: {
+ instances: Instances;
+ instanceSelector: InstanceSelector;
+ children: Instance["children"];
+ Component: ForwardRefExoticComponent<
+ WebstudioComponentProps & RefAttributes<HTMLElement>
+ >;
+ components: Components;
+}) => {
+ const elements = children.map((child) => {
+ if (child.type === "text") {
+ return renderText(child.value);
+ }
+ if (child.type === "expression") {
+ return;
+ }
+ if (child.type === "id") {
+ return createInstanceElement({
+ instances,
+ instanceId: child.value,
+ instanceSelector: [child.value, ...instanceSelector],
+ Component,
+ components,
+ });
+ }
+ child satisfies never;
+ });
+ // let empty children be coalesced with fallback
+ if (elements.length === 0) {
+ return;
+ }
+ return elements;
+};
diff --git a/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx
index e378139aed..2c1cdfd458 100644
--- a/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx
+++ b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx
@@ -16,14 +16,12 @@ import { mergeRefs } from "@react-aria/utils";
import type { Instance, Instances, Prop } from "@webstudio-is/sdk";
import { findTreeInstanceIds } from "@webstudio-is/sdk";
import {
- type WebstudioComponentProps,
idAttribute,
componentAttribute,
showAttribute,
selectorIdAttribute,
indexAttribute,
getIndexesWithinAncestors,
- createInstanceChildrenElements,
collectionComponent,
type AnyComponent,
textContentAttribute,
@@ -48,6 +46,10 @@ import { getIsVisuallyHidden } from "~/shared/visually-hidden";
import { serverSyncStore } from "~/shared/sync";
import { TextEditor } from "../text-editor";
import { $selectedPage } from "~/shared/awareness";
+import {
+ createInstanceChildrenElements,
+ type WebstudioComponentProps,
+} from "~/canvas/elements";
const ContentEditable = ({
renderComponentWithRef,
diff --git a/packages/react-sdk/src/index.ts b/packages/react-sdk/src/index.ts
index d59f1cb6ba..11ed1987c3 100644
--- a/packages/react-sdk/src/index.ts
+++ b/packages/react-sdk/src/index.ts
@@ -1,6 +1,5 @@
export * from "./remix";
export * from "./css/index";
-export * from "./tree/index";
export * from "./core-components";
export * from "./components/components-utils";
export { PropMeta } from "./prop-meta";
diff --git a/packages/react-sdk/src/tree/create-elements-tree.tsx b/packages/react-sdk/src/tree/create-elements-tree.tsx
deleted file mode 100644
index fdb822b910..0000000000
--- a/packages/react-sdk/src/tree/create-elements-tree.tsx
+++ /dev/null
@@ -1,145 +0,0 @@
-import {
- Fragment,
- type ForwardRefExoticComponent,
- type ReactNode,
- type RefAttributes,
-} from "react";
-import type { Instance, Instances } from "@webstudio-is/sdk";
-import type { Components } from "../components/components-utils";
-import { type Params, ReactSdkContext } from "../context";
-import type { ImageLoader } from "@webstudio-is/image";
-
-type InstanceSelector = Instance["id"][];
-
-export type WebstudioComponentProps = {
- instance: Instance;
- instanceSelector: Instance["id"][];
- components: Components;
-};
-
-export const createElementsTree = ({
- renderer,
- assetBaseUrl,
- imageBaseUrl,
- imageLoader,
- instances,
- rootInstanceId,
- Component,
- components,
-}: Params & {
- instances: Instances;
- imageLoader: ImageLoader;
- rootInstanceId: Instance["id"];
-
- Component: ForwardRefExoticComponent<
- WebstudioComponentProps & RefAttributes<HTMLElement>
- >;
- components: Components;
-}) => {
- const rootInstance = instances.get(rootInstanceId);
- if (rootInstance === undefined) {
- return null;
- }
-
- const rootInstanceSelector = [rootInstanceId];
- const root = createInstanceElement({
- Component,
- instance: rootInstance,
- instanceSelector: rootInstanceSelector,
- components,
- });
- return (
- <ReactSdkContext.Provider
- value={{
- renderer,
- imageLoader,
- assetBaseUrl,
- imageBaseUrl,
- resources: {},
- }}
- >
- {root}
- </ReactSdkContext.Provider>
- );
-};
-
-const renderText = (text: string): Array<JSX.Element> => {
- const lines = text.split("\n");
- return lines.map((line, index) => (
- <Fragment key={index}>
- {line}
- {index < lines.length - 1 && <br />}
- </Fragment>
- ));
-};
-
-export const createInstanceChildrenElements = ({
- instances,
- instanceSelector,
- children,
- Component,
- components,
-}: {
- instances: Instances;
- instanceSelector: InstanceSelector;
- children: Instance["children"];
- Component: ForwardRefExoticComponent<
- WebstudioComponentProps & RefAttributes<HTMLElement>
- >;
- components: Components;
-}) => {
- const elements: ReactNode[] = [];
- for (const child of children) {
- if (child.type === "text") {
- elements.push(renderText(child.value));
- continue;
- }
- if (child.type === "expression") {
- continue;
- }
- if (child.type === "id") {
- const childInstance = instances.get(child.value);
- if (childInstance === undefined) {
- continue;
- }
- const childInstanceSelector = [child.value, ...instanceSelector];
- const element = createInstanceElement({
- instance: childInstance,
- instanceSelector: childInstanceSelector,
- Component,
- components,
- });
- elements.push(element);
- continue;
- }
- child satisfies never;
- }
- // let empty children be coalesced with fallback
- if (elements.length === 0) {
- return;
- }
- return elements;
-};
-
-const createInstanceElement = ({
- Component,
- instance,
- instanceSelector,
- components,
-}: {
- instance: Instance;
- instanceSelector: InstanceSelector;
- Component: ForwardRefExoticComponent<
- WebstudioComponentProps & RefAttributes<HTMLElement>
- >;
- components: Components;
-}) => {
- return (
- <Component
- key={instance.id}
- instance={instance}
- instanceSelector={instanceSelector}
- components={components}
- />
- );
-};
diff --git a/packages/react-sdk/src/tree/index.ts b/packages/react-sdk/src/tree/index.ts
deleted file mode 100644
index 271ce3a910..0000000000
--- a/packages/react-sdk/src/tree/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export * from "./create-elements-tree";