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.

Render component templates in stories (#2009)

Bogdan Chadkinac735df3cea5
diff --git a/.github/workflows/chromatic.yml b/.github/workflows/chromatic.yml
index 267b8b5dbd..4e7010816f 100644
--- a/.github/workflows/chromatic.yml
+++ b/.github/workflows/chromatic.yml
@@ -23,7 +23,15 @@ jobs:
strategy:
matrix:
project:
- [builder-app, css-engine, design-system, icons, image, sdk-components-react]
+ [
+ builder-app,
+ css-engine,
+ design-system,
+ icons,
+ image,
+ sdk-components-react,
+ sdk-components-react-radix,
+ ]
include:
- project: builder-app
chromaticSecretKey: CHROMATIC_DESIGNER_APP_TOKEN
@@ -49,6 +57,10 @@ jobs:
chromaticSecretKey: CHROMATIC_REACT_SDK_TOKEN
workingDir: packages/sdk-components-react
+ - project: sdk-components-react-radix
+ chromaticSecretKey: CHROMATIC_REACT_SDK_TOKEN
+ workingDir: packages/sdk-components-react-radix
+
outputs:
builder-app: ${{ steps.deployed-url.outputs.builder-app }}
css-engine: ${{ steps.deployed-url.outputs.css-engine }}
@@ -56,6 +68,7 @@ jobs:
icons: ${{ steps.deployed-url.outputs.icons }}
image: ${{ steps.deployed-url.outputs.image }}
sdk-components-react: ${{ steps.deployed-url.outputs.sdk-components-react }}
+ sdk-components-react-radix: ${{ steps.deployed-url.outputs.sdk-components-react-radix }}
steps:
- uses: actions/checkout@v3
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsx
index 66fabc9ed2..866896de23 100644
--- a/apps/builder/app/canvas/canvas.tsx
+++ b/apps/builder/app/canvas/canvas.tsx
@@ -1,6 +1,7 @@
import { useMemo, useEffect } from "react";
import { useStore } from "@nanostores/react";
import { computed } from "nanostores";
+import { Scripts, ScrollRestoration } from "@remix-run/react";
import type { DataSource, Instances, Page } from "@webstudio-is/project-build";
import {
type Params,
@@ -49,7 +50,6 @@ 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();
@@ -123,6 +123,12 @@ const useElementsTree = (
onDataSourceUpdate,
Component: WebstudioComponentDev,
components,
+ scripts: (
+ <>
+ <ScrollRestoration />
+ <Scripts />
+ </>
+ ),
});
}, [
params,
diff --git a/packages/react-sdk/src/component-renderer.tsx b/packages/react-sdk/src/component-renderer.tsx
new file mode 100644
index 0000000000..8e0d15c1c7
--- /dev/null
+++ b/packages/react-sdk/src/component-renderer.tsx
@@ -0,0 +1,110 @@
+import type { ExoticComponent } from "react";
+import type { Instance } from "@webstudio-is/project-build";
+import { getStyleDeclKey } from "@webstudio-is/project-build";
+import type { WsComponentMeta } from "./components/component-meta";
+import { generateDataFromEmbedTemplate } from "./embed-template";
+import { generateCssText } from "./css";
+import { InstanceRoot, WebstudioComponent } from "./tree";
+import {
+ decodeVariablesMap,
+ encodeDataSourceVariable,
+ encodeVariablesMap,
+ executeComputingExpressions,
+ executeEffectfulExpression,
+} from "./expression";
+
+export const renderComponentTemplate = ({
+ name,
+ metas,
+ components,
+}: {
+ name: Instance["component"];
+ metas: Record<string, WsComponentMeta>;
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ components: Record<string, ExoticComponent<any>>;
+}) => {
+ const data = generateDataFromEmbedTemplate(
+ metas[name].template ?? [
+ {
+ type: "instance",
+ component: name,
+ children: [],
+ },
+ ],
+ "base"
+ );
+ return (
+ <>
+ <style>
+ {generateCssText(
+ {
+ assets: [],
+ breakpoints: [["base", { id: "base", label: "base" }]],
+ styles: data.styles.map((item) => [getStyleDeclKey(item), item]),
+ styleSourceSelections: data.styleSourceSelections.map((item) => [
+ item.instanceId,
+ item,
+ ]),
+ componentMetas: new Map(Object.entries(metas)),
+ },
+ { assetBaseUrl: "/" }
+ )}
+ </style>
+ <InstanceRoot
+ data={{
+ page: {
+ path: "",
+ id: "",
+ name: "",
+ title: "",
+ meta: {},
+ rootInstanceId: "root",
+ },
+ pages: [],
+ assets: [],
+ build: {
+ instances: [
+ [
+ "root",
+ {
+ type: "instance",
+ id: "root",
+ component: "Box",
+ children: data.children,
+ },
+ ],
+ ...data.instances.map(
+ (instance) =>
+ [instance.id, instance] satisfies [Instance["id"], Instance]
+ ),
+ ],
+ props: data.props.map((prop) => [prop.id, prop]),
+ dataSources: data.dataSources.map((dataSource) => [
+ dataSource.id,
+ dataSource,
+ ]),
+ },
+ }}
+ executeComputingExpressions={(values) => {
+ const expressions = new Map<string, string>();
+ for (const dataSource of data.dataSources) {
+ const name = encodeDataSourceVariable(dataSource.id);
+ if (dataSource.type === "expression") {
+ expressions.set(name, dataSource.code);
+ }
+ }
+ return decodeVariablesMap(
+ executeComputingExpressions(expressions, encodeVariablesMap(values))
+ );
+ }}
+ executeEffectfulExpression={(code, args, values) => {
+ return decodeVariablesMap(
+ executeEffectfulExpression(code, args, encodeVariablesMap(values))
+ );
+ }}
+ Component={WebstudioComponent}
+ components={new Map(Object.entries(components))}
+ />
+ </>
+ );
+};
diff --git a/packages/react-sdk/src/index.ts b/packages/react-sdk/src/index.ts
index 5c9f5eb979..be4425ea96 100644
--- a/packages/react-sdk/src/index.ts
+++ b/packages/react-sdk/src/index.ts
@@ -32,3 +32,4 @@ export {
decodeDataSourceVariable,
decodeVariablesMap,
} from "./expression";
+export { renderComponentTemplate } from "./component-renderer";
diff --git a/packages/react-sdk/src/tree/create-elements-tree.tsx b/packages/react-sdk/src/tree/create-elements-tree.tsx
index 45746cfdbe..07f6a23283 100644
--- a/packages/react-sdk/src/tree/create-elements-tree.tsx
+++ b/packages/react-sdk/src/tree/create-elements-tree.tsx
@@ -2,9 +2,9 @@ import {
Fragment,
type ForwardRefExoticComponent,
type RefAttributes,
+ type ReactNode,
} from "react";
import type { ReadableAtom } from "nanostores";
-import { Scripts, ScrollRestoration } from "@remix-run/react";
import type { Assets } from "@webstudio-is/asset-uploader";
import type { Instance, Instances } from "@webstudio-is/project-build";
import type { Components } from "../components/components-utils";
@@ -32,6 +32,7 @@ export const createElementsTree = ({
onDataSourceUpdate,
Component,
components,
+ scripts,
}: Params & {
instances: Instances;
rootInstanceId: Instance["id"];
@@ -50,6 +51,7 @@ export const createElementsTree = ({
WebstudioComponentProps & RefAttributes<HTMLElement>
>;
components: Components;
+ scripts?: ReactNode;
}) => {
const rootInstance = instances.get(rootInstanceId);
if (rootInstance === undefined) {
@@ -71,8 +73,7 @@ export const createElementsTree = ({
children: [
<Fragment key="children">
{children}
- <ScrollRestoration />
- <Scripts />
+ {scripts}
</Fragment>,
],
components,
diff --git a/packages/react-sdk/src/tree/root.ts b/packages/react-sdk/src/tree/root.ts
index fba8b2f1e8..675b51c872 100644
--- a/packages/react-sdk/src/tree/root.ts
+++ b/packages/react-sdk/src/tree/root.ts
@@ -3,6 +3,7 @@ import {
useCallback,
type ForwardRefExoticComponent,
type RefAttributes,
+ type ReactNode,
} from "react";
import {
atom,
@@ -45,6 +46,7 @@ type RootProps = {
WebstudioComponentProps & RefAttributes<HTMLElement>
>;
components: Components;
+ scripts?: ReactNode;
};
export const InstanceRoot = ({
@@ -53,6 +55,7 @@ export const InstanceRoot = ({
executeEffectfulExpression,
Component,
components,
+ scripts,
}: RootProps): JSX.Element | null => {
const dataSourceVariablesStoreRef = useRef<
undefined | WritableAtom<DataSourceValues>
@@ -122,5 +125,6 @@ export const InstanceRoot = ({
onDataSourceUpdate,
Component: Component ?? WebstudioComponent,
components,
+ scripts,
});
};
diff --git a/packages/sdk-components-react-radix/.storybook/main.ts b/packages/sdk-components-react-radix/.storybook/main.ts
new file mode 100644
index 0000000000..222c9ab6f2
--- /dev/null
+++ b/packages/sdk-components-react-radix/.storybook/main.ts
@@ -0,0 +1 @@
+export { default } from "@webstudio-is/storybook-config";
diff --git a/packages/sdk-components-react-radix/package.json b/packages/sdk-components-react-radix/package.json
index db64a5c5ed..0f2cb2439f 100644
--- a/packages/sdk-components-react-radix/package.json
+++ b/packages/sdk-components-react-radix/package.json
@@ -38,7 +38,9 @@
"build:args": "generate-arg-types './src/*.tsx !./src/*.stories.tsx !./src/*.ws.tsx' && prettier --write \"**/*.props.ts\"",
"dts": "tsc --project tsconfig.dts.json",
"typecheck": "tsc",
- "checks": "pnpm typecheck"
+ "checks": "pnpm typecheck",
+ "storybook:dev": "storybook dev -p 6006",
+ "storybook:build": "storybook build"
},
"peerDependencies": {
"react": "^18.2.0",
@@ -51,9 +53,12 @@
"@webstudio-is/react-sdk": "workspace:^"
},
"devDependencies": {
+ "@storybook/react": "^7.1.0",
"@types/react": "^18.2.16",
"@types/react-dom": "^18.2.7",
"@webstudio-is/scripts": "workspace:^",
+ "@webstudio-is/sdk-components-react": "workspace:^",
+ "@webstudio-is/storybook-config": "workspace:^",
"@webstudio-is/tsconfig": "workspace:^",
"react": "^18.2.0",
"react-dom": "^18.2.0",
diff --git a/packages/sdk-components-react-radix/src/collapsible.stories.tsx b/packages/sdk-components-react-radix/src/collapsible.stories.tsx
new file mode 100644
index 0000000000..38a6e8258b
--- /dev/null
+++ b/packages/sdk-components-react-radix/src/collapsible.stories.tsx
@@ -0,0 +1,21 @@
+import type { Meta, StoryObj } from "@storybook/react";
+import { renderComponentTemplate } from "@webstudio-is/react-sdk";
+import { Collapsible as CollapsiblePrimitive } from "./collapsible";
+import * as baseComponents from "@webstudio-is/sdk-components-react";
+import * as baseMetas from "@webstudio-is/sdk-components-react/metas";
+import * as radixComponents from "./components";
+import * as radixMetas from "./metas";
+
+export default {
+ title: "Components/Collapsible",
+ component: CollapsiblePrimitive,
+} satisfies Meta<typeof CollapsiblePrimitive>;
+
+export const Collapsible: StoryObj<typeof CollapsiblePrimitive> = {
+ render: () =>
+ renderComponentTemplate({
+ name: "Collapsible",
+ components: { ...baseComponents, ...radixComponents },
+ metas: { ...baseMetas, ...radixMetas },
+ }),
+};
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index c7a66031ae..941db61c03 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -1344,6 +1344,9 @@ importers:
specifier: workspace:^
version: link:../react-sdk
devDependencies:
+ '@storybook/react':
+ specifier: ^7.1.0
'@types/react':
specifier: ^18.2.16
version: 18.2.16
@@ -1353,6 +1356,12 @@ importers:
'@webstudio-is/scripts':
specifier: workspace:^
version: link:../scripts
+ '@webstudio-is/sdk-components-react':
+ specifier: workspace:^
+ version: link:../sdk-components-react
+ '@webstudio-is/storybook-config':
+ specifier: workspace:^
+ version: link:../storybook-config
'@webstudio-is/tsconfig':
specifier: workspace:^
version: link:../tsconfig