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.

feat: support generating collection (#2605)

Bogdan Chadkin12ff45a34b22
diff --git a/apps/builder/app/builder/features/settings-panel/controls/combined.tsx b/apps/builder/app/builder/features/settings-panel/controls/combined.tsx
index 89e517a015..020470555b 100644
--- a/apps/builder/app/builder/features/settings-panel/controls/combined.tsx
+++ b/apps/builder/app/builder/features/settings-panel/controls/combined.tsx
@@ -20,6 +20,11 @@ export const renderControl = ({
throw Error("Expression is not resolved");
}
+ // never render parameter props
+ if (prop?.type === "parameter") {
+ return;
+ }
+
// @todo remove once ui for action is implemented
if (prop?.type === "action") {
return;
diff --git a/apps/builder/app/builder/features/settings-panel/props-section/use-props-logic.ts b/apps/builder/app/builder/features/settings-panel/props-section/use-props-logic.ts
index ef41db1dbd..096d84045c 100644
--- a/apps/builder/app/builder/features/settings-panel/props-section/use-props-logic.ts
+++ b/apps/builder/app/builder/features/settings-panel/props-section/use-props-logic.ts
@@ -96,6 +96,10 @@ const getDefaultMetaForType = (type: Prop["type"]): PropMeta => {
throw new Error(
"A prop with type expression must have a meta, we can't provide a default one because we need a list of options"
);
+ case "parameter":
+ throw new Error(
+ "A prop with type parameter must have a meta, we can't provide a default one because we need a list of options"
+ );
default:
throw new Error(`Usupported data type: ${type satisfies never}`);
}
diff --git a/packages/react-sdk/src/component-generator.test.ts b/packages/react-sdk/src/component-generator.test.ts
index 7902a74483..038c4c87b9 100644
--- a/packages/react-sdk/src/component-generator.test.ts
+++ b/packages/react-sdk/src/component-generator.test.ts
@@ -12,6 +12,7 @@ import {
generateJsxElement,
generatePageComponent,
} from "./component-generator";
+import { collectionComponent } from "./core-components";
const clear = (input: string) =>
stripIndent(input).trimStart().replace(/ +$/, "");
@@ -484,6 +485,77 @@ test("deduplicate base and namespaced components with same short name", () => {
);
});
+test("generate collection component as map", () => {
+ expect(
+ generateJsxChildren({
+ scope: createScope(),
+ children: [{ type: "id", value: "list" }],
+ instances: new Map([
+ createInstancePair("list", collectionComponent, [
+ { type: "id", value: "label" },
+ { type: "id", value: "button" },
+ ]),
+ createInstancePair("label", "Label", []),
+ createInstancePair("button", "Button", []),
+ ]),
+ dataSources: new Map([
+ createDataSourcePair({
+ id: "dataSourceList",
+ scopeInstanceId: "list",
+ type: "variable",
+ name: "data",
+ value: { type: "json", value: ["apple", "orange", "mango"] },
+ }),
+ createDataSourcePair({
+ id: "dataSourceItem",
+ scopeInstanceId: "list",
+ type: "variable",
+ name: "element",
+ value: { type: "json", value: `` },
+ }),
+ ]),
+ props: new Map([
+ createPropPair({
+ id: "propData",
+ instanceId: "list",
+ name: "data",
+ type: "expression",
+ value: "$ws$dataSource$dataSourceList",
+ }),
+ createPropPair({
+ id: "propItem",
+ instanceId: "list",
+ name: "item",
+ type: "parameter",
+ value: "dataSourceItem",
+ }),
+ createPropPair({
+ id: "buttonAriaLabel",
+ instanceId: "button",
+ name: "aria-label",
+ type: "expression",
+ value: "$ws$dataSource$dataSourceItem",
+ }),
+ ]),
+ indexesWithinAncestors: new Map(),
+ })
+ ).toEqual(
+ clear(`
+ {data.map((element, index) =>
+ <Fragment key={index}>
+ <Label
+ data-ws-id="label"
+ data-ws-component="Label" />
+ <Button
+ data-ws-id="button"
+ data-ws-component="Button"
+ aria-label={element} />
+ </Fragment>
+ )}
+ `)
+ );
+});
+
test("generate page component with variables and actions", () => {
expect(
generatePageComponent({
@@ -548,3 +620,64 @@ test("generate page component with variables and actions", () => {
`)
);
});
+
+test("avoid generating collection parameter variable as state", () => {
+ expect(
+ generatePageComponent({
+ scope: createScope(),
+ rootInstanceId: "body",
+ instances: new Map([
+ createInstancePair("body", "Body", [{ type: "id", value: "list" }]),
+ createInstancePair("list", collectionComponent, []),
+ ]),
+ dataSources: new Map([
+ createDataSourcePair({
+ id: "dataSourceList",
+ scopeInstanceId: "list",
+ type: "variable",
+ name: "data",
+ value: { type: "json", value: ["apple", "orange", "mango"] },
+ }),
+ createDataSourcePair({
+ id: "dataSourceItem",
+ scopeInstanceId: "list",
+ type: "variable",
+ name: "element",
+ value: { type: "json", value: `` },
+ }),
+ ]),
+ props: new Map([
+ createPropPair({
+ id: "propData",
+ instanceId: "list",
+ name: "data",
+ type: "expression",
+ value: "$ws$dataSource$dataSourceList",
+ }),
+ createPropPair({
+ id: "propItem",
+ instanceId: "list",
+ name: "item",
+ type: "parameter",
+ value: "dataSourceItem",
+ }),
+ ]),
+ indexesWithinAncestors: new Map(),
+ })
+ ).toEqual(
+ clear(`
+ const Page = (props: { scripts?: ReactNode }) => {
+ let [data, set$data] = useState<any>(["apple","orange","mango"])
+ return <Body
+ data-ws-id="body"
+ data-ws-component="Body">
+ {data.map((element, index) =>
+ <Fragment key={index}>
+ </Fragment>
+ )}
+ {props.scripts}
+ </Body>
+ }
+ `)
+ );
+});
diff --git a/packages/react-sdk/src/component-generator.ts b/packages/react-sdk/src/component-generator.ts
index 634cf34106..58ec2882b7 100644
--- a/packages/react-sdk/src/component-generator.ts
+++ b/packages/react-sdk/src/component-generator.ts
@@ -19,6 +19,7 @@ import {
validateExpression,
} from "./expression";
import type { IndexesWithinAncestors } from "./instance-utils";
+import { collectionComponent } from "./core-components";
const generatePropValue = ({
scope,
@@ -42,6 +43,14 @@ const generatePropValue = ({
) {
return JSON.stringify(prop.value);
}
+ // generate variable name for parameter
+ if (prop.type === "parameter") {
+ const dataSource = dataSources.get(prop.value);
+ if (dataSource === undefined) {
+ return;
+ }
+ return scope.getName(dataSource.id, dataSource.name);
+ }
// inline expression to safely use collection item
if (prop.type === "expression") {
return validateExpression(prop.value, {
@@ -78,8 +87,6 @@ export const generateJsxElement = ({
indexesWithinAncestors: IndexesWithinAncestors;
children: string;
}) => {
- let conditionValue: undefined | string;
-
let generatedProps = "";
// id and component props are always defined for styles
@@ -92,6 +99,9 @@ export const generateJsxElement = ({
generatedProps += `\n${indexAttribute}="${index}"`;
}
+ let conditionValue: undefined | string;
+ let collectionDataValue: undefined | string;
+ let collectionItemValue: undefined | string;
for (const prop of props.values()) {
if (prop.instanceId !== instance.id) {
continue;
@@ -111,6 +121,15 @@ export const generateJsxElement = ({
// generate separately
continue;
}
+ if (instance.component === collectionComponent) {
+ if (prop.name === "data") {
+ collectionDataValue = propValue;
+ }
+ if (prop.name === "item") {
+ collectionItemValue = propValue;
+ }
+ continue;
+ }
if (propValue !== undefined) {
generatedProps += `\n${prop.name}={${propValue}}`;
}
@@ -123,14 +142,30 @@ export const generateJsxElement = ({
generatedElement += `{(${conditionValue}) &&\n`;
}
- const [_namespace, shortName] = parseComponentName(instance.component);
- const componentVariable = scope.getName(instance.component, shortName);
- if (instance.children.length === 0) {
- generatedElement += `<${componentVariable}${generatedProps} />\n`;
- } else {
- generatedElement += `<${componentVariable}${generatedProps}>\n`;
+ if (instance.component === collectionComponent) {
+ // prevent generating invalid collection
+ if (
+ collectionDataValue === undefined ||
+ collectionItemValue === undefined
+ ) {
+ return "";
+ }
+ const indexVariable = scope.getName(`${instance.id}-index`, "index");
+ generatedElement += `{${collectionDataValue}.map((${collectionItemValue}, ${indexVariable}) =>\n`;
+ generatedElement += `<Fragment key={${indexVariable}}>\n`;
generatedElement += children;
- generatedElement += `</${componentVariable}>\n`;
+ generatedElement += `</Fragment>\n`;
+ generatedElement += `)}\n`;
+ } else {
+ const [_namespace, shortName] = parseComponentName(instance.component);
+ const componentVariable = scope.getName(instance.component, shortName);
+ if (instance.children.length === 0) {
+ generatedElement += `<${componentVariable}${generatedProps} />\n`;
+ } else {
+ generatedElement += `<${componentVariable}${generatedProps}>\n`;
+ generatedElement += children;
+ generatedElement += `</${componentVariable}>\n`;
+ }
}
if (conditionValue) {
diff --git a/packages/react-sdk/src/core-components.ts b/packages/react-sdk/src/core-components.ts
new file mode 100644
index 0000000000..b33e44bec8
--- /dev/null
+++ b/packages/react-sdk/src/core-components.ts
@@ -0,0 +1 @@
+export const collectionComponent = "ws:component";
diff --git a/packages/react-sdk/src/expression.ts b/packages/react-sdk/src/expression.ts
index cd89c69114..06397355e8 100644
--- a/packages/react-sdk/src/expression.ts
+++ b/packages/react-sdk/src/expression.ts
@@ -249,6 +249,11 @@ export const generateDataSources = ({
}
for (const prop of props.values()) {
+ // prevent generating parameter variables as component state
+ if (prop.type === "parameter") {
+ output.delete(prop.value);
+ variables.delete(prop.value);
+ }
// generate actions assigning variables and invoking their setters
if (prop.type === "action") {
const name = scope.getName(prop.id, prop.name);
diff --git a/packages/react-sdk/src/index.ts b/packages/react-sdk/src/index.ts
index a08a2cc757..107eeaf7a1 100644
--- a/packages/react-sdk/src/index.ts
+++ b/packages/react-sdk/src/index.ts
@@ -1,6 +1,7 @@
export * from "./css/index";
export * from "./tree/index";
export * from "./app/index";
+export * from "./core-components";
export * from "./components/components-utils";
export { PropMeta } from "./prop-meta";
export {
diff --git a/packages/sdk/src/schema/props.ts b/packages/sdk/src/schema/props.ts
index 76bc414b6c..9269bfeca6 100644
--- a/packages/sdk/src/schema/props.ts
+++ b/packages/sdk/src/schema/props.ts
@@ -51,9 +51,16 @@ export const Prop = z.union([
type: z.literal("string[]"),
value: z.array(z.string()),
}),
+ z.object({
+ ...baseProp,
+ type: z.literal("parameter"),
+ // data source id
+ value: z.string(),
+ }),
z.object({
...baseProp,
type: z.literal("expression"),
+ // expression code
value: z.string(),
}),
z.object({