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
Migrate style computing to instance selectors (#1291)
Bogdan Chadkin9b6511f4e27a
diff --git a/apps/builder/app/builder/features/style-panel/shared/property-name.tsx b/apps/builder/app/builder/features/style-panel/shared/property-name.tsxindex e1293d48c7..cac541e18e 100644--- a/apps/builder/app/builder/features/style-panel/shared/property-name.tsx+++ b/apps/builder/app/builder/features/style-panel/shared/property-name.tsx@@ -18,7 +18,7 @@ import {Separator,} from "@webstudio-is/design-system";import { UndoIcon } from "@webstudio-is/icons";-import { instancesIndexStore, useBreakpoints } from "~/shared/nano-states";+import { instancesStore, useBreakpoints } from "~/shared/nano-states";import { type StyleInfo, type StyleSource, getStyleSource } from "./style-info";const PropertyPopoverContent = ({@@ -33,7 +33,7 @@ const PropertyPopoverContent = ({onReset: () => void;}) => {const [breakpoints] = useBreakpoints();- const { instancesById } = useStore(instancesIndexStore);+ const instances = useStore(instancesStore);if (styleSource === "local") {return (@@ -71,7 +71,7 @@ const PropertyPopoverContent = ({if (styleValueInfo?.inherited) {const { value, instanceId } = styleValueInfo.inherited;- const instance = instancesById.get(instanceId);+ const instance = instances.get(instanceId);return (<DeprecatedText2 key={property} color="hint">Resetting will change {property} to inherited {toValue(value)}{" "}@@ -108,7 +108,7 @@ const PropertyPopoverContent = ({if (styleValueInfo?.inherited) {const { instanceId } = styleValueInfo.inherited;- const instance = instancesById.get(instanceId);+ const instance = instances.get(instanceId);return (<DeprecatedText2 key={property} color="hint">{property} value is inherited from {instance?.component}diff --git a/apps/builder/app/builder/features/style-panel/shared/style-info.test.ts b/apps/builder/app/builder/features/style-panel/shared/style-info.test.tsindex 7639978242..9b27fa28bd 100644--- a/apps/builder/app/builder/features/style-panel/shared/style-info.test.ts+++ b/apps/builder/app/builder/features/style-panel/shared/style-info.test.ts@@ -2,9 +2,9 @@ import { test, expect } from "@jest/globals";import type {Breakpoints,Instance,+ Instances,StyleDecl,} from "@webstudio-is/project-build";-import { createInstancesIndex } from "~/shared/tree-utils";import {getCascadedBreakpointIds,getCascadedInfo,@@ -19,14 +19,14 @@ const breakpoints: Breakpoints = new Map([]);const selectedBreakpointId = "3";-const selectedInstanceId = "3";+const selectedInstanceSelector = ["3", "2", "1"];const cascadedBreakpointIds = getCascadedBreakpointIds(breakpoints,selectedBreakpointId);const cascadingStylesByInstanceId = new Map<Instance["id"], StyleDecl[]>();-cascadingStylesByInstanceId.set(selectedInstanceId, [+cascadingStylesByInstanceId.set(selectedInstanceSelector[0], [{breakpointId: "1",styleSourceId: "styleSourceId",@@ -60,26 +60,35 @@ cascadingStylesByInstanceId.set(selectedInstanceId, [},]);-const rootInstance: Instance = {- type: "instance",- id: "1",- component: "Box",- children: [+const instances: Instances = new Map([+ [+ "1",+ {+ type: "instance",+ id: "1",+ component: "Box",+ children: [{ type: "id", value: "2" }],+ },+ ],+ [+ "2",{type: "instance",id: "2",component: "Box",- children: [- {- type: "instance",- id: "3",- component: "Box",- children: [],- },- ],+ children: [{ type: "id", value: "3" }],},],-};+ [+ "3",+ {+ type: "instance",+ id: "3",+ component: "Box",+ children: [],+ },+ ],+]);const inheritingStylesByInstanceId = new Map<Instance["id"], StyleDecl[]>();inheritingStylesByInstanceId.set("1", [@@ -121,7 +130,7 @@ test("compute cascaded styles", () => {expect(getCascadedInfo(cascadingStylesByInstanceId,- selectedInstanceId,+ selectedInstanceSelector[0],cascadedBreakpointIds)).toMatchInlineSnapshot(`@@ -147,12 +156,11 @@ test("compute cascaded styles", () => {});test("compute inherited styles", () => {- const instancesIndex = createInstancesIndex(rootInstance);expect(getInheritedInfo(- instancesIndex,+ instances,inheritingStylesByInstanceId,- selectedInstanceId,+ selectedInstanceSelector,cascadedBreakpointIds,selectedBreakpointId)diff --git a/apps/builder/app/builder/features/style-panel/shared/style-info.ts b/apps/builder/app/builder/features/style-panel/shared/style-info.tsindex 2957b048b4..45cd52721f 100644--- a/apps/builder/app/builder/features/style-panel/shared/style-info.ts+++ b/apps/builder/app/builder/features/style-panel/shared/style-info.ts@@ -6,11 +6,12 @@ import { utils } from "@webstudio-is/project";import type {Breakpoints,Instance,+ Instances,StyleDecl,StyleSource as StyleSourceType,} from "@webstudio-is/project-build";import {- instancesIndexStore,+ instancesStore,selectedInstanceBrowserStyleStore,selectedInstanceSelectorStore,selectedStyleSourceStore,@@ -18,10 +19,7 @@ import {useBreakpoints,} from "~/shared/nano-states";import { selectedBreakpointStore } from "~/shared/nano-states/breakpoints";-import {- type InstancesIndex,- getInstanceAncestorsAndSelf,-} from "~/shared/tree-utils";+import type { InstanceSelector } from "~/shared/tree-utils";import { getComponentMeta } from "@webstudio-is/react-sdk";type CascadedValueInfo = {@@ -151,13 +149,13 @@ export const getCascadedInfo = (};export const getPresetStyle = (- instancesIndex: InstancesIndex,+ instances: Instances,instanceId: undefined | Instance["id"]) => {if (instanceId === undefined) {return;}- const instance = instancesIndex.instancesById.get(instanceId);+ const instance = instances.get(instanceId);if (instance === undefined) {return;}@@ -169,20 +167,17 @@ export const getPresetStyle = (* including active breakpoints*/export const getInheritedInfo = (- instancesIndex: InstancesIndex,+ instances: Instances,stylesByInstanceId: Map<Instance["id"], StyleDecl[]>,- instanceId: string,+ instanceSelector: InstanceSelector,cascadedBreakpointIds: string[],selectedBreakpointId: string) => {const inheritedStyle: InheritedProperties = {};- const ancestorsAndSelf = getInstanceAncestorsAndSelf(- instancesIndex,- instanceId- );- for (const ancestorInstance of ancestorsAndSelf) {- // skip current element- if (ancestorInstance.id === instanceId) {+ // skip current instance and start with root til parent+ for (const instanceId of instanceSelector.slice(1).reverse()) {+ const ancestorInstance = instances.get(instanceId);+ if (ancestorInstance === undefined) {continue;}const cascadedAndSelectedBreakpointIds = [@@ -195,7 +190,7 @@ export const getInheritedInfo = (continue;}- const presetStyle = getPresetStyle(instancesIndex, ancestorInstance.id);+ const presetStyle = getPresetStyle(instances, ancestorInstance.id);if (presetStyle) {for (const [styleProperty, styleValue] of Object.entries(presetStyle)) {if (inheritableProperties.has(styleProperty)) {@@ -236,7 +231,7 @@ export const useStyleInfo = () => {const selectedStyleSource = useStore(selectedStyleSourceStore);const selectedStyleSourceId = selectedStyleSource?.id;const browserStyle = useStore(selectedInstanceBrowserStyleStore);- const instancesIndex = useStore(instancesIndexStore);+ const instances = useStore(instancesStore);const { stylesByInstanceId, stylesByStyleSourceId } =useStore(stylesIndexStore);@@ -266,17 +261,15 @@ export const useStyleInfo = () => {) {return {};}- const [selectedInstanceId] = selectedInstanceSelector;return getInheritedInfo(- instancesIndex,+ instances,stylesByInstanceId,- // @todo accept instance selector- selectedInstanceId,+ selectedInstanceSelector,cascadedBreakpointIds,selectedBreakpointId);}, [- instancesIndex,+ instances,stylesByInstanceId,cascadedBreakpointIds,selectedBreakpointId,@@ -287,19 +280,16 @@ export const useStyleInfo = () => {if (selectedInstanceSelector === undefined) {return {};}- const [selectedInstanceId] = selectedInstanceSelector;return getCascadedInfo(stylesByInstanceId,- // @todo accept instance Selector- selectedInstanceId,+ selectedInstanceSelector[0],cascadedBreakpointIds);}, [stylesByInstanceId, selectedInstanceSelector, cascadedBreakpointIds]);const presetStyle = useMemo(() => {- // @todo accept instance Selector- return getPresetStyle(instancesIndex, selectedInstanceSelector?.[0]);- }, [instancesIndex, selectedInstanceSelector]);+ return getPresetStyle(instances, selectedInstanceSelector?.[0]);+ }, [instances, selectedInstanceSelector]);const styleInfoData = useMemo(() => {const styleInfoData: StyleInfo = {};@@ -329,17 +319,17 @@ export const useStyleInfo = () => {};export const useInstanceStyleData = (- instanceId: Instance["id"] | undefined+ instanceSelector: InstanceSelector | undefined) => {- const instancesIndex = useStore(instancesIndexStore);+ const instances = useStore(instancesStore);const { stylesByInstanceId } = useStore(stylesIndexStore);const [breakpoints] = useBreakpoints();const selectedBreakpoint = useStore(selectedBreakpointStore);const selectedBreakpointId = selectedBreakpoint?.id;const presetStyle = useMemo(() => {- return getPresetStyle(instancesIndex, instanceId);- }, [instancesIndex, instanceId]);+ return getPresetStyle(instances, instanceSelector?.[0]);+ }, [instances, instanceSelector]);const cascadedBreakpointIds = useMemo(() => getCascadedBreakpointIds(breakpoints, selectedBreakpointId),@@ -347,37 +337,37 @@ export const useInstanceStyleData = ();const selfAndCascadeInfo = useMemo(() => {- if (instanceId === undefined || selectedBreakpointId === undefined) {+ if (instanceSelector === undefined || selectedBreakpointId === undefined) {return {};}- return getCascadedInfo(stylesByInstanceId, instanceId, [+ return getCascadedInfo(stylesByInstanceId, instanceSelector[0], [...cascadedBreakpointIds,selectedBreakpointId,]);}, [stylesByInstanceId,- instanceId,+ instanceSelector,cascadedBreakpointIds,selectedBreakpointId,]);const inheritedInfo = useMemo(() => {- if (selectedBreakpointId === undefined || instanceId === undefined) {+ if (selectedBreakpointId === undefined || instanceSelector === undefined) {return {};}return getInheritedInfo(- instancesIndex,+ instances,stylesByInstanceId,- instanceId,+ instanceSelector,cascadedBreakpointIds,selectedBreakpointId);}, [- instancesIndex,+ instances,stylesByInstanceId,cascadedBreakpointIds,selectedBreakpointId,- instanceId,+ instanceSelector,]);const styleData = useMemo(() => {diff --git a/apps/builder/app/builder/features/style-panel/style-settings.tsx b/apps/builder/app/builder/features/style-panel/style-settings.tsxindex 3e29de6f44..19ebccede7 100644--- a/apps/builder/app/builder/features/style-panel/style-settings.tsx+++ b/apps/builder/app/builder/features/style-panel/style-settings.tsx@@ -97,8 +97,12 @@ export type StyleSettingsProps = {const useParentStyle = () => {const selectedInstanceSelector = useStore(selectedInstanceSelectorStore);- const parentInstanceId = selectedInstanceSelector?.[1];- const parentInstanceStyleData = useInstanceStyleData(parentInstanceId);+ const parentInstanceSelector =+ // root does not have parent+ selectedInstanceSelector?.length === 1+ ? undefined+ : selectedInstanceSelector?.slice(1);+ const parentInstanceStyleData = useInstanceStyleData(parentInstanceSelector);return parentInstanceStyleData;};diff --git a/apps/builder/app/canvas/collapsed.ts b/apps/builder/app/canvas/collapsed.tsindex d508bd5e0f..2a95e18f0d 100644--- a/apps/builder/app/canvas/collapsed.ts+++ b/apps/builder/app/canvas/collapsed.ts@@ -6,7 +6,7 @@ import {} from "~/builder/features/style-panel/shared/style-info";import {breakpointsContainer,- instancesIndexStore,+ instancesStore,stylesIndexStore,} from "~/shared/nano-states";import { selectedBreakpointStore } from "~/shared/nano-states/breakpoints";@@ -44,7 +44,7 @@ const getInstanceSize = (instanceId: string) => {const breakpoints = breakpointsContainer.get();const selectedBreakpoint = selectedBreakpointStore.get();const { stylesByInstanceId } = stylesIndexStore.get();- const instancesIndex = instancesIndexStore.get();+ const instances = instancesStore.get();const selectedBreakpointId = selectedBreakpoint?.id;if (selectedBreakpointId === undefined) {@@ -59,7 +59,7 @@ const getInstanceSize = (instanceId: string) => {selectedBreakpointId);- const presetStyle = getPresetStyle(instancesIndex, instanceId);+ const presetStyle = getPresetStyle(instances, instanceId);const cascadedStyle = getCascadedInfo(stylesByInstanceId, instanceId, [...cascadedBreakpointIds,diff --git a/apps/builder/app/shared/tree-utils.test.ts b/apps/builder/app/shared/tree-utils.test.tsindex 114864a52e..08f25e7e0f 100644--- a/apps/builder/app/shared/tree-utils.test.ts+++ b/apps/builder/app/shared/tree-utils.test.ts@@ -12,11 +12,9 @@ import type {import {type InstanceSelector,cloneStyles,- createInstancesIndex,findClosestDroppableTarget,findSubtreeLocalStyleSources,getAncestorInstanceSelector,- getInstanceAncestorsAndSelf,insertInstancesCopyMutable,insertInstancesMutable,insertPropsCopyMutable,@@ -29,19 +27,6 @@ import {const expectString = expect.any(String) as unknown as string;const createInstance = (- id: Instance["id"],- component: string,- children: Instance[]-): Instance => {- return {- type: "instance",- id,- component,- children: children,- };-};--const createInstancesItem = (id: Instance["id"],component: string,children: InstancesItem["children"]@@ -59,7 +44,7 @@ const createInstancePair = (component: string,children: InstancesItem["children"]): [Instance["id"], InstancesItem] => {- return [id, createInstancesItem(id, component, children)];+ return [id, createInstance(id, component, children)];};const createProp = (id: string, instanceId: string): Prop => {@@ -200,10 +185,8 @@ test("insert instances tree into target", () => {insertInstancesMutable(instances,[- createInstancesItem("inserted1", "Box", [- { type: "id", value: "inserted2" },- ]),- createInstancesItem("inserted2", "Box", []),+ createInstance("inserted1", "Box", [{ type: "id", value: "inserted2" }]),+ createInstance("inserted2", "Box", []),],["inserted1"],{@@ -231,10 +214,8 @@ test("insert instances tree into target", () => {insertInstancesMutable(instances,[- createInstancesItem("inserted3", "Box", [- { type: "id", value: "inserted4" },- ]),- createInstancesItem("inserted4", "Box", []),+ createInstance("inserted3", "Box", [{ type: "id", value: "inserted4" }]),+ createInstance("inserted4", "Box", []),],["inserted3"],{@@ -357,36 +338,6 @@ test("reparent instance into target", () => {);});-test("get path from instance and its ancestors", () => {- const rootInstance: Instance = createInstance("root", "Box", [- createInstance("box1", "Box", []),- createInstance("box2", "Box", [- createInstance("box3", "Box", [- createInstance("child1", "Box", []),- createInstance("child2", "Box", []),- ]),- ]),- createInstance("box4", "Box", []),- ]);- const instancesIndex = createInstancesIndex(rootInstance);-- expect(getInstanceAncestorsAndSelf(instancesIndex, "box3")).toEqual([- rootInstance,-- createInstance("box2", "Box", [- createInstance("box3", "Box", [- createInstance("child1", "Box", []),- createInstance("child2", "Box", []),- ]),- ]),-- createInstance("box3", "Box", [- createInstance("child1", "Box", []),- createInstance("child2", "Box", []),- ]),- ]);-});-test("insert tree of instances copy and provide map from ids map", () => {const instances = new Map([createInstancePair("1", "Body", [@@ -398,11 +349,11 @@ test("insert tree of instances copy and provide map from ids map", () => {createInstancePair("4", "Box", []),]);const copiedInstances = [- createInstancesItem("2", "Box", [+ createInstance("2", "Box", [{ type: "id", value: "3" },{ type: "text", value: "text" },]),- createInstancesItem("3", "Box", []),+ createInstance("3", "Box", []),];const copiedInstanceIds = insertInstancesCopyMutable(instances,diff --git a/apps/builder/app/shared/tree-utils.ts b/apps/builder/app/shared/tree-utils.tsindex 1109fb7f4c..9dedc29a83 100644--- a/apps/builder/app/shared/tree-utils.ts+++ b/apps/builder/app/shared/tree-utils.ts@@ -195,20 +195,6 @@ export const reparentInstanceMutable = (}};-export const getInstanceAncestorsAndSelf = (- instancesIndex: InstancesIndex,- instanceId: Instance["id"]-) => {- const { instancesById, parentInstancesById } = instancesIndex;- const path = [];- let instance = instancesById.get(instanceId);- while (instance) {- path.unshift(instance);- instance = parentInstancesById.get(instance.id);- }- return path;-};-export const cloneStyles = (styles: Styles,clonedStyleSourceIds: Map<Instance["id"], Instance["id"]>