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.

Switch to utils for style management (#906)

Bogdan Chadkinf6f368898b7f
diff --git a/apps/designer/app/canvas/shared/instance.ts b/apps/designer/app/canvas/shared/instance.ts
index 6db86815ab..e863ebcec9 100644
--- a/apps/designer/app/canvas/shared/instance.ts
+++ b/apps/designer/app/canvas/shared/instance.ts
@@ -7,8 +7,8 @@ import { useSubscribe } from "~/shared/pubsub";
import {
propsStore,
rootInstanceContainer,
+ stylesStore,
selectedInstanceIdStore,
- stylesContainer,
useTextEditingInstanceId,
} from "~/shared/nano-states";
import { publish } from "~/shared/pubsub";
@@ -67,7 +67,7 @@ export const useInsertInstance = () => {
}) => {
const selectedInstanceId = selectedInstanceIdStore.get();
store.createTransaction(
- [rootInstanceContainer, propsStore, stylesContainer],
+ [rootInstanceContainer, propsStore, stylesStore],
(rootInstance, props, styles) => {
if (rootInstance === undefined) {
return;
@@ -123,7 +123,7 @@ export const useDeleteInstance = () => {
return;
}
store.createTransaction(
- [rootInstanceContainer, propsStore, stylesContainer],
+ [rootInstanceContainer, propsStore, stylesStore],
(rootInstance, props, styles) => {
if (rootInstance === undefined) {
return;
diff --git a/apps/designer/app/designer/features/breakpoints/breakpoints.tsx b/apps/designer/app/designer/features/breakpoints/breakpoints.tsx
index cf62ea569e..3609594df4 100644
--- a/apps/designer/app/designer/features/breakpoints/breakpoints.tsx
+++ b/apps/designer/app/designer/features/breakpoints/breakpoints.tsx
@@ -25,7 +25,7 @@ import {
import { ConfirmationDialog } from "./confirmation-dialog";
import {
breakpointsContainer,
- stylesContainer,
+ stylesStore,
useBreakpoints,
} from "~/shared/nano-states";
import { utils } from "@webstudio-is/project";
@@ -67,7 +67,7 @@ export const Breakpoints = () => {
return;
}
const [updatedBreakpoints] = store.createTransaction(
- [breakpointsContainer, stylesContainer],
+ [breakpointsContainer, stylesStore],
(breakpoints, styles) => {
removeByMutable(breakpoints, ({ id }) => id === breakpointToDelete.id);
removeByMutable(
diff --git a/apps/designer/app/designer/features/style-panel/shared/style-info.test.ts b/apps/designer/app/designer/features/style-panel/shared/style-info.test.ts
index 84d4034a18..7e1c76917e 100644
--- a/apps/designer/app/designer/features/style-panel/shared/style-info.test.ts
+++ b/apps/designer/app/designer/features/style-panel/shared/style-info.test.ts
@@ -36,7 +36,8 @@ const cascadedBreakpointIds = getCascadedBreakpointIds(
selectedBreakpointId
);
-const cascadingStyles: Styles = [
+const cascadingStylesByInstanceId = new Map<Instance["id"], Styles>();
+cascadingStylesByInstanceId.set(selectedInstanceId, [
{
breakpointId: "1",
instanceId: selectedInstanceId,
@@ -68,7 +69,7 @@ const cascadingStyles: Styles = [
property: "width",
value: { type: "unit", value: 400, unit: "px" },
},
-];
+]);
const rootInstance: Instance = {
type: "instance",
@@ -91,7 +92,8 @@ const rootInstance: Instance = {
],
};
-const inheritingStyles: Styles = [
+const inheritingStylesByInstanceId = new Map<Instance["id"], Styles>();
+inheritingStylesByInstanceId.set("1", [
// should be inherited even from another breakpoint
{
breakpointId: "1",
@@ -99,7 +101,8 @@ const inheritingStyles: Styles = [
property: "fontSize",
value: { type: "unit", value: 20, unit: "px" },
},
-
+]);
+inheritingStylesByInstanceId.set("2", [
// should not be inherited because width is not inheritable
{
breakpointId: "3",
@@ -114,7 +117,8 @@ const inheritingStyles: Styles = [
property: "fontWeight",
value: { type: "keyword", value: "600" },
},
-
+]);
+inheritingStylesByInstanceId.set("3", [
// should not show selected style as inherited
{
breakpointId: "3",
@@ -122,11 +126,15 @@ const inheritingStyles: Styles = [
property: "fontWeight",
value: { type: "keyword", value: "500" },
},
-];
+]);
test("compute cascaded styles", () => {
expect(
- getCascadedInfo(cascadingStyles, selectedInstanceId, cascadedBreakpointIds)
+ getCascadedInfo(
+ cascadingStylesByInstanceId,
+ selectedInstanceId,
+ cascadedBreakpointIds
+ )
).toMatchInlineSnapshot(`
{
"height": {
@@ -153,7 +161,7 @@ test("compute inherited styles", () => {
expect(
getInheritedInfo(
rootInstance,
- inheritingStyles,
+ inheritingStylesByInstanceId,
selectedInstanceId,
cascadedBreakpointIds,
selectedBreakpointId
diff --git a/apps/designer/app/designer/features/style-panel/shared/style-info.ts b/apps/designer/app/designer/features/style-panel/shared/style-info.ts
index 5edc3e6832..1c59db280a 100644
--- a/apps/designer/app/designer/features/style-panel/shared/style-info.ts
+++ b/apps/designer/app/designer/features/style-panel/shared/style-info.ts
@@ -12,9 +12,9 @@ import type { Instance, Styles } from "@webstudio-is/project-build";
import {
selectedInstanceBrowserStyleStore,
selectedInstanceIdStore,
+ stylesIndexStore,
useBreakpoints,
useRootInstance,
- useStyles,
} from "~/shared/nano-states";
import { useSelectedBreakpoint } from "~/designer/shared/nano-states";
@@ -76,16 +76,17 @@ for (const [property, value] of Object.entries(properties)) {
}
export const getLocalStyle = (
- styles: Styles,
+ stylesByInstanceId: Map<Instance["id"], Styles>,
breakpointId: string,
instanceId: string
) => {
const style: Style = {};
- for (const styleItem of styles) {
- if (
- styleItem.breakpointId === breakpointId &&
- styleItem.instanceId === instanceId
- ) {
+ const instanceStyles = stylesByInstanceId.get(instanceId);
+ if (instanceStyles === undefined) {
+ return style;
+ }
+ for (const styleItem of instanceStyles) {
+ if (styleItem.breakpointId === breakpointId) {
style[styleItem.property] = styleItem.value;
}
}
@@ -115,17 +116,18 @@ export const getCascadedBreakpointIds = (
* affecting current view
*/
export const getCascadedInfo = (
- styles: Styles,
+ stylesByInstanceId: Map<Instance["id"], Styles>,
instanceId: string,
cascadedBreakpointIds: string[]
) => {
const cascadedStyle: CascadedProperties = {};
+ const instanceStyles = stylesByInstanceId.get(instanceId);
+ if (instanceStyles === undefined) {
+ return cascadedStyle;
+ }
for (const breakpointId of cascadedBreakpointIds) {
- for (const styleItem of styles) {
- if (
- styleItem.breakpointId === breakpointId &&
- styleItem.instanceId === instanceId
- ) {
+ for (const styleItem of instanceStyles) {
+ if (styleItem.breakpointId === breakpointId) {
cascadedStyle[styleItem.property] = {
breakpointId,
value: styleItem.value,
@@ -142,7 +144,7 @@ export const getCascadedInfo = (
*/
export const getInheritedInfo = (
rootInstance: Instance,
- styles: Styles,
+ stylesByInstanceId: Map<Instance["id"], Styles>,
instanceId: string,
cascadedBreakpointIds: string[],
selectedBreakpointId: string
@@ -159,12 +161,16 @@ export const getInheritedInfo = (
selectedBreakpointId,
];
+ const ancestorInstanceStyles = stylesByInstanceId.get(ancestorInstance.id);
+ if (ancestorInstanceStyles === undefined) {
+ continue;
+ }
+
// extract styles from all active breakpoints
for (const breakpointId of cascadedAndSelectedBreakpointIds) {
- for (const styleItem of styles) {
+ for (const styleItem of ancestorInstanceStyles) {
if (
styleItem.breakpointId === breakpointId &&
- styleItem.instanceId === ancestorInstance.id &&
inheritableProperties.has(styleItem.property)
) {
inheritedStyle[styleItem.property] = {
@@ -188,7 +194,7 @@ export const useStyleInfo = () => {
const selectedInstanceId = useStore(selectedInstanceIdStore);
const browserStyle = useStore(selectedInstanceBrowserStyleStore);
const [rootInstance] = useRootInstance();
- const [styles] = useStyles();
+ const { stylesByInstanceId } = useStore(stylesIndexStore);
const localStyle = useMemo(() => {
if (
@@ -197,8 +203,12 @@ export const useStyleInfo = () => {
) {
return {};
}
- return getLocalStyle(styles, selectedBreakpointId, selectedInstanceId);
- }, [styles, selectedBreakpointId, selectedInstanceId]);
+ return getLocalStyle(
+ stylesByInstanceId,
+ selectedBreakpointId,
+ selectedInstanceId
+ );
+ }, [stylesByInstanceId, selectedBreakpointId, selectedInstanceId]);
const cascadedBreakpointIds = useMemo(
() => getCascadedBreakpointIds(breakpoints, selectedBreakpointId),
@@ -215,14 +225,14 @@ export const useStyleInfo = () => {
}
return getInheritedInfo(
rootInstance,
- styles,
+ stylesByInstanceId,
selectedInstanceId,
cascadedBreakpointIds,
selectedBreakpointId
);
}, [
rootInstance,
- styles,
+ stylesByInstanceId,
cascadedBreakpointIds,
selectedBreakpointId,
selectedInstanceId,
@@ -232,8 +242,12 @@ export const useStyleInfo = () => {
if (selectedInstanceId === undefined) {
return {};
}
- return getCascadedInfo(styles, selectedInstanceId, cascadedBreakpointIds);
- }, [styles, selectedInstanceId, cascadedBreakpointIds]);
+ return getCascadedInfo(
+ stylesByInstanceId,
+ selectedInstanceId,
+ cascadedBreakpointIds
+ );
+ }, [stylesByInstanceId, selectedInstanceId, cascadedBreakpointIds]);
const styleInfoData = useMemo(() => {
const styleInfoData: StyleInfo = {};
diff --git a/apps/designer/app/designer/features/style-panel/shared/use-style-data.ts b/apps/designer/app/designer/features/style-panel/shared/use-style-data.ts
index 6ed34118d3..0150124fae 100644
--- a/apps/designer/app/designer/features/style-panel/shared/use-style-data.ts
+++ b/apps/designer/app/designer/features/style-panel/shared/use-style-data.ts
@@ -5,11 +5,15 @@ import type { Instance } from "@webstudio-is/project-build";
import type { StyleUpdates } from "@webstudio-is/project";
import type { StyleProperty, StyleValue } from "@webstudio-is/css-data";
import { type Publish } from "~/shared/pubsub";
-import { stylesContainer } from "~/shared/nano-states";
+import { stylesStore } from "~/shared/nano-states";
import { useSelectedBreakpoint } from "~/designer/shared/nano-states";
// @todo: must be removed, now it's only for compatibility with existing code
import { parseCssValue } from "./parse-css-value";
import { useStyleInfo } from "./style-info";
+import {
+ removeByMutable,
+ replaceByOrAppendMutable,
+} from "~/shared/array-utils";
declare module "~/shared/pubsub" {
export interface PubsubMap {
@@ -66,33 +70,35 @@ export const useStyleData = ({ selectedInstance, publish }: UseStyleData) => {
return;
}
- store.createTransaction([stylesContainer], (styles) => {
+ store.createTransaction([stylesStore], (styles) => {
const instanceId = selectedInstance.id;
const breakpointId = selectedBreakpoint.id;
- for (const update of updates) {
- const matchedIndex = styles.findIndex(
- (item) =>
- item.breakpointId === breakpointId &&
- item.instanceId === instanceId &&
- item.property === update.property
- );
+ for (const update of updates) {
if (update.operation === "set") {
- const newItem = {
- breakpointId,
- instanceId,
- property: update.property,
- value: update.value,
- };
- if (matchedIndex === -1) {
- styles.push(newItem);
- } else {
- styles[matchedIndex] = newItem;
- }
+ replaceByOrAppendMutable(
+ styles,
+ {
+ breakpointId,
+ instanceId,
+ property: update.property,
+ value: update.value,
+ },
+ (item) =>
+ item.instanceId === instanceId &&
+ item.breakpointId === breakpointId &&
+ item.property === update.property
+ );
}
- if (update.operation === "delete" && matchedIndex !== -1) {
- styles.splice(matchedIndex, 1);
+ if (update.operation === "delete") {
+ removeByMutable(
+ styles,
+ (item) =>
+ item.instanceId === instanceId &&
+ item.breakpointId === breakpointId &&
+ item.property === update.property
+ );
}
}
});
diff --git a/apps/designer/app/shared/nano-states/nano-states.ts b/apps/designer/app/shared/nano-states/nano-states.ts
index b8bdc44f84..c86fbef4e8 100644
--- a/apps/designer/app/shared/nano-states/nano-states.ts
+++ b/apps/designer/app/shared/nano-states/nano-states.ts
@@ -77,7 +77,7 @@ export const useInstanceProps = (instanceId: undefined | Instance["id"]) => {
return instanceProps;
};
-export const stylesContainer = atom<Styles>([]);
+export const stylesStore = atom<Styles>([]);
/**
* Indexed styles data is recomputed on every styles update
* Compumer should use shallow-equal to check all items in the list
@@ -87,7 +87,7 @@ export const stylesContainer = atom<Styles>([]);
* though will require to move away from running immer patches on array
* of styles
*/
-export const stylesIndexStore = computed(stylesContainer, (styles) => {
+export const stylesIndexStore = computed(stylesStore, (styles) => {
const stylesByInstanceId = new Map<Instance["id"], Styles>();
for (const stylesItem of styles) {
const { instanceId } = stylesItem;
@@ -103,10 +103,9 @@ export const stylesIndexStore = computed(stylesContainer, (styles) => {
};
});
-export const useStyles = () => useValue(stylesContainer);
export const useSetStyles = (styles: Styles) => {
useSyncInitializeOnce(() => {
- stylesContainer.set(styles);
+ stylesStore.set(styles);
});
};
export const useInstanceStyles = (instanceId: undefined | Instance["id"]) => {
diff --git a/apps/designer/app/shared/sync/sync-stores.ts b/apps/designer/app/shared/sync/sync-stores.ts
index 02cec65f3b..5c7cd94bff 100644
--- a/apps/designer/app/shared/sync/sync-stores.ts
+++ b/apps/designer/app/shared/sync/sync-stores.ts
@@ -6,7 +6,7 @@ import {
rootInstanceContainer,
propsStore,
breakpointsContainer,
- stylesContainer,
+ stylesStore,
selectedInstanceIdStore,
selectedInstanceBrowserStyleStore,
hoveredInstanceIdStore,
@@ -41,7 +41,7 @@ export const registerContainers = () => {
// synchronize patches
store.register("breakpoints", breakpointsContainer);
store.register("root", rootInstanceContainer);
- store.register("styles", stylesContainer);
+ store.register("styles", stylesStore);
store.register("props", propsStore);
// synchronize whole states
clientStores.set("selectedInstanceId", selectedInstanceIdStore);