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.

Add html component (#1624)

Bogdan Chadkin37f376573ed8
diff --git a/apps/builder/app/builder/features/props-panel/controls/code.tsx b/apps/builder/app/builder/features/props-panel/controls/code.tsx
new file mode 100644
index 0000000000..eb1b2d49e6
--- /dev/null
+++ b/apps/builder/app/builder/features/props-panel/controls/code.tsx
@@ -0,0 +1,39 @@
+import type { ControlProps } from "../shared";
+import { TextControl } from "./text";
+
+export const CodeControl = ({
+ instanceId,
+ meta,
+ prop,
+ propName,
+ onChange,
+ onDelete,
+ onSoftDelete,
+}: ControlProps<"code", "string">) => {
+ return (
+ <TextControl
+ instanceId={instanceId}
+ meta={{
+ ...meta,
+ control: "text",
+ }}
+ prop={prop}
+ propName={propName}
+ onChange={(value) => {
+ if (value.type === "string") {
+ // sanitize html before saving
+ // this is basically what browser does when innerHTML is set
+ // but isolated within temporary element
+ // so the result is correct markup
+ const div = document.createElement("div");
+ div.innerHTML = value.value;
+ onChange({ type: "string", value: div.innerHTML });
+ } else {
+ onChange(value);
+ }
+ }}
+ onDelete={onDelete}
+ onSoftDelete={onSoftDelete}
+ />
+ );
+};
diff --git a/apps/builder/app/builder/features/props-panel/controls/combined.tsx b/apps/builder/app/builder/features/props-panel/controls/combined.tsx
index def0865b80..f2d66d1898 100644
--- a/apps/builder/app/builder/features/props-panel/controls/combined.tsx
+++ b/apps/builder/app/builder/features/props-panel/controls/combined.tsx
@@ -1,4 +1,5 @@
import { TextControl } from "./text";
+import { CodeControl } from "./code";
import { ColorControl } from "./color";
import { NumberControl } from "./number";
import { CheckControl } from "./check";
@@ -21,6 +22,13 @@ export const renderControl = ({
return <TextControl meta={meta} prop={prop} {...rest} />;
}
+ if (
+ meta.control === "code" &&
+ (prop === undefined || prop.type === "string")
+ ) {
+ return <CodeControl meta={meta} prop={prop} {...rest} />;
+ }
+
if (
meta.control === "color" &&
(prop === undefined || prop.type === "string")
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsx
index e48ffc4dea..5f4ba45074 100644
--- a/apps/builder/app/canvas/canvas.tsx
+++ b/apps/builder/app/canvas/canvas.tsx
@@ -93,6 +93,7 @@ const useElementsTree = (getComponent: GetComponent) => {
return useMemo(() => {
return createElementsTree({
+ renderer: "canvas",
instances: instances.size === 0 ? temporaryInstances : instances,
// fallback to temporary root instance to render scripts
// and receive real data from builder
diff --git a/packages/generate-arg-types/src/types.ts b/packages/generate-arg-types/src/types.ts
index 423e196755..eb37d2cc86 100644
--- a/packages/generate-arg-types/src/types.ts
+++ b/packages/generate-arg-types/src/types.ts
@@ -42,6 +42,18 @@ const Text = z.object({
rows: z.number().optional(),
});
+const Code = z.object({
+ ...common,
+ control: z.literal("code"),
+ type: z.literal("string"),
+ defaultValue: z.string().optional(),
+ /**
+ * The number of rows in <textarea>. If set to 0 an <input> will be used instead.
+ * In line with Storybook team's plan: https://github.com/storybookjs/storybook/issues/21100
+ */
+ rows: z.number().optional(),
+});
+
const Color = z.object({
...common,
control: z.literal("color"),
@@ -147,6 +159,7 @@ export const PropMeta = z.union([
Number,
Range,
Text,
+ Code,
Color,
Boolean,
Radio,
diff --git a/packages/react-sdk/package.json b/packages/react-sdk/package.json
index a74bf16a09..568435bfd5 100644
--- a/packages/react-sdk/package.json
+++ b/packages/react-sdk/package.json
@@ -42,17 +42,18 @@
},
"dependencies": {
"@nanostores/react": "^0.4.1",
+ "@react-aria/utils": "^3.13.3",
"@webstudio-is/asset-uploader": "workspace:^",
"@webstudio-is/css-data": "workspace:^",
"@webstudio-is/css-engine": "workspace:^",
"@webstudio-is/css-vars": "workspace:^",
"@webstudio-is/fonts": "workspace:^",
+ "@webstudio-is/form-handlers": "workspace:^",
"@webstudio-is/generate-arg-types": "workspace:^",
"@webstudio-is/icons": "workspace:^",
"@webstudio-is/image": "workspace:^",
"@webstudio-is/prisma-client": "workspace:^",
"@webstudio-is/project-build": "workspace:^",
- "@webstudio-is/form-handlers": "workspace:^",
"detect-font": "^0.1.5",
"html-tags": "^3.2.0",
"nanoevents": "^7.0.1",
diff --git a/packages/react-sdk/src/components/__generated__/html.props.ts b/packages/react-sdk/src/components/__generated__/html.props.ts
new file mode 100644
index 0000000000..7ec64daabd
--- /dev/null
+++ b/packages/react-sdk/src/components/__generated__/html.props.ts
@@ -0,0 +1,10 @@
+import type { PropMeta } from "@webstudio-is/generate-arg-types";
+
+export const props: Record<string, PropMeta> = {
+ code: { required: true, control: "text", type: "string" },
+ executeScriptInCanvas: {
+ required: true,
+ control: "boolean",
+ type: "boolean",
+ },
+};
diff --git a/packages/react-sdk/src/components/components.ts b/packages/react-sdk/src/components/components.ts
index 7f2844b646..2f79664957 100644
--- a/packages/react-sdk/src/components/components.ts
+++ b/packages/react-sdk/src/components/components.ts
@@ -7,6 +7,7 @@
*/
export { Slot } from "./slot";
export { Fragment } from "./fragment";
+export { Html } from "./html";
export { Body } from "./body";
export { Box } from "./box";
export { TextBlock } from "./text-block";
diff --git a/packages/react-sdk/src/components/html.stories.tsx b/packages/react-sdk/src/components/html.stories.tsx
new file mode 100644
index 0000000000..df3adef36f
--- /dev/null
+++ b/packages/react-sdk/src/components/html.stories.tsx
@@ -0,0 +1,16 @@
+import type { ComponentStory, ComponentMeta } from "@storybook/react";
+import { Html as HtmlPrimitive } from "./html";
+
+export default {
+ title: "Components/Html",
+ component: HtmlPrimitive,
+} as ComponentMeta<typeof HtmlPrimitive>;
+
+const Template: ComponentStory<typeof HtmlPrimitive> = (args) => (
+ <HtmlPrimitive {...args} />
+);
+
+export const Html = Template.bind({});
+Html.args = {
+ code: "<strong>custom code</strong>",
+};
diff --git a/packages/react-sdk/src/components/html.tsx b/packages/react-sdk/src/components/html.tsx
new file mode 100644
index 0000000000..4f737205c3
--- /dev/null
+++ b/packages/react-sdk/src/components/html.tsx
@@ -0,0 +1,96 @@
+import {
+ forwardRef,
+ useContext,
+ useEffect,
+ useRef,
+ type ForwardedRef,
+} from "react";
+import { mergeRefs } from "@react-aria/utils";
+import { ReactSdkContext } from "../context";
+
+type Props = {
+ code: string;
+ executeScriptInCanvas: boolean;
+};
+
+type ChildProps = {
+ innerRef: ForwardedRef<HTMLDivElement>;
+ // code can be actually undefined when prop is not provided
+ code?: string;
+};
+
+/**
+ * Scripts are executed when rendered client side.
+ * Necessary on canvas which does not have server rendering.
+ */
+const ExecutableHtml = (props: ChildProps) => {
+ const { code, innerRef, ...rest } = props;
+ const containerRef = useRef<HTMLDivElement>(null);
+
+ useEffect(() => {
+ const container = containerRef.current;
+ if (container === null || code === undefined) {
+ return;
+ }
+ // the trick to execute inserted scripts
+ // https://ghinda.net/article/script-tags
+ const range = document.createRange();
+ range.setStart(container, 0);
+ const fragment = range.createContextualFragment(code);
+ while (container.firstChild) {
+ container.removeChild(container.firstChild);
+ }
+ container.append(fragment);
+ }, [code]);
+
+ return (
+ <div
+ {...rest}
+ ref={mergeRefs(innerRef, containerRef)}
+ style={{ display: "contents" }}
+ />
+ );
+};
+
+/**
+ * Scripts are executed when rendered server side
+ */
+const InnerHtml = (props: ChildProps) => {
+ const { code, innerRef, ...rest } = props;
+
+ return (
+ <div
+ {...rest}
+ ref={innerRef}
+ style={{ display: "contents" }}
+ dangerouslySetInnerHTML={{ __html: props.code ?? "" }}
+ />
+ );
+};
+
+const Placeholder = (props: ChildProps) => {
+ const { code, innerRef, ...rest } = props;
+ return (
+ <div ref={innerRef} {...rest} style={{ padding: "20px" }}>
+ {'Paste html into "Code" prop'}
+ </div>
+ );
+};
+
+export const Html = forwardRef<HTMLDivElement, Props>((props, ref) => {
+ const { renderer } = useContext(ReactSdkContext);
+ const { code, executeScriptInCanvas, ...rest } = props;
+
+ // code can be actually undefined when prop is not provided
+ if (code === undefined || code.trim().length === 0) {
+ return <Placeholder innerRef={ref} {...rest} />;
+ }
+
+ if (renderer === "canvas" && executeScriptInCanvas === true) {
+ return <ExecutableHtml innerRef={ref} code={code} {...rest} />;
+ }
+
+ return <InnerHtml innerRef={ref} code={code} {...rest} />;
+});
+
+Html.displayName = "Html";
diff --git a/packages/react-sdk/src/components/html.ws.ts b/packages/react-sdk/src/components/html.ws.ts
new file mode 100644
index 0000000000..75f40d886c
--- /dev/null
+++ b/packages/react-sdk/src/components/html.ws.ts
@@ -0,0 +1,22 @@
+import { CodeIcon } from "@webstudio-is/icons/svg";
+import type { WsComponentMeta, WsComponentPropsMeta } from "./component-meta";
+import { props } from "./__generated__/html.props";
+
+export const meta: WsComponentMeta = {
+ category: "general",
+ type: "embed",
+ label: "Html",
+ icon: CodeIcon,
+};
+
+export const propsMeta: WsComponentPropsMeta = {
+ props: {
+ ...props,
+ code: {
+ required: true,
+ control: "code",
+ type: "string",
+ rows: 10,
+ },
+ },
+};
diff --git a/packages/react-sdk/src/components/index.ts b/packages/react-sdk/src/components/index.ts
index 7def8d028c..f506c62473 100644
--- a/packages/react-sdk/src/components/index.ts
+++ b/packages/react-sdk/src/components/index.ts
@@ -2,6 +2,7 @@ import type { WsComponentMeta, WsComponentPropsMeta } from "./component-meta";
import type { ComponentName } from "./components-utils";
import { meta as SlotMeta } from "./slot.ws";
import { meta as FragmentMeta } from "./fragment.ws";
+import { meta as HtmlMeta } from "./html.ws";
import { meta as BodyMeta } from "./body.ws";
import { meta as BoxMeta } from "./box.ws";
import { meta as TextBlockMeta } from "./text-block.ws";
@@ -36,6 +37,7 @@ import { meta as CheckboxMeta } from "./checkbox.ws";
// these are huge JSON objects that we want to be tree-shaken when not used!
import { propsMeta as SlotMetaPropsMeta } from "./slot.ws";
import { propsMeta as FragmentMetaPropsMeta } from "./fragment.ws";
+import { propsMeta as HtmlMetaPropsMeta } from "./html.ws";
import { propsMeta as BodyMetaPropsMeta } from "./body.ws";
import { propsMeta as BoxMetaPropsMeta } from "./box.ws";
import { propsMeta as TextBlockMetaPropsMeta } from "./text-block.ws";
@@ -71,6 +73,7 @@ import { propsMeta as CheckboxPropsMeta } from "./checkbox.ws";
export const defaultMetas: Record<string, WsComponentMeta> = {
Slot: SlotMeta,
Fragment: FragmentMeta,
+ Html: HtmlMeta,
Box: BoxMeta,
Body: BodyMeta,
TextBlock: TextBlockMeta,
@@ -123,6 +126,7 @@ export const registerComponentMetas = (
export const defaultPropsMetas: Record<string, WsComponentPropsMeta> = {
Slot: SlotMetaPropsMeta,
Fragment: FragmentMetaPropsMeta,
+ Html: HtmlMetaPropsMeta,
Box: BoxMetaPropsMeta,
Body: BodyMetaPropsMeta,
TextBlock: TextBlockMetaPropsMeta,
diff --git a/packages/react-sdk/src/context.tsx b/packages/react-sdk/src/context.tsx
index 29af41684e..72930710e6 100644
--- a/packages/react-sdk/src/context.tsx
+++ b/packages/react-sdk/src/context.tsx
@@ -4,6 +4,7 @@ import type { Assets } from "@webstudio-is/asset-uploader";
import type { Pages, PropsByInstanceId } from "./props";
export const ReactSdkContext = createContext<{
+ renderer?: "canvas";
propsByInstanceIdStore: ReadableAtom<PropsByInstanceId>;
assetsStore: ReadableAtom<Assets>;
pagesStore: ReadableAtom<Pages>;
diff --git a/packages/react-sdk/src/tree/create-elements-tree.tsx b/packages/react-sdk/src/tree/create-elements-tree.tsx
index 82cbfd9789..529d3d0521 100644
--- a/packages/react-sdk/src/tree/create-elements-tree.tsx
+++ b/packages/react-sdk/src/tree/create-elements-tree.tsx
@@ -11,6 +11,7 @@ import type { WebstudioComponent } from "./webstudio-component";
type InstanceSelector = Instance["id"][];
export const createElementsTree = ({
+ renderer,
instances,
rootInstanceId,
propsByInstanceIdStore,
@@ -19,6 +20,7 @@ export const createElementsTree = ({
Component,
getComponent,
}: {
+ renderer?: "canvas";
instances: Instances;
rootInstanceId: Instance["id"];
propsByInstanceIdStore: ReadableAtom<PropsByInstanceId>;
@@ -55,7 +57,7 @@ export const createElementsTree = ({
});
return (
<ReactSdkContext.Provider
- value={{ propsByInstanceIdStore, assetsStore, pagesStore }}
+ value={{ propsByInstanceIdStore, assetsStore, pagesStore, renderer }}
>
{root}
</ReactSdkContext.Provider>
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 9a46b03a9f..889539d58d 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -1161,6 +1161,9 @@ importers:
'@nanostores/react':
specifier: ^0.4.1
+ '@react-aria/utils':
+ specifier: ^3.13.3
+ version: 3.15.0([email protected])
'@webstudio-is/asset-uploader':
specifier: workspace:^
version: link:../asset-uploader