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.
TypeScript accessibilityalternativecloudflarecloudflare-workersdesignfreefrontendopen-sourceradix-uireactremixweb-developmentwebflowwebsite-builderwebsite-developmentwebsiteswebstudio
experimental: add descendent component (#3313)
Bogdan Chadkin305436f82034
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/components/components.tsx b/apps/builder/app/builder/features/sidebar-left/panels/components/components.tsxindex 09dde21755..0b5b1ff25a 100644--- a/apps/builder/app/builder/features/sidebar-left/panels/components/components.tsx+++ b/apps/builder/app/builder/features/sidebar-left/panels/components/components.tsx@@ -80,6 +80,12 @@ export const TabContent = ({ publish, onSetActiveTab }: TabContentProps) => {) {return;}+ if (+ isFeatureEnabled("internalComponents") === false &&+ meta.category === "internal"+ ) {+ return;+ }return (<ListItemasChilddiff --git a/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsxindex 659b2c4d8e..471f9dfd90 100644--- a/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx+++ b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx@@ -27,6 +27,7 @@ import {collectionComponent,type AnyComponent,textContentAttribute,+ descendentComponent,} from "@webstudio-is/react-sdk";import {$propValuesByInstanceSelector,@@ -328,6 +329,10 @@ export const WebstudioComponentCanvas = forwardRef<}}+ if (instance.component === descendentComponent) {+ return <></>;+ }+const Component =components.get(instance.component) ?? (StubComponent as AnyComponent);@@ -448,6 +453,10 @@ export const WebstudioComponentPreview = forwardRef<}}+ if (instance.component === descendentComponent) {+ return <></>;+ }+const Component = components.get(instance.component);if (Component === undefined) {return <></>;diff --git a/apps/builder/app/canvas/shared/styles.ts b/apps/builder/app/canvas/shared/styles.tsindex bafdda4542..6ec3546020 100644--- a/apps/builder/app/canvas/shared/styles.ts+++ b/apps/builder/app/canvas/shared/styles.ts@@ -2,6 +2,7 @@ import { useEffect, useLayoutEffect } from "react";import { computed } from "nanostores";import { useStore } from "@nanostores/react";import {+ Instance,getStyleDeclKey,type StyleDecl,type StyleSourceSelection,@@ -12,6 +13,7 @@ import {addGlobalRules,createImageValueTransformer,getPresetStyleRules,+ descendentComponent,type Params,} from "@webstudio-is/react-sdk";import {@@ -23,7 +25,9 @@ import {import {$assets,$breakpoints,+ $instances,$isPreviewMode,+ $props,$registeredComponentMetas,$selectedInstanceSelector,$selectedStyleState,@@ -159,6 +163,42 @@ const toVarValue = (styleDecl: StyleDecl): undefined | VarValue => {}};+const $descendentSelectors = computed(+ [$instances, $props],+ (instances, props) => {+ const parentIdByInstanceId = new Map<Instance["id"], Instance["id"]>();+ const descendentInstanceIds: Instance["id"][] = [];+ for (const instance of instances.values()) {+ if (instance.component === descendentComponent) {+ descendentInstanceIds.push(instance.id);+ }+ for (const child of instance.children) {+ if (child.type === "id") {+ parentIdByInstanceId.set(child.value, instance.id);+ }+ }+ }+ const descendentSelectorByInstanceId = new Map<Instance["id"], string>();+ for (const prop of props.values()) {+ if (prop.name === "selector" && prop.type === "string") {+ descendentSelectorByInstanceId.set(prop.instanceId, prop.value);+ }+ }+ const descendentSelectors = new Map<Instance["id"], string>();+ for (const instanceId of descendentInstanceIds) {+ const parentId = parentIdByInstanceId.get(instanceId);+ const selector = descendentSelectorByInstanceId.get(instanceId);+ if (parentId && selector) {+ descendentSelectors.set(+ instanceId,+ `[${idAttribute}="${parentId}"]${selector}`+ );+ }+ }+ return descendentSelectors;+ }+);+/*** track new or deleted styles and style source selections items* and update style sheet accordingly@@ -227,10 +267,31 @@ export const subscribeStyles = () => {});+ const unsubscribeDescendentSelectors = $descendentSelectors.subscribe(+ (descendentSelectors) => {+ let selectorsUpdated = false;+ for (const [instanceId, descendentSelector] of descendentSelectors) {+ // access descendent component rule+ // and change its selector to parent id + selector prop+ const key = `[${idAttribute}="${instanceId}"]`;+ const rule = userSheet.addNestingRule(key);+ // invalidate only when necessary+ if (rule.getSelector() !== descendentSelector) {+ selectorsUpdated = true;+ rule.setSelector(descendentSelector);+ }+ }+ if (selectorsUpdated) {+ renderUserSheetInTheNextFrame();+ }+ }+ );+return () => {unsubscribeBreakpoints();unsubscribeStyles();unsubscribeStyleSourceSelections();+ unsubscribeDescendentSelectors();if (animationFrameId) {cancelAnimationFrame(animationFrameId);}diff --git a/packages/cli/src/prebuild.ts b/packages/cli/src/prebuild.tsindex 22f88654cb..7903a244c4 100644--- a/packages/cli/src/prebuild.ts+++ b/packages/cli/src/prebuild.ts@@ -25,7 +25,7 @@ import {normalizeProps,generateRemixRoute,generateRemixParams,- collectionComponent,+ isCoreComponent,} from "@webstudio-is/react-sdk";import type {Instance,@@ -369,7 +369,7 @@ export const prebuild = async (options: {componentsByPage[page.id] = new Set();for (const [_instanceId, instance] of instances) {- if (instance.component === collectionComponent) {+ if (isCoreComponent(instance.component)) {continue;}componentsByPage[page.id].add(instance.component);@@ -477,6 +477,8 @@ export const prebuild = async (options: {spinner.text = "Generating css file";const { cssText, classesMap } = generateCss({+ instances: new Map(siteData.build.instances),+ props: new Map(siteData.build.props),assets,breakpoints: new Map(siteData.build?.breakpoints),styles: new Map(siteData.build?.styles),diff --git a/packages/css-engine/src/core/atomic.test.ts b/packages/css-engine/src/core/atomic.test.tsindex c2fb97263f..be03d71868 100644--- a/packages/css-engine/src/core/atomic.test.ts+++ b/packages/css-engine/src/core/atomic.test.ts@@ -175,3 +175,33 @@ test("distinct similar declarations from different breakpoints", () => {}"`);});++test("support descendent suffix", () => {+ const sheet = createRegularStyleSheet();+ sheet.addMediaRule("x");+ const rule1 = sheet.addNestingRule("instance");+ rule1.setDeclaration({+ breakpoint: "x",+ selector: ":hover",+ property: "display",+ value: { type: "keyword", value: "block" },+ });+ const rule2 = sheet.addNestingRule("instance", " img");+ rule2.setDeclaration({+ breakpoint: "x",+ selector: ":hover",+ property: "display",+ value: { type: "keyword", value: "block" },+ });+ expect(generateAtomic(sheet, { getKey: () => "" }).cssText)+ .toMatchInlineSnapshot(`+"@media all {+ .c143pt9k:hover {+ display: block+ }+ .cpdl2lp img:hover {+ display: block+ }+}"+`);+});diff --git a/packages/css-engine/src/core/atomic.ts b/packages/css-engine/src/core/atomic.tsindex 7cd9e3486c..352cd73c6e 100644--- a/packages/css-engine/src/core/atomic.ts+++ b/packages/css-engine/src/core/atomic.ts@@ -13,12 +13,20 @@ export const generateAtomic = (sheet: StyleSheet, options: Options) => {const atomicRules = new Map<string, NestingRule>();const classesMap = new Map<string, string[]>();for (const rule of sheet.nestingRules.values()) {+ const descendentSuffix = rule.getDescendentSuffix();const groupKey = getKey(rule);- const classList: string[] = [];+ // a few rules can be in the same group+ // when rule have descendent suffix+ let classList = classesMap.get(groupKey);+ if (classList === undefined) {+ classList = [];+ classesMap.set(groupKey, classList);+ }// convert each declaration into separate rulefor (const declaration of rule.getDeclarations()) {const atomicHash = hash(- declaration.breakpoint ++ descendentSuffix ++ declaration.breakpoint +declaration.selector +declaration.property +toValue(declaration.value, transformValue)@@ -28,13 +36,16 @@ export const generateAtomic = (sheet: StyleSheet, options: Options) => {// reuse atomic ruleslet atomicRule = atomicRules.get(atomicHash);if (atomicRule === undefined) {- atomicRule = new NestingRule(`.${className}`, new Map());+ atomicRule = new NestingRule(+ new Map(),+ `.${className}`,+ descendentSuffix+ );atomicRule.setDeclaration(declaration);atomicRules.set(atomicHash, atomicRule);}classList.push(className);}- classesMap.set(groupKey, classList);}const cssText = sheet.generateWith({nestingRules: Array.from(atomicRules.values()),diff --git a/packages/css-engine/src/core/rules.ts b/packages/css-engine/src/core/rules.tsindex e11930df6b..53511be085 100644--- a/packages/css-engine/src/core/rules.ts+++ b/packages/css-engine/src/core/rules.ts@@ -71,6 +71,7 @@ export class MixinRule {*/export class NestingRule {#selector: string;+ #descendentSuffix: string;#mixinRules = new Map<string, MixinRule>();#mixins = new Set<string>();// use map to avoid duplicated properties@@ -80,13 +81,25 @@ export class NestingRule {string,{ generated: string; indent: number; transformValue?: TransformValue }>();- constructor(selector: string, mixinRules: Map<string, MixinRule>) {+ constructor(+ mixinRules: Map<string, MixinRule>,+ selector: string,+ descendentSuffix: string+ ) {this.#selector = selector;+ this.#descendentSuffix = descendentSuffix;this.#mixinRules = mixinRules;}getSelector() {return this.#selector;}+ setSelector(selector: string) {+ this.#selector = selector;+ this.#cache.clear();+ }+ getDescendentSuffix() {+ return this.#descendentSuffix;+ }addMixin(mixin: string) {this.#mixins.add(mixin);this.#cache.clear();@@ -154,7 +167,7 @@ export class NestingRule {continue;}const { selector: nestedSelector, property, value } = declaration;- const selector = `${this.#selector}${nestedSelector}`;+ const selector = this.#selector + this.#descendentSuffix + nestedSelector;const lines = linesBySelector.get(selector) ?? "";const propertyString = toProperty(property);const valueString = toValue(value, transformValue);diff --git a/packages/css-engine/src/core/style-sheet-regular.test.ts b/packages/css-engine/src/core/style-sheet-regular.test.tsindex 9d35a26f13..efd5f5e996 100644--- a/packages/css-engine/src/core/style-sheet-regular.test.ts+++ b/packages/css-engine/src/core/style-sheet-regular.test.ts@@ -932,6 +932,35 @@ describe("Style Sheet Regular", () => {color: blue}}"+`);+ });++ test("support descendent suffix", () => {+ const sheet = createRegularStyleSheet();+ sheet.addMediaRule("base", {});+ const rule1 = sheet.addNestingRule(".instance");+ rule1.setDeclaration({+ breakpoint: "base",+ selector: ":hover",+ property: "width",+ value: { type: "keyword", value: "auto" },+ });+ const rule2 = sheet.addNestingRule(".instance", " img");+ rule2.setDeclaration({+ breakpoint: "base",+ selector: ":hover",+ property: "width",+ value: { type: "keyword", value: "auto" },+ });+ expect(sheet.cssText).toMatchInlineSnapshot(`+"@media all {+ .instance:hover {+ width: auto+ }+ .instance img:hover {+ width: auto+ }+}"`);});});diff --git a/packages/css-engine/src/core/style-sheet.ts b/packages/css-engine/src/core/style-sheet.tsindex 5a95f57762..e3b6dc6b28 100644--- a/packages/css-engine/src/core/style-sheet.ts+++ b/packages/css-engine/src/core/style-sheet.ts@@ -66,11 +66,12 @@ export class StyleSheet {}return rule;}- addNestingRule(selector: string) {- let rule = this.nestingRules.get(selector);+ addNestingRule(selector: string, descendentSuffix: string = "") {+ const key = selector + descendentSuffix;+ let rule = this.nestingRules.get(key);if (rule === undefined) {- rule = new NestingRule(selector, this.#mixinRules);- this.nestingRules.set(selector, rule);+ rule = new NestingRule(this.#mixinRules, selector, descendentSuffix);+ this.nestingRules.set(key, rule);}return rule;}diff --git a/packages/feature-flags/src/flags.ts b/packages/feature-flags/src/flags.tsindex ee6a715dd5..64c5105bad 100644--- a/packages/feature-flags/src/flags.ts+++ b/packages/feature-flags/src/flags.ts@@ -1,5 +1,6 @@// Only for development, is not supposed to be enabled at all.export const displayContents = false;+export const internalComponents = false;export const unsupportedBrowsers = false;export const aiRadixComponents = false;export const cms = false;diff --git a/packages/react-sdk/src/component-generator.test.ts b/packages/react-sdk/src/component-generator.test.tsindex e158363369..22aec21eb6 100644--- a/packages/react-sdk/src/component-generator.test.ts+++ b/packages/react-sdk/src/component-generator.test.ts@@ -7,7 +7,7 @@ import {type Prop,} from "@webstudio-is/sdk";import { showAttribute } from "./props";-import { collectionComponent } from "./core-components";+import { collectionComponent, descendentComponent } from "./core-components";import {generateJsxChildren,generateJsxElement,@@ -943,3 +943,30 @@ data-data={UsedVariableName} />"`);});++test("avoid generating descendent component", () => {+ expect(+ generateWebstudioComponent({+ classesMap: new Map(),+ scope: createScope(),+ name: "Page",+ rootInstanceId: "body",+ parameters: [],+ instances: toMap([+ createInstance("body", "Body", [{ type: "id", value: "selector" }]),+ createInstance("descendent", descendentComponent, []),+ ]),+ dataSources: new Map(),+ props: new Map(),+ indexesWithinAncestors: new Map(),+ })+ ).toMatchInlineSnapshot(`+"const Page = () => {+return <Body+data-ws-id="body"+data-ws-component="Body">+</Body>+}+"+`);+});diff --git a/packages/react-sdk/src/component-generator.ts b/packages/react-sdk/src/component-generator.tsindex e2fa3f2f86..58ade793f7 100644--- a/packages/react-sdk/src/component-generator.ts+++ b/packages/react-sdk/src/component-generator.ts@@ -19,7 +19,7 @@ import {indexAttribute,showAttribute,} from "./props";-import { collectionComponent } from "./core-components";+import { collectionComponent, descendentComponent } from "./core-components";import type { IndexesWithinAncestors } from "./instance-utils";/**@@ -253,6 +253,12 @@ export const generateJsxElement = ({}}+ // descendent component is used only for styling+ // and should not be rendered+ if (instance.component === descendentComponent) {+ return "";+ }+if (conditionValue) {generatedElement += `}\n`;}diff --git a/packages/react-sdk/src/components/component-meta.ts b/packages/react-sdk/src/components/component-meta.tsindex 8dc3d95a3b..3c652280c1 100644--- a/packages/react-sdk/src/components/component-meta.ts+++ b/packages/react-sdk/src/components/component-meta.ts@@ -26,6 +26,7 @@ export const componentCategories = ["radix","xml","hidden",+ "internal",] as const;export const stateCategories = ["states", "component-states"] as const;diff --git a/packages/react-sdk/src/core-components.ts b/packages/react-sdk/src/core-components.tsindex b34b29b998..2e68185e56 100644--- a/packages/react-sdk/src/core-components.ts+++ b/packages/react-sdk/src/core-components.ts@@ -1,4 +1,4 @@-import { ListViewIcon } from "@webstudio-is/icons/svg";+import { EmbedIcon, ListViewIcon } from "@webstudio-is/icons/svg";import type {WsComponentMeta,WsComponentPropsMeta,@@ -58,10 +58,37 @@ const collectionPropsMeta: WsComponentPropsMeta = {initialProps: ["data"],};+export const descendentComponent = "ws:descendent";++const descendentMeta: WsComponentMeta = {+ category: "internal",+ type: "control",+ label: "Descendent",+ icon: EmbedIcon,+};++const descendentPropsMeta: WsComponentPropsMeta = {+ props: {+ selector: {+ required: true,+ control: "text",+ type: "string",+ },+ },+ initialProps: ["selector"],+};+export const coreMetas = {[collectionComponent]: collectionMeta,+ [descendentComponent]: descendentMeta,};export const corePropsMetas = {[collectionComponent]: collectionPropsMeta,+ [descendentComponent]: descendentPropsMeta,};++// components with custom implementation+// should not be imported as react component+export const isCoreComponent = (component: string) =>+ component === collectionComponent || component === descendentComponent;diff --git a/packages/react-sdk/src/css/css.test.ts b/packages/react-sdk/src/css/css.test.tsindex 8bb6237f1f..32ba943667 100644--- a/packages/react-sdk/src/css/css.test.ts+++ b/packages/react-sdk/src/css/css.test.ts@@ -1,6 +1,7 @@import { expect, test } from "@jest/globals";import type { Breakpoint } from "@webstudio-is/sdk";import { generateCss, type CssConfig } from "./css";+import { descendentComponent } from "../core-components";const toMap = <T extends { id: string }>(list: T[]) =>new Map(list.map((item) => [item.id, item] as const));@@ -20,6 +21,8 @@ const generateAllCss = (config: Omit<CssConfig, "atomic">) => {test("generate css for one instance with two tokens", () => {const { cssText, atomicCssText, classesMap } = generateAllCss({assets: new Map(),+ instances: new Map(),+ props: new Map(),breakpoints: toMap<Breakpoint>([{ id: "base", label: "" }]),styleSourceSelections: new Map([["box", { instanceId: "box", values: ["token", "local"] }],@@ -72,3 +75,104 @@ Map {}`);});++test("generate descendant selector", () => {+ const { cssText, atomicCssText, classesMap } = generateAllCss({+ assets: new Map(),+ instances: toMap([+ {+ id: "root",+ type: "instance",+ component: "Body",+ children: [{ type: "id", value: "descendant" }],+ },+ {+ id: "descendant",+ type: "instance",+ component: descendentComponent,+ children: [],+ },+ ]),+ props: toMap([+ {+ id: "1",+ instanceId: "descendant",+ name: "selector",+ type: "string",+ value: " a",+ },+ ]),+ breakpoints: toMap<Breakpoint>([{ id: "base", label: "" }]),+ styleSourceSelections: new Map([+ ["root", { instanceId: "root", values: ["local"] }],+ ["descendant", { instanceId: "descendant", values: ["local"] }],+ ]),+ styles: new Map([+ [+ "local:base:color",+ {+ styleSourceId: "local",+ breakpointId: "base",+ property: "color",+ value: { type: "keyword", value: "blue" },+ },+ ],+ [+ "local:base:color::hover",+ {+ styleSourceId: "local",+ breakpointId: "base",+ state: ":hover",+ property: "color",+ value: { type: "keyword", value: "red" },+ },+ ],+ ]),+ componentMetas: new Map(),+ assetBaseUrl: "",+ });+ expect(cssText).toMatchInlineSnapshot(`+"html {margin: 0; display: grid; min-height: 100%}+@media all {+ [data-ws-id="root"] {+ color: blue+ }+ [data-ws-id="root"]:hover {+ color: red+ }+ [data-ws-id="root"] a {+ color: blue+ }+ [data-ws-id="root"] a:hover {+ color: red+ }+}"+`);+ expect(atomicCssText).toMatchInlineSnapshot(`+"html {margin: 0; display: grid; min-height: 100%}+@media all {+ .c17hlgoh {+ color: blue+ }+ .c92zrdl:hover {+ color: red+ }+ .chhpmat a {+ color: blue+ }+ .c32fhpn a:hover {+ color: red+ }+}"+`);+ expect(classesMap).toMatchInlineSnapshot(`+Map {+ "root" => [+ "c17hlgoh",+ "c92zrdl",+ "chhpmat",+ "c32fhpn",+ ],+}+`);+});diff --git a/packages/react-sdk/src/css/css.ts b/packages/react-sdk/src/css/css.tsindex 3085f8ad8a..34c5dee6ea 100644--- a/packages/react-sdk/src/css/css.ts+++ b/packages/react-sdk/src/css/css.ts@@ -8,16 +8,21 @@ import type {Assets,Breakpoints,Instance,+ Instances,+ Props,StyleSourceSelections,Styles,} from "@webstudio-is/sdk";import type { WsComponentMeta } from "../components/component-meta";import { idAttribute } from "../props";+import { descendentComponent } from "../core-components";import { addGlobalRules } from "./global-rules";import { getPresetStyleRules } from "./style-rules";export type CssConfig = {assets: Assets;+ instances: Instances;+ props: Props;breakpoints: Breakpoints;styles: Styles;styleSourceSelections: StyleSourceSelections;@@ -54,6 +59,8 @@ export const createImageValueTransformer =export const generateCss = ({assets,+ instances,+ props,breakpoints,styles,styleSourceSelections,@@ -62,6 +69,21 @@ export const generateCss = ({atomic,}: CssConfig) => {const sheet = createRegularStyleSheet({ name: "ssr" });+ const parentIdByInstanceId = new Map<Instance["id"], Instance["id"]>();+ for (const instance of instances.values()) {+ for (const child of instance.children) {+ if (child.type === "id") {+ parentIdByInstanceId.set(child.value, instance.id);+ }+ }+ }++ const descendentSelectorByInstanceId = new Map<Instance["id"], string>();+ for (const prop of props.values()) {+ if (prop.name === "selector" && prop.type === "string") {+ descendentSelectorByInstanceId.set(prop.instanceId, prop.value);+ }+ }addGlobalRules(sheet, { assets, assetBaseUrl });@@ -96,8 +118,24 @@ export const generateCss = ({}const instanceByRule = new Map<NestingRule, Instance["id"]>();- for (const { instanceId, values } of styleSourceSelections.values()) {- const rule = sheet.addNestingRule(`[${idAttribute}="${instanceId}"]`);+ for (const selection of styleSourceSelections.values()) {+ let { instanceId } = selection;+ const { values } = selection;+ let descendentSuffix = "";+ // render selector component as descendent selector+ const instance = instances.get(instanceId);+ if (instance?.component === descendentComponent) {+ const parentId = parentIdByInstanceId.get(instanceId);+ const descendentSelector = descendentSelectorByInstanceId.get(instanceId);+ if (parentId && descendentSelector) {+ descendentSuffix = descendentSelector;+ instanceId = parentId;+ }+ }+ const rule = sheet.addNestingRule(+ `[${idAttribute}="${instanceId}"]`,+ descendentSuffix+ );rule.applyMixins(values);instanceByRule.set(rule, instanceId);}diff --git a/packages/sdk-cli/src/generate-stories.ts b/packages/sdk-cli/src/generate-stories.tsindex 3368d90c0a..5724d38e77 100644--- a/packages/sdk-cli/src/generate-stories.ts+++ b/packages/sdk-cli/src/generate-stories.ts@@ -130,6 +130,7 @@ export const generateStories = async () => {[instance.id, instance] satisfies [Instance["id"], Instance]),]);+ const props = new Map(data.props.map((prop) => [prop.id, prop]));const components = new Set<Instance["component"]>();const usedMetas = new Map<Instance["component"], WsComponentMeta>();const bodyMeta = baseMetas.get("Body");@@ -146,6 +147,8 @@ export const generateStories = async () => {}}const { cssText, classesMap } = generateCss({+ instances,+ props,assets: new Map(),breakpoints: new Map([[baseBreakpointId, { id: baseBreakpointId, label: "base" }],@@ -178,7 +181,7 @@ export const generateStories = async () => {rootInstanceId,parameters: [],instances,- props: new Map(data.props.map((prop) => [prop.id, prop])),+ props,dataSources: new Map(data.dataSources.map((prop) => [prop.id, prop])),indexesWithinAncestors: getIndexesWithinAncestors(usedMetas, instances, [rootInstanceId,