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.

Update token store directly (#796)

Bogdan Chadkin0d52c8949fa2
diff --git a/apps/designer/app/canvas/canvas.tsx b/apps/designer/app/canvas/canvas.tsx
index ddb11be0e9..60e4be6e36 100644
--- a/apps/designer/app/canvas/canvas.tsx
+++ b/apps/designer/app/canvas/canvas.tsx
@@ -32,6 +32,7 @@ import {
useBreakpoints,
useRootInstance,
useSetBreakpoints,
+ useSetDesignTokens,
useSetPresetStyles,
useSetRootInstance,
useSetStyles,
@@ -42,7 +43,6 @@ import { useDragAndDrop } from "./shared/use-drag-drop";
import { utils } from "@webstudio-is/project";
import { useSubscribeDesignerReady } from "./shared/use-designer-ready";
import type { Asset } from "@webstudio-is/asset-uploader";
-import { useInitializeDesignTokens } from "./shared/design-tokens";
import { useInstanceCopyPaste } from "~/shared/copy-paste";
import { useSelectedInstance } from "./shared/nano-states";
import { customComponents } from "./custom-components";
@@ -160,9 +160,9 @@ export const Canvas = ({ data }: CanvasProps): JSX.Element | null => {
throw new Error("Tree is null");
}
const isDesignerReady = useSubscribeDesignerReady();
- useInitializeDesignTokens(data.designTokens);
const assets = useAssets(data.assets);
useSetBreakpoints(data.breakpoints);
+ useSetDesignTokens(data.designTokens);
useAllUserProps(data.props);
useSetPresetStyles(data.tree.presetStyles);
useSetStyles(data.tree.styles);
diff --git a/apps/designer/app/canvas/shared/design-tokens.ts b/apps/designer/app/canvas/shared/design-tokens.ts
deleted file mode 100644
index fcd2ad67b4..0000000000
--- a/apps/designer/app/canvas/shared/design-tokens.ts
+++ /dev/null
@@ -1,10 +0,0 @@
-import type { DesignToken } from "@webstudio-is/design-tokens";
-import { useSyncInitializeOnce } from "~/shared/hook-utils";
-import { useDesignTokens } from "~/shared/nano-states";
-
-export const useInitializeDesignTokens = (designTokens: Array<DesignToken>) => {
- const [, setDesignTokens] = useDesignTokens();
- useSyncInitializeOnce(() => {
- setDesignTokens(designTokens);
- });
-};
diff --git a/apps/designer/app/canvas/shared/styles.ts b/apps/designer/app/canvas/shared/styles.ts
index 90d66e2e36..db41e418d1 100644
--- a/apps/designer/app/canvas/shared/styles.ts
+++ b/apps/designer/app/canvas/shared/styles.ts
@@ -1,10 +1,8 @@
import { useEffect, useMemo } from "react";
-import store from "immerhin";
import { useSubscribe } from "~/shared/pubsub";
import { addGlobalRules, getPresetStyleRules } from "@webstudio-is/project";
import { useSelectedInstance } from "./nano-states";
import {
- designTokensContainer,
useBreakpoints,
useDesignTokens,
usePresetStyles,
@@ -31,11 +29,7 @@ import {
} from "@webstudio-is/css-engine";
import { useIsomorphicLayoutEffect } from "react-use";
import type { Asset } from "@webstudio-is/asset-uploader";
-import {
- deleteTokenMutable,
- tokensToStyle,
- updateTokenMutable,
-} from "~/designer/shared/design-tokens-manager";
+import { tokensToStyle } from "~/designer/shared/design-tokens-manager";
const cssEngine = createCssEngine({ name: "user-styles" });
@@ -63,9 +57,6 @@ const helperStyles = [
];
export const useManageDesignModeStyles = () => {
- useUpdateToken();
- useCreateToken();
- useDeleteToken();
useUpdateStyle();
usePreviewStyle();
useRemoveSsrStyles();
@@ -265,30 +256,6 @@ const useUpdateStyle = () => {
});
};
-const useUpdateToken = () => {
- useSubscribe("updateToken", (update) => {
- store.createTransaction([designTokensContainer], (tokens) => {
- updateTokenMutable(tokens, update.token, update.name);
- });
- });
-};
-
-const useCreateToken = () => {
- useSubscribe("createToken", (token) => {
- store.createTransaction([designTokensContainer], (tokens) => {
- tokens.push(token);
- });
- });
-};
-
-const useDeleteToken = () => {
- useSubscribe("deleteToken", (name) => {
- store.createTransaction([designTokensContainer], (tokens) => {
- deleteTokenMutable(tokens, name);
- });
- });
-};
-
const usePreviewStyle = () => {
useSubscribe("previewStyle", ({ id, updates, breakpoint }) => {
let rule = getRule(id, breakpoint.id);
diff --git a/apps/designer/app/designer/features/sidebar-left/panels/design-tokens/design-tokens.tsx b/apps/designer/app/designer/features/sidebar-left/panels/design-tokens/design-tokens.tsx
index 9d469783cd..eb8879d3bb 100644
--- a/apps/designer/app/designer/features/sidebar-left/panels/design-tokens/design-tokens.tsx
+++ b/apps/designer/app/designer/features/sidebar-left/panels/design-tokens/design-tokens.tsx
@@ -1,16 +1,13 @@
import { TokensIcon } from "@webstudio-is/icons";
import { DesignTokensManager } from "~/designer/shared/design-tokens-manager";
-import type { Publish } from "~/shared/pubsub";
import { TabName } from "../../types";
import { Header, CloseButton } from "../../lib/header";
import { Flex } from "@webstudio-is/design-system";
export const TabContent = ({
onSetActiveTab,
- publish,
}: {
onSetActiveTab: (tabName: TabName) => void;
- publish: Publish;
}) => {
return (
<Flex direction="column" css={{ height: "100%" }}>
@@ -18,7 +15,7 @@ export const TabContent = ({
title="Design Tokens"
suffix={<CloseButton onClick={() => onSetActiveTab("none")} />}
/>
- <DesignTokensManager publish={publish} />
+ <DesignTokensManager />
</Flex>
);
};
diff --git a/apps/designer/app/designer/shared/design-tokens-manager/design-tokens-manager.tsx b/apps/designer/app/designer/shared/design-tokens-manager/design-tokens-manager.tsx
index e3e975f8d0..64630e38ce 100644
--- a/apps/designer/app/designer/shared/design-tokens-manager/design-tokens-manager.tsx
+++ b/apps/designer/app/designer/shared/design-tokens-manager/design-tokens-manager.tsx
@@ -1,32 +1,23 @@
import { useState } from "react";
+import store from "immerhin";
import { Flex, List, ListItem, useList } from "@webstudio-is/design-system";
import { CheckIcon } from "@webstudio-is/icons";
import type { DesignToken } from "@webstudio-is/design-tokens";
import { designTokensGroups } from "@webstudio-is/design-tokens";
-import { useDesignTokens } from "~/shared/nano-states";
-import type { Publish } from "~/shared/pubsub";
+import { designTokensContainer, useDesignTokens } from "~/shared/nano-states";
+import {
+ removeByMutable,
+ replaceByOrAppendMutable,
+} from "~/shared/array-utils";
// @todo this is temporary, we need to either make that collapsible reusable or copy it over
// This wasn't properly designed, so this is mostly temp
import { CollapsibleSection } from "../inspector";
-import { deleteTokenMutable, filterByType, updateTokenMutable } from "./utils";
+import { filterByType } from "./utils";
import { useMenu } from "./item-menu";
-import produce from "immer";
import { type DesignTokenSeed, TokenEditor } from "./token-editor";
-declare module "~/shared/pubsub" {
- export interface PubsubMap {
- updateToken: {
- // Previously known token name in case token name has changed
- name: DesignToken["name"];
- token: DesignToken;
- };
- createToken: DesignToken;
- deleteToken: DesignToken["name"];
- }
-}
-
-const useLogic = ({ publish }: { publish: Publish }) => {
- const [tokens, setTokens] = useDesignTokens();
+const useLogic = () => {
+ const [tokens] = useDesignTokens();
const [selectedIndex, setSelectedIndex] = useState(-1);
const [currentIndex, setCurrentIndex] = useState(-1);
const { getItemProps, getListProps } = useList({
@@ -44,39 +35,26 @@ const useLogic = ({ publish }: { publish: Publish }) => {
onSelect: setSelectedIndex,
onDelete: () => {
const { name } = tokens[selectedIndex];
- publish({ type: "deleteToken", payload: name });
- const updatedTokens = produce(tokens, (draft) => {
- deleteTokenMutable(draft, name);
+ store.createTransaction([designTokensContainer], (tokens) => {
+ removeByMutable(tokens, (item) => item.name === name);
});
- setTokens(updatedTokens);
},
onEdit: (index) => {
setEditingToken(tokens[index]);
},
});
- const createToken = (token: DesignToken) => {
- publish({ type: "createToken", payload: token });
- setTokens([...tokens, token]);
- };
-
- const updateToken = (previousToken: DesignToken, nextToken: DesignToken) => {
- publish({
- type: "updateToken",
- payload: { name: previousToken.name, token: nextToken },
+ const setToken = (name: undefined | string, token: DesignToken) => {
+ store.createTransaction([designTokensContainer], (tokens) => {
+ replaceByOrAppendMutable(tokens, token, (item) => item.name === name);
});
- const updatedTokens = produce(tokens, (draft) => {
- updateTokenMutable(draft, nextToken, previousToken.name);
- });
- setTokens(updatedTokens);
};
return {
isMenuOpen,
getListProps,
getItemProps,
- createToken,
- updateToken,
+ setToken,
setEditingToken,
editingToken,
tokens,
@@ -84,18 +62,17 @@ const useLogic = ({ publish }: { publish: Publish }) => {
};
};
-export const DesignTokensManager = ({ publish }: { publish: Publish }) => {
+export const DesignTokensManager = () => {
const {
getListProps,
getItemProps,
- createToken,
- updateToken,
+ setToken,
setEditingToken,
isMenuOpen,
editingToken,
tokens,
renderMenu,
- } = useLogic({ publish });
+ } = useLogic();
const renderEditor = ({
token,
@@ -115,11 +92,8 @@ export const DesignTokensManager = ({ publish }: { publish: Publish }) => {
isOpen={isOpen}
trigger={trigger}
onChangeComplete={(updatedToken) => {
- if (token === undefined) {
- return createToken(updatedToken);
- }
-
- updateToken(token, updatedToken);
+ // Previously known token name in case token name has changed
+ setToken(token?.name, updatedToken);
}}
onOpenChange={(isOpen) => {
if (isOpen === false) {
diff --git a/apps/designer/app/designer/shared/design-tokens-manager/index.ts b/apps/designer/app/designer/shared/design-tokens-manager/index.ts
index 5f7eeae37e..b86ceadc28 100644
--- a/apps/designer/app/designer/shared/design-tokens-manager/index.ts
+++ b/apps/designer/app/designer/shared/design-tokens-manager/index.ts
@@ -1,2 +1,2 @@
export * from "./design-tokens-manager";
-export { tokensToStyle, updateTokenMutable, deleteTokenMutable } from "./utils";
+export { tokensToStyle } from "./utils";
diff --git a/apps/designer/app/designer/shared/design-tokens-manager/utils.test.ts b/apps/designer/app/designer/shared/design-tokens-manager/utils.test.ts
index d80b2ed527..43d284dc7e 100644
--- a/apps/designer/app/designer/shared/design-tokens-manager/utils.test.ts
+++ b/apps/designer/app/designer/shared/design-tokens-manager/utils.test.ts
@@ -1,13 +1,6 @@
import { describe, test, expect } from "@jest/globals";
import type { DesignToken } from "@webstudio-is/design-tokens";
-import produce from "immer";
-import {
- deleteTokenMutable,
- filterByType,
- findByName,
- tokensToStyle,
- updateTokenMutable,
-} from "./utils";
+import { filterByType, findByName, tokensToStyle } from "./utils";
const tokens: Array<DesignToken> = [
{ name: "a", type: "color", value: "red", group: "Color" },
@@ -16,77 +9,6 @@ const tokens: Array<DesignToken> = [
];
describe("design tokens manager utils", () => {
- test("deleteTokenMutable", () => {
- let updated = [...tokens];
- deleteTokenMutable(updated, "a");
- expect(updated).toMatchInlineSnapshot(`
- [
- {
- "group": "Color",
- "name": "b",
- "type": "color",
- "value": "green",
- },
- {
- "group": "Sizing",
- "name": "c",
- "type": "sizing",
- "value": "20px",
- },
- ]
- `);
- updated = [...tokens];
- deleteTokenMutable(updated, "b");
- expect(updated).toMatchInlineSnapshot(`
- [
- {
- "group": "Color",
- "name": "a",
- "type": "color",
- "value": "red",
- },
- {
- "group": "Sizing",
- "name": "c",
- "type": "sizing",
- "value": "20px",
- },
- ]
- `);
- });
-
- test("updateTokenMutable", () => {
- const updated = produce(tokens, (draft) => {
- updateTokenMutable(
- draft,
- { name: "c", type: "color", value: "blue", group: "Color" },
- "a"
- );
- });
- expect(updated).toMatchInlineSnapshot(`
- [
- {
- "group": "Color",
- "name": "c",
- "type": "color",
- "value": "blue",
- },
- {
- "group": "Color",
- "name": "b",
- "type": "color",
- "value": "green",
- },
- {
- "group": "Sizing",
- "name": "c",
- "type": "sizing",
- "value": "20px",
- },
- ]
- `);
- });
-
test("tokensToStyle", () => {
expect(tokensToStyle(tokens)).toMatchInlineSnapshot(`
{
diff --git a/apps/designer/app/designer/shared/design-tokens-manager/utils.ts b/apps/designer/app/designer/shared/design-tokens-manager/utils.ts
index 7fe9ad78f8..071931f830 100644
--- a/apps/designer/app/designer/shared/design-tokens-manager/utils.ts
+++ b/apps/designer/app/designer/shared/design-tokens-manager/utils.ts
@@ -17,24 +17,3 @@ export const tokensToStyle = (tokens: Array<DesignToken>) => {
}
return style;
};
-
-export const updateTokenMutable = (
- tokens: Array<DesignToken>,
- token: DesignToken,
- name: string
-) => {
- const found = findByName(tokens, name);
- if (found) {
- Object.assign(found, token);
- return true;
- }
- return false;
-};
-
-export const deleteTokenMutable = (
- tokens: Array<DesignToken>,
- name: DesignToken["name"]
-) => {
- const index = tokens.findIndex((token) => token.name === name);
- tokens.splice(index, 1);
-};
diff --git a/apps/designer/app/shared/nano-states/nano-states.ts b/apps/designer/app/shared/nano-states/nano-states.ts
index a8a1b8756d..d96098f929 100644
--- a/apps/designer/app/shared/nano-states/nano-states.ts
+++ b/apps/designer/app/shared/nano-states/nano-states.ts
@@ -46,6 +46,14 @@ export const useSetBreakpoints = (breakpoints: Breakpoint[]) => {
});
};
+export const designTokensContainer = atom<DesignToken[]>([]);
+export const useDesignTokens = () => useValue(designTokensContainer);
+export const useSetDesignTokens = (designTokens: DesignToken[]) => {
+ useSyncInitializeOnce(() => {
+ designTokensContainer.set(designTokens);
+ });
+};
+
const isPreviewModeContainer = atom<boolean>(false);
export const useIsPreviewMode = () => useValue(isPreviewModeContainer);
@@ -81,6 +89,3 @@ const dragAndDropStateContainer = atom<DragAndDropState>({
isDragging: false,
});
export const useDragAndDropState = () => useValue(dragAndDropStateContainer);
-
-export const designTokensContainer = atom<Array<DesignToken>>([]);
-export const useDesignTokens = () => useValue(designTokensContainer);