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.

WrapperComponent > WebstudioComponent (#1109)

Oleg Isonen4ace99eebd4c
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsx
index b564e031b1..267a84593b 100644
--- a/apps/builder/app/canvas/canvas.tsx
+++ b/apps/builder/app/canvas/canvas.tsx
@@ -18,7 +18,7 @@ import { useShortcuts } from "./shared/use-shortcuts";
import { usePublishTextEditingInstanceId } from "./shared/instance";
import { useManageDesignModeStyles, GlobalStyles } from "./shared/styles";
import { useTrackSelectedElement } from "./shared/use-track-selected-element";
-import { WrapperComponentDev } from "./features/wrapper-component";
+import { WebstudioComponentDev } from "./features/webstudio-component";
import {
propsIndexStore,
assetsStore,
@@ -61,7 +61,7 @@ const useElementsTree = (getComponent: GetComponent) => {
instance: rootInstance,
propsByInstanceIdStore,
assetsStore,
- Component: WrapperComponentDev,
+ Component: WebstudioComponentDev,
getComponent,
});
}, [rootInstance, getComponent]);
diff --git a/apps/builder/app/canvas/features/webstudio-component/index.ts b/apps/builder/app/canvas/features/webstudio-component/index.ts
new file mode 100644
index 0000000000..428fc570e7
--- /dev/null
+++ b/apps/builder/app/canvas/features/webstudio-component/index.ts
@@ -0,0 +1 @@
+export { WebstudioComponentDev } from "./webstudio-component";
diff --git a/apps/builder/app/canvas/features/wrapper-component/selected-instance-connector.ts b/apps/builder/app/canvas/features/webstudio-component/selected-instance-connector.ts
similarity index 100%
rename from apps/builder/app/canvas/features/wrapper-component/selected-instance-connector.ts
rename to apps/builder/app/canvas/features/webstudio-component/selected-instance-connector.ts
diff --git a/apps/builder/app/canvas/features/wrapper-component/wrapper-component.tsx b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx
similarity index 96%
rename from apps/builder/app/canvas/features/wrapper-component/wrapper-component.tsx
rename to apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx
index f630586a0b..ec0c62c899 100644
--- a/apps/builder/app/canvas/features/wrapper-component/wrapper-component.tsx
+++ b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx
@@ -5,7 +5,7 @@ import { useLexicalComposerContext } from "@lexical/react/LexicalComposerContext
import store from "immerhin";
import type { Instance, Prop } from "@webstudio-is/project-build";
import {
- renderWrapperComponentChildren,
+ renderWebstudioComponentChildren,
idAttribute,
collapsedAttribute,
} from "@webstudio-is/react-sdk";
@@ -65,17 +65,17 @@ const setDataCollapsed = (element?: HTMLElement) => {
type UserProps = Record<Prop["name"], Prop["value"]>;
-type WrapperComponentDevProps = {
+type WebstudioComponentDevProps = {
instance: Instance;
children: Array<JSX.Element | string>;
getComponent: GetComponent;
};
-export const WrapperComponentDev = ({
+export const WebstudioComponentDev = ({
instance,
children,
getComponent,
-}: WrapperComponentDevProps) => {
+}: WebstudioComponentDevProps) => {
const instanceId = instance.id;
const instanceElementRef = useRef<HTMLElement>();
const instanceStyles = useInstanceStyles(instanceId);
@@ -148,7 +148,7 @@ export const WrapperComponentDev = ({
{/* Component includes many types and it's hard to provide right ref type with useRef */}
{/* eslint-disable-next-line @typescript-eslint/no-explicit-any */}
<Component {...props} ref={instanceElementRef as any}>
- {renderWrapperComponentChildren(children)}
+ {renderWebstudioComponentChildren(children)}
</Component>
</>
);
diff --git a/apps/builder/app/canvas/features/wrapper-component/index.ts b/apps/builder/app/canvas/features/wrapper-component/index.ts
deleted file mode 100644
index 5547e9088a..0000000000
--- a/apps/builder/app/canvas/features/wrapper-component/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { WrapperComponentDev } from "./wrapper-component";
diff --git a/packages/react-sdk/src/app/custom-components/image.tsx b/packages/react-sdk/src/app/custom-components/image.tsx
index 6f112e997e..90f8f36958 100644
--- a/packages/react-sdk/src/app/custom-components/image.tsx
+++ b/packages/react-sdk/src/app/custom-components/image.tsx
@@ -7,7 +7,7 @@ import {
import { Image as WebstudioImage, loaders } from "@webstudio-is/image";
import { Image as SdkImage } from "../../components/image";
import { usePropAsset } from "../../props";
-import { idAttribute } from "../../tree/wrapper-component";
+import { idAttribute } from "../../tree/webstudio-component";
import { getParams } from "../params";
const defaultTag = "img";
diff --git a/packages/react-sdk/src/tree/create-elements-tree.tsx b/packages/react-sdk/src/tree/create-elements-tree.tsx
index a714d03a47..4054500da1 100644
--- a/packages/react-sdk/src/tree/create-elements-tree.tsx
+++ b/packages/react-sdk/src/tree/create-elements-tree.tsx
@@ -5,7 +5,7 @@ import type { Instance } from "@webstudio-is/project-build";
import type { GetComponent } from "../components/components-utils";
import { ReactSdkContext } from "../context";
import type { Assets, PropsByInstanceId } from "../props";
-import type { WrapperComponent } from "./wrapper-component";
+import type { WebstudioComponent } from "./webstudio-component";
import { SessionStoragePolyfill } from "./session-storage-polyfill";
export const createElementsTree = ({
@@ -20,7 +20,7 @@ export const createElementsTree = ({
instance: Instance;
propsByInstanceIdStore: ReadableAtom<PropsByInstanceId>;
assetsStore: ReadableAtom<Assets>;
- Component: (props: ComponentProps<typeof WrapperComponent>) => JSX.Element;
+ Component: (props: ComponentProps<typeof WebstudioComponent>) => JSX.Element;
getComponent: GetComponent;
}) => {
const children = createInstanceChildrenElements({
@@ -54,7 +54,7 @@ const createInstanceChildrenElements = ({
getComponent,
}: {
children: Instance["children"];
- Component: (props: ComponentProps<typeof WrapperComponent>) => JSX.Element;
+ Component: (props: ComponentProps<typeof WebstudioComponent>) => JSX.Element;
getComponent: GetComponent;
}) => {
const elements = [];
@@ -86,7 +86,7 @@ const createInstanceElement = ({
getComponent,
}: {
instance: Instance;
- Component: (props: ComponentProps<typeof WrapperComponent>) => JSX.Element;
+ Component: (props: ComponentProps<typeof WebstudioComponent>) => JSX.Element;
children?: Array<JSX.Element | string>;
getComponent: GetComponent;
}) => {
diff --git a/packages/react-sdk/src/tree/index.ts b/packages/react-sdk/src/tree/index.ts
index 4aa05834b2..99e480d589 100644
--- a/packages/react-sdk/src/tree/index.ts
+++ b/packages/react-sdk/src/tree/index.ts
@@ -1,3 +1,3 @@
export * from "./create-elements-tree";
export * from "./root";
-export * from "./wrapper-component";
+export * from "./webstudio-component";
diff --git a/packages/react-sdk/src/tree/root.ts b/packages/react-sdk/src/tree/root.ts
index d09ae5179f..efb70290ae 100644
--- a/packages/react-sdk/src/tree/root.ts
+++ b/packages/react-sdk/src/tree/root.ts
@@ -3,7 +3,7 @@ import { atom } from "nanostores";
import type { Tree } from "@webstudio-is/project-build";
import type { Asset } from "@webstudio-is/asset-uploader";
import { createElementsTree } from "./create-elements-tree";
-import { WrapperComponent } from "./wrapper-component";
+import { WebstudioComponent } from "./webstudio-component";
import { registerComponents } from "../components";
import { customComponents as defaultCustomComponents } from "../app/custom-components";
import { setParams, type Params } from "../app/params";
@@ -18,7 +18,7 @@ export type Data = {
type RootProps = {
data: Data;
- Component?: (props: ComponentProps<typeof WrapperComponent>) => JSX.Element;
+ Component?: (props: ComponentProps<typeof WebstudioComponent>) => JSX.Element;
customComponents?: Parameters<typeof registerComponents>[0];
getComponent: GetComponent;
};
@@ -43,7 +43,7 @@ export const InstanceRoot = ({
getPropsByInstanceId(new Map(data.tree.props))
),
assetsStore: atom(new Map(data.assets.map((asset) => [asset.id, asset]))),
- Component: Component ?? WrapperComponent,
+ Component: Component ?? WebstudioComponent,
getComponent,
});
};
diff --git a/packages/react-sdk/src/tree/wrapper-component.tsx b/packages/react-sdk/src/tree/webstudio-component.tsx
similarity index 85%
rename from packages/react-sdk/src/tree/wrapper-component.tsx
rename to packages/react-sdk/src/tree/webstudio-component.tsx
index e243f9f1ce..cbbee1cb4c 100644
--- a/packages/react-sdk/src/tree/wrapper-component.tsx
+++ b/packages/react-sdk/src/tree/webstudio-component.tsx
@@ -13,7 +13,7 @@ const renderText = (text: string): Array<JSX.Element> => {
));
};
-export const renderWrapperComponentChildren = (
+export const renderWebstudioComponentChildren = (
children: Array<JSX.Element | string> | undefined
): Array<JSX.Element | string | Array<JSX.Element | string>> | undefined => {
// Some elements like input can't have children
@@ -26,18 +26,18 @@ export const renderWrapperComponentChildren = (
});
};
-type WrapperComponentProps = {
+type WebstudioComponentProps = {
instance: Instance;
children: Array<JSX.Element | string>;
getComponent: GetComponent;
};
-export const WrapperComponent = ({
+export const WebstudioComponent = ({
instance,
children,
getComponent,
...rest
-}: WrapperComponentProps) => {
+}: WebstudioComponentProps) => {
const instanceProps = useInstanceProps(instance.id);
const props = {
...instanceProps,
@@ -50,7 +50,9 @@ export const WrapperComponent = ({
return <></>;
}
return (
- <Component {...props}>{renderWrapperComponentChildren(children)}</Component>
+ <Component {...props}>
+ {renderWebstudioComponentChildren(children)}
+ </Component>
);
};