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.

refactor: store selected instance in awareness state (#4378)

Bogdan Chadkinf36fe2fa554b
diff --git a/apps/builder/app/builder/features/footer/breadcrumbs.tsx b/apps/builder/app/builder/features/footer/breadcrumbs.tsx
index e9bcd33e50..180206a7c8 100644
--- a/apps/builder/app/builder/features/footer/breadcrumbs.tsx
+++ b/apps/builder/app/builder/features/footer/breadcrumbs.tsx
@@ -1,3 +1,4 @@
+import { Fragment } from "react";
import { useStore } from "@nanostores/react";
import { ChevronRightIcon } from "@webstudio-is/icons";
import { theme, Button, Flex, Text } from "@webstudio-is/design-system";
@@ -9,7 +10,7 @@ import {
import { getAncestorInstanceSelector } from "~/shared/tree-utils";
import { $textEditingInstanceSelector } from "~/shared/nano-states";
import { getInstanceLabel } from "~/shared/instance-utils";
-import { Fragment } from "react";
+import { selectInstance } from "~/shared/awareness";
export const Breadcrumbs = () => {
const instances = useStore($instances);
@@ -41,7 +42,7 @@ export const Breadcrumbs = () => {
css={{ color: "inherit" }}
key={instance.id}
onClick={() => {
- $selectedInstanceSelector.set(
+ selectInstance(
getAncestorInstanceSelector(
selectedInstanceSelector,
instance.id
diff --git a/apps/builder/app/builder/features/marketplace/templates.tsx b/apps/builder/app/builder/features/marketplace/templates.tsx
index 0295dd137f..4a2ae194be 100644
--- a/apps/builder/app/builder/features/marketplace/templates.tsx
+++ b/apps/builder/app/builder/features/marketplace/templates.tsx
@@ -27,9 +27,9 @@ import {
updateWebstudioData,
} from "~/shared/instance-utils";
import { insertPageCopyMutable } from "~/shared/page-utils";
-import { switchPage } from "~/shared/pages";
import { Card } from "./card";
import type { MarketplaceOverviewItem } from "~/shared/marketplace/types";
+import { selectPage } from "~/shared/awareness";
/**
* Insert page as a template.
@@ -65,7 +65,7 @@ const insertPage = ({
});
});
if (newPageId) {
- switchPage(newPageId);
+ selectPage(newPageId);
}
};
diff --git a/apps/builder/app/builder/features/navigator/navigator-tree.tsx b/apps/builder/app/builder/features/navigator/navigator-tree.tsx
index 3b41788085..0a77ceaf91 100644
--- a/apps/builder/app/builder/features/navigator/navigator-tree.tsx
+++ b/apps/builder/app/builder/features/navigator/navigator-tree.tsx
@@ -55,7 +55,7 @@ import {
} from "~/shared/instance-utils";
import { emitCommand } from "~/builder/shared/commands";
import { useContentEditable } from "~/shared/dom-hooks";
-import { $selectedPage } from "~/shared/awareness";
+import { $selectedPage, selectInstance } from "~/shared/awareness";
type TreeItem = {
level: number;
@@ -485,8 +485,8 @@ export const NavigatorTree = () => {
level={0}
isSelected={selectedKey === ROOT_INSTANCE_ID}
buttonProps={{
- onClick: () => $selectedInstanceSelector.set([ROOT_INSTANCE_ID]),
- onFocus: () => $selectedInstanceSelector.set([ROOT_INSTANCE_ID]),
+ onClick: () => selectInstance([ROOT_INSTANCE_ID]),
+ onFocus: () => selectInstance([ROOT_INSTANCE_ID]),
}}
action={
<Tooltip
@@ -588,8 +588,8 @@ export const NavigatorTree = () => {
onMouseEnter: () =>
$hoveredInstanceSelector.set(item.selector),
onMouseLeave: () => $hoveredInstanceSelector.set(undefined),
- onClick: () => $selectedInstanceSelector.set(item.selector),
- onFocus: () => $selectedInstanceSelector.set(item.selector),
+ onClick: () => selectInstance(item.selector),
+ onFocus: () => selectInstance(item.selector),
onKeyDown: (event) => {
if (event.key === "Enter") {
emitCommand("editInstanceText");
diff --git a/apps/builder/app/builder/features/pages/page-settings.tsx b/apps/builder/app/builder/features/pages/page-settings.tsx
index a1dc36800b..3491c8043e 100644
--- a/apps/builder/app/builder/features/pages/page-settings.tsx
+++ b/apps/builder/app/builder/features/pages/page-settings.tsx
@@ -70,7 +70,6 @@ import {
$assets,
$instances,
$pages,
- $selectedInstanceSelector,
$dataSources,
computeExpression,
$dataSourceVariables,
@@ -108,6 +107,7 @@ import { $userPlanFeatures } from "~/builder/shared/nano-states";
import type { UserPlanFeatures } from "~/shared/db/user-plan-features.server";
import { useUnmount } from "~/shared/hook-utils/use-mount";
import { Card } from "../marketplace/card";
+import { selectInstance } from "~/shared/awareness";
const fieldDefaultValues = {
name: "Untitled",
@@ -1390,7 +1390,7 @@ const createPage = (pageId: Page["id"], values: Values) => {
});
registerFolderChildMutable(pages.folders, pageId, values.parentFolderId);
- $selectedInstanceSelector.set(undefined);
+ selectInstance(undefined);
}
);
};
diff --git a/apps/builder/app/builder/features/pages/page-utils.ts b/apps/builder/app/builder/features/pages/page-utils.ts
index d7bae87f04..0a1a176781 100644
--- a/apps/builder/app/builder/features/pages/page-utils.ts
+++ b/apps/builder/app/builder/features/pages/page-utils.ts
@@ -20,11 +20,10 @@ import {
import {
$dataSources,
$pages,
- $selectedInstanceSelector,
$variableValuesByInstanceSelector,
} from "~/shared/nano-states";
import { insertPageCopyMutable } from "~/shared/page-utils";
-import { $awareness, $selectedPage } from "~/shared/awareness";
+import { $selectedPage, selectPage } from "~/shared/awareness";
/**
* When page or folder needs to be deleted or moved to a different parent,
@@ -205,9 +204,8 @@ export const getAllChildrenAndSelf = (
export const deletePageMutable = (pageId: Page["id"], data: WebstudioData) => {
const { pages } = data;
// deselect page before deleting to avoid flash of content
- if ($awareness.get()?.pageId === pageId) {
- $awareness.set({ pageId: pages.homePage.id });
- $selectedInstanceSelector.set(undefined);
+ if ($selectedPage.get()?.id === pageId) {
+ selectPage(pages.homePage.id);
}
const rootInstanceId = findPageByIdOrPath(pageId, pages)?.rootInstanceId;
if (rootInstanceId !== undefined) {
diff --git a/apps/builder/app/builder/features/pages/pages.tsx b/apps/builder/app/builder/features/pages/pages.tsx
index 09dda4c2ca..28c8bfc03c 100644
--- a/apps/builder/app/builder/features/pages/pages.tsx
+++ b/apps/builder/app/builder/features/pages/pages.tsx
@@ -28,7 +28,6 @@ import {
import { ExtendedPanel } from "../../shared/extended-sidebar-panel";
import { NewPageSettings, PageSettings } from "./page-settings";
import { $editingPageId, $pages } from "~/shared/nano-states";
-import { switchPage } from "~/shared/pages";
import {
getAllChildrenAndSelf,
reparentOrphansMutable,
@@ -50,7 +49,7 @@ import {
import { atom, computed } from "nanostores";
import { isPathnamePattern } from "~/builder/shared/url-pattern";
import { updateWebstudioData } from "~/shared/instance-utils";
-import { $selectedPage } from "~/shared/awareness";
+import { $selectedPage, selectPage } from "~/shared/awareness";
const ItemSuffix = ({
isParentSelected,
@@ -448,7 +447,7 @@ const PageEditor = ({
onClose={onClose}
onSuccess={(pageId) => {
onClose();
- switchPage(pageId);
+ selectPage(pageId);
}}
/>
);
@@ -463,13 +462,13 @@ const PageEditor = ({
if (editingPageId === currentPage?.id) {
const pages = $pages.get();
if (pages) {
- switchPage(pages.homePage.id);
+ selectPage(pages.homePage.id);
}
}
}}
onDuplicate={(newPageId) => {
onClose();
- switchPage(newPageId);
+ selectPage(newPageId);
}}
pageId={editingPageId}
key={editingPageId}
@@ -560,14 +559,14 @@ export const PagesPanel = ({ onClose }: { onClose: () => void }) => {
<PagesTree
selectedPageId={currentPage.id}
onSelect={(itemId) => {
- switchPage(itemId);
+ selectPage(itemId);
onClose();
}}
editingItemId={editingItemId}
onEdit={(itemId) => {
// always select page when edit its settings
if (itemId && isFolder(itemId, pages.folders) === false) {
- switchPage(itemId);
+ selectPage(itemId);
}
$editingPageId.set(itemId);
}}
diff --git a/apps/builder/app/builder/features/settings-panel/variables-section.stories.tsx b/apps/builder/app/builder/features/settings-panel/variables-section.stories.tsx
index dd5fe207a6..303595f24d 100644
--- a/apps/builder/app/builder/features/settings-panel/variables-section.stories.tsx
+++ b/apps/builder/app/builder/features/settings-panel/variables-section.stories.tsx
@@ -1,15 +1,11 @@
import type { Meta, StoryObj } from "@storybook/react";
import { Box } from "@webstudio-is/design-system";
-import { VariablesSection as VariablesSectionComponent } from "./variables-section";
-import {
- $pages,
- $selectedInstanceSelector,
- $instances,
-} from "~/shared/nano-states";
-import { registerContainers } from "~/shared/sync";
import { createDefaultPages } from "@webstudio-is/project-build";
+import { $pages, $instances } from "~/shared/nano-states";
+import { registerContainers } from "~/shared/sync";
import { $userPlanFeatures } from "~/builder/shared/nano-states";
import { $awareness } from "~/shared/awareness";
+import { VariablesSection as VariablesSectionComponent } from "./variables-section";
$userPlanFeatures.set({
...$userPlanFeatures.get(),
@@ -22,16 +18,15 @@ export default {
} satisfies Meta;
registerContainers();
-$selectedInstanceSelector.set(["root"]);
$instances.set(
new Map([
- ["root", { id: "root", type: "instance", component: "Box", children: [] }],
+ ["box", { id: "box", type: "instance", component: "Box", children: [] }],
])
);
-$awareness.set({ pageId: "home" });
$pages.set(
- createDefaultPages({ rootInstanceId: "root", systemDataSourceId: "system" })
+ createDefaultPages({ rootInstanceId: "box", systemDataSourceId: "system" })
);
+$awareness.set({ pageId: "home", instanceSelector: ["box"] });
export const VariablesSection: StoryObj = {
render: () => (
diff --git a/apps/builder/app/builder/features/style-panel/sections/advanced/advanced.stories.tsx b/apps/builder/app/builder/features/style-panel/sections/advanced/advanced.stories.tsx
index a726e041fb..0d220e4637 100644
--- a/apps/builder/app/builder/features/style-panel/sections/advanced/advanced.stories.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/advanced/advanced.stories.tsx
@@ -4,11 +4,11 @@ import { Section } from "./advanced";
import {
$breakpoints,
$selectedBreakpointId,
- $selectedInstanceSelector,
$styles,
$styleSourceSelections,
} from "~/shared/nano-states";
import { setProperty } from "../../shared/use-style-data";
+import { $awareness } from "~/shared/awareness";
const backgroundImage: StyleDecl = {
breakpointId: "base",
@@ -27,7 +27,10 @@ $styles.set(new Map([[getStyleDeclKey(backgroundImage), backgroundImage]]));
$styleSourceSelections.set(
new Map([["box", { instanceId: "box", values: ["local"] }]])
);
-$selectedInstanceSelector.set(["box"]);
+$awareness.set({
+ pageId: "",
+ instanceSelector: ["box"],
+});
setProperty("accentColor")({ type: "keyword", value: "red" });
setProperty("alignContent")({ type: "keyword", value: "normal" });
diff --git a/apps/builder/app/builder/features/style-panel/sections/backgrounds/background-content.stories.tsx b/apps/builder/app/builder/features/style-panel/sections/backgrounds/background-content.stories.tsx
index 87fb272d02..9e204f6eb6 100644
--- a/apps/builder/app/builder/features/style-panel/sections/backgrounds/background-content.stories.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/backgrounds/background-content.stories.tsx
@@ -7,12 +7,12 @@ import {
import {
$breakpoints,
$selectedBreakpointId,
- $selectedInstanceSelector,
$styles,
$styleSourceSelections,
} from "~/shared/nano-states";
import { registerContainers } from "~/shared/sync";
import { BackgroundContent } from "./background-content";
+import { $awareness } from "~/shared/awareness";
const backgroundImage: StyleDecl = {
breakpointId: "base",
@@ -31,7 +31,10 @@ $styles.set(new Map([[getStyleDeclKey(backgroundImage), backgroundImage]]));
$styleSourceSelections.set(
new Map([["box", { instanceId: "box", values: ["local"] }]])
);
-$selectedInstanceSelector.set(["box"]);
+$awareness.set({
+ pageId: "",
+ instanceSelector: ["box"],
+});
export const BackgroundContentStory = () => {
const elementRef = useRef<HTMLDivElement>(null);
diff --git a/apps/builder/app/builder/features/style-panel/sections/backgrounds/backgrounds.stories.tsx b/apps/builder/app/builder/features/style-panel/sections/backgrounds/backgrounds.stories.tsx
index 5aefb988b0..c896495943 100644
--- a/apps/builder/app/builder/features/style-panel/sections/backgrounds/backgrounds.stories.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/backgrounds/backgrounds.stories.tsx
@@ -4,11 +4,11 @@ import { registerContainers } from "~/shared/sync";
import {
$breakpoints,
$selectedBreakpointId,
- $selectedInstanceSelector,
$styles,
$styleSourceSelections,
} from "~/shared/nano-states";
import { Section } from "./backgrounds";
+import { $awareness } from "~/shared/awareness";
const backgroundImage: StyleDecl = {
breakpointId: "base",
@@ -40,7 +40,10 @@ $styles.set(new Map([[getStyleDeclKey(backgroundImage), backgroundImage]]));
$styleSourceSelections.set(
new Map([["box", { instanceId: "box", values: ["local"] }]])
);
-$selectedInstanceSelector.set(["box"]);
+$awareness.set({
+ pageId: "",
+ instanceSelector: ["box"],
+});
const Panel = styled("div", {
width: theme.spacing[30],
diff --git a/apps/builder/app/builder/features/style-panel/sections/position/inset-control.stories.tsx b/apps/builder/app/builder/features/style-panel/sections/position/inset-control.stories.tsx
index c25ef4b85c..77db037e02 100644
--- a/apps/builder/app/builder/features/style-panel/sections/position/inset-control.stories.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/position/inset-control.stories.tsx
@@ -6,11 +6,11 @@ import { registerContainers } from "~/shared/sync";
import {
$breakpoints,
$selectedBreakpointId,
- $selectedInstanceSelector,
$styles,
$styleSources,
$styleSourceSelections,
} from "~/shared/nano-states";
+import { $awareness } from "~/shared/awareness";
const right: StyleDecl = {
breakpointId: "base",
@@ -41,7 +41,10 @@ $styles.set(new Map([[getStyleDeclKey(right), right]]));
$styleSourceSelections.set(
new Map([["box", { instanceId: "box", values: ["local"] }]])
);
-$selectedInstanceSelector.set(["box"]);
+$awareness.set({
+ pageId: "",
+ instanceSelector: ["box"],
+});
export const InsetControlComponent = () => {
return (
diff --git a/apps/builder/app/builder/features/style-panel/sections/transitions/transitions.stories.tsx b/apps/builder/app/builder/features/style-panel/sections/transitions/transitions.stories.tsx
index 2afdc3747d..eee6514016 100644
--- a/apps/builder/app/builder/features/style-panel/sections/transitions/transitions.stories.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/transitions/transitions.stories.tsx
@@ -3,13 +3,13 @@ import { getStyleDeclKey, StyleDecl } from "@webstudio-is/sdk";
import {
$breakpoints,
$selectedBreakpointId,
- $selectedInstanceSelector,
$styles,
$styleSources,
$styleSourceSelections,
} from "~/shared/nano-states";
import { registerContainers } from "~/shared/sync";
import { Section } from "./transitions";
+import { $awareness } from "~/shared/awareness";
const Panel = styled("div", {
width: theme.spacing[30],
@@ -50,7 +50,10 @@ $styles.set(
$styleSourceSelections.set(
new Map([["box", { instanceId: "box", values: ["local"] }]])
);
-$selectedInstanceSelector.set(["box"]);
+$awareness.set({
+ pageId: "",
+ instanceSelector: ["box"],
+});
export const Transitions = () => {
return (
diff --git a/apps/builder/app/builder/features/style-panel/shared/repeated-style.test.ts b/apps/builder/app/builder/features/style-panel/shared/repeated-style.test.ts
index 6d1c734c38..7dad39b4b3 100644
--- a/apps/builder/app/builder/features/style-panel/shared/repeated-style.test.ts
+++ b/apps/builder/app/builder/features/style-panel/shared/repeated-style.test.ts
@@ -20,7 +20,6 @@ import { parseCssFragment } from "./css-fragment";
import {
$breakpoints,
$selectedBreakpointId,
- $selectedInstanceSelector,
$styles,
$styleSources,
$styleSourceSelections,
@@ -28,6 +27,7 @@ import {
import { registerContainers } from "~/shared/sync";
import { setProperty } from "./use-style-data";
import type { ComputedStyleDecl } from "~/shared/style-object-model";
+import { $awareness } from "~/shared/awareness";
setEnv("*");
registerContainers();
@@ -35,7 +35,10 @@ registerContainers();
beforeEach(() => {
$breakpoints.set(new Map([["base", { id: "base", label: "" }]]));
$selectedBreakpointId.set("base");
- $selectedInstanceSelector.set(["box"]);
+ $awareness.set({
+ pageId: "",
+ instanceSelector: ["box"],
+ });
$styleSourceSelections.set(new Map());
$styleSources.set(new Map());
$styles.set(new Map());
diff --git a/apps/builder/app/builder/features/style-panel/style-source-section.test.ts b/apps/builder/app/builder/features/style-panel/style-source-section.test.ts
index 655fb94764..f6b065d5bd 100644
--- a/apps/builder/app/builder/features/style-panel/style-source-section.test.ts
+++ b/apps/builder/app/builder/features/style-panel/style-source-section.test.ts
@@ -6,7 +6,6 @@ import { registerContainers } from "~/shared/sync";
import {
$breakpoints,
$registeredComponentMetas,
- $selectedInstanceSelector,
$selectedStyleSources,
$styleSourceSelections,
$styleSources,
@@ -15,6 +14,7 @@ import {
$presetTokens,
addStyleSourceToInstance,
} from "./style-source-section";
+import { $awareness } from "~/shared/awareness";
enableMapSet();
registerContainers();
@@ -108,29 +108,32 @@ test("generate styles from preset tokens", () => {
});
test("add style source to instance", () => {
- $selectedInstanceSelector.set(["root"]);
+ $awareness.set({
+ pageId: "",
+ instanceSelector: ["body"],
+ });
$styleSources.set(new Map([["local1", { id: "local1", type: "local" }]]));
$styleSourceSelections.set(new Map());
$selectedStyleSources.set(new Map());
addStyleSourceToInstance("token1");
- expect($styleSourceSelections.get().get("root")).toEqual({
- instanceId: "root",
+ expect($styleSourceSelections.get().get("body")).toEqual({
+ instanceId: "body",
values: ["token1"],
});
- expect($selectedStyleSources.get().get("root")).toEqual("token1");
+ expect($selectedStyleSources.get().get("body")).toEqual("token1");
// put new style source last
addStyleSourceToInstance("local1");
- expect($styleSourceSelections.get().get("root")).toEqual({
- instanceId: "root",
+ expect($styleSourceSelections.get().get("body")).toEqual({
+ instanceId: "body",
values: ["token1", "local1"],
});
// put new token before local
addStyleSourceToInstance("token2");
- expect($styleSourceSelections.get().get("root")).toEqual({
- instanceId: "root",
+ expect($styleSourceSelections.get().get("body")).toEqual({
+ instanceId: "body",
values: ["token1", "token2", "local1"],
});
});
diff --git a/apps/builder/app/builder/features/workspace/workspace.tsx b/apps/builder/app/builder/features/workspace/workspace.tsx
index 90dca120e3..6a4407a855 100644
--- a/apps/builder/app/builder/features/workspace/workspace.tsx
+++ b/apps/builder/app/builder/features/workspace/workspace.tsx
@@ -6,12 +6,10 @@ import {
$scale,
$workspaceRect,
} from "~/builder/shared/nano-states";
-import {
- $selectedInstanceSelector,
- $textEditingInstanceSelector,
-} from "~/shared/nano-states";
+import { $textEditingInstanceSelector } from "~/shared/nano-states";
import { CanvasTools } from "./canvas-tools";
import { useSetCanvasWidth } from "../breakpoints";
+import { selectInstance } from "~/shared/awareness";
const workspaceStyle = css({
flexGrow: 1,
@@ -101,7 +99,7 @@ export const Workspace = ({ children, onTransitionEnd }: WorkspaceProps) => {
const workspaceRef = useMeasureWorkspace();
useSetCanvasWidth();
const handleWorkspaceClick = () => {
- $selectedInstanceSelector.set(undefined);
+ selectInstance(undefined);
$textEditingInstanceSelector.set(undefined);
};
diff --git a/apps/builder/app/builder/shared/commands.test.ts b/apps/builder/app/builder/shared/commands.test.ts
index 6bd54e628e..aa104991d1 100644
--- a/apps/builder/app/builder/shared/commands.test.ts
+++ b/apps/builder/app/builder/shared/commands.test.ts
@@ -5,11 +5,11 @@ import {
$instances,
$pages,
$registeredComponentMetas,
- $selectedInstanceSelector,
} from "~/shared/nano-states";
import { registerContainers } from "~/shared/sync";
import { emitCommand } from "./commands";
import { createDefaultPages } from "@webstudio-is/project-build";
+import { $awareness } from "~/shared/awareness";
registerContainers();
@@ -45,10 +45,13 @@ describe("deleteInstance", () => {
test("delete selected instance and select next one", () => {
$registeredComponentMetas.set(metas);
- $selectedInstanceSelector.set(["child2", "parent", "body"]);
+ $awareness.set({
+ pageId: "",
+ instanceSelector: ["child2", "parent", "body"],
+ });
$instances.set(threeChildInstances);
emitCommand("deleteInstance");
- expect($selectedInstanceSelector.get()).toEqual([
+ expect($awareness.get()?.instanceSelector).toEqual([
"child3",
"parent",
"body",
@@ -57,10 +60,13 @@ describe("deleteInstance", () => {
test("delete selected instance and select previous one", () => {
$registeredComponentMetas.set(metas);
- $selectedInstanceSelector.set(["child3", "parent", "body"]);
+ $awareness.set({
+ pageId: "",
+ instanceSelector: ["child3", "parent", "body"],
+ });
$instances.set(threeChildInstances);
emitCommand("deleteInstance");
- expect($selectedInstanceSelector.get()).toEqual([
+ expect($awareness.get()?.instanceSelector).toEqual([
"child2",
"parent",
"body",
@@ -68,7 +74,10 @@ describe("deleteInstance", () => {
});
test("delete selected instance and select parent one", () => {
- $selectedInstanceSelector.set(["child1", "parent", "body"]);
+ $awareness.set({
+ pageId: "",
+ instanceSelector: ["child1", "parent", "body"],
+ });
$registeredComponentMetas.set(metas);
// body
// parent
@@ -81,6 +90,6 @@ describe("deleteInstance", () => {
])
);
emitCommand("deleteInstance");
- expect($selectedInstanceSelector.get()).toEqual(["parent", "body"]);
+ expect($awareness.get()?.instanceSelector).toEqual(["parent", "body"]);
});
});
diff --git a/apps/builder/app/builder/shared/commands.ts b/apps/builder/app/builder/shared/commands.ts
index 0e363e86de..2ec3d98a0a 100644
--- a/apps/builder/app/builder/shared/commands.ts
+++ b/apps/builder/app/builder/shared/commands.ts
@@ -27,6 +27,7 @@ import {
toggleActiveSidebarPanel,
} from "./nano-states";
import { toast } from "@webstudio-is/design-system";
+import { selectInstance } from "~/shared/awareness";
const makeBreakpointCommand = <CommandName extends string>(
name: CommandName,
@@ -77,7 +78,7 @@ const deleteSelectedInstance = () => {
}
updateWebstudioData((data) => {
if (deleteInstanceMutable(data, selectedInstanceSelector)) {
- $selectedInstanceSelector.set(newSelectedInstanceSelector);
+ selectInstance(newSelectedInstanceSelector);
}
});
};
@@ -254,10 +255,7 @@ export const { emitCommand, subscribeCommands } = createCommandsEmitter({
value: newRootInstanceId,
});
// select new instance
- $selectedInstanceSelector.set([
- newRootInstanceId,
- ...parentInstanceSelector,
- ]);
+ selectInstance([newRootInstanceId, ...parentInstanceSelector]);
});
},
},
diff --git a/apps/builder/app/canvas/features/text-editor/text-editor.tsx b/apps/builder/app/canvas/features/text-editor/text-editor.tsx
index 51049f4fed..9040975b78 100644
--- a/apps/builder/app/canvas/features/text-editor/text-editor.tsx
+++ b/apps/builder/app/canvas/features/text-editor/text-editor.tsx
@@ -53,7 +53,6 @@ import { useEffectEvent } from "~/shared/hook-utils/effect-event";
import { findAllEditableInstanceSelector } from "~/shared/instance-utils";
import {
$registeredComponentMetas,
- $selectedInstanceSelector,
$textEditingInstanceSelector,
} from "~/shared/nano-states";
import {
@@ -62,7 +61,7 @@ import {
} from "~/shared/dom-utils";
import deepEqual from "fast-deep-equal";
import { setDataCollapsed } from "~/canvas/collapsed";
-import { $selectedPage } from "~/shared/awareness";
+import { $selectedPage, selectInstance } from "~/shared/awareness";
// import { AutoFocusPlugin } from "@lexical/react/LexicalAutoFocusPlugin";
const BindInstanceToNodePlugin = ({ refs }: { refs: Refs }) => {
@@ -985,7 +984,7 @@ export const TextEditor = ({
...args,
});
- $selectedInstanceSelector.set(editableInstanceSelectors[nextIndex]);
+ selectInstance(editableInstanceSelectors[nextIndex]);
break;
}
diff --git a/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx
index 2c1cdfd458..618a1e061f 100644
--- a/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx
+++ b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx
@@ -34,7 +34,6 @@ import {
$instances,
$registeredComponentMetas,
$selectedInstanceRenderState,
- $selectedInstanceSelector,
} from "~/shared/nano-states";
import { $textEditingInstanceSelector } from "~/shared/nano-states";
import {
@@ -45,7 +44,7 @@ import { setDataCollapsed } from "~/canvas/collapsed";
import { getIsVisuallyHidden } from "~/shared/visually-hidden";
import { serverSyncStore } from "~/shared/sync";
import { TextEditor } from "../text-editor";
-import { $selectedPage } from "~/shared/awareness";
+import { $selectedPage, selectInstance } from "~/shared/awareness";
import {
createInstanceChildrenElements,
type WebstudioComponentProps,
@@ -499,7 +498,7 @@ export const WebstudioComponentCanvas = forwardRef<
instanceId
);
$textEditingInstanceSelector.set(undefined);
- $selectedInstanceSelector.set(newSelectedSelector);
+ selectInstance(newSelectedSelector);
}}
/>
);
diff --git a/apps/builder/app/canvas/instance-selection.ts b/apps/builder/app/canvas/instance-selection.ts
index 594e3a8773..30a9a8f737 100644
--- a/apps/builder/app/canvas/instance-selection.ts
+++ b/apps/builder/app/canvas/instance-selection.ts
@@ -1,13 +1,10 @@
import { getInstanceSelectorFromElement } from "~/shared/dom-utils";
import { findClosestEditableInstanceSelector } from "~/shared/instance-utils";
-import {
- $instances,
- $registeredComponentMetas,
- $selectedInstanceSelector,
-} from "~/shared/nano-states";
+import { $instances, $registeredComponentMetas } from "~/shared/nano-states";
import { $textEditingInstanceSelector } from "~/shared/nano-states";
import { emitCommand } from "./shared/commands";
import { shallowEqual } from "shallow-equal";
+import { $awareness, selectInstance } from "~/shared/awareness";
const isElementBeingEdited = (element: Element) => {
if (element.closest("[contenteditable=true]")) {
@@ -49,8 +46,8 @@ export const subscribeInstanceSelection = ({
}
// Prevent unnecessary updates (2 clicks are registered before a double click)
- if (!shallowEqual(instanceSelector, $selectedInstanceSelector.get())) {
- $selectedInstanceSelector.set(instanceSelector);
+ if (!shallowEqual(instanceSelector, $awareness.get()?.instanceSelector)) {
+ selectInstance(instanceSelector);
}
},
{ passive: true, signal }
@@ -87,7 +84,7 @@ export const subscribeInstanceSelection = ({
// Prevent unnecessary updates (should already be selected during click)
if (!shallowEqual(instanceSelector, editableInstanceSelector)) {
- $selectedInstanceSelector.set(editableInstanceSelector);
+ selectInstance(editableInstanceSelector);
}
$textEditingInstanceSelector.set({
diff --git a/apps/builder/app/canvas/interceptor.ts b/apps/builder/app/canvas/interceptor.ts
index 358d15951c..78fb232cc5 100644
--- a/apps/builder/app/canvas/interceptor.ts
+++ b/apps/builder/app/canvas/interceptor.ts
@@ -4,14 +4,15 @@ import {
matchPathnamePattern,
tokenizePathnamePattern,
} from "~/builder/shared/url-pattern";
-import { $selectedPage } from "~/shared/awareness";
+import { $selectedPage, selectPage } from "~/shared/awareness";
import {
$dataSourceVariables,
$isPreviewMode,
$pages,
+ $selectedPageHash,
updateSystem,
} from "~/shared/nano-states";
-import { savePathInHistory, switchPage } from "~/shared/pages";
+import { savePathInHistory } from "~/shared/pages";
const isAbsoluteUrl = (href: string) => {
try {
@@ -58,7 +59,8 @@ const switchPageAndUpdateSystem = (href: string, formData?: FormData) => {
}
}
const search = Object.fromEntries(pageHref.searchParams);
- switchPage(page.id, pageHref.hash);
+ $selectedPageHash.set(pageHref.hash);
+ selectPage(page.id);
updateSystem(page, { params, search });
savePathInHistory(page.id, pageHref.pathname);
break;
diff --git a/apps/builder/app/canvas/shared/commands.ts b/apps/builder/app/canvas/shared/commands.ts
index 6ec958cf25..db6cfad3c6 100644
--- a/apps/builder/app/canvas/shared/commands.ts
+++ b/apps/builder/app/canvas/shared/commands.ts
@@ -15,6 +15,7 @@ import {
getActiveEditor,
hasSelectionFormat,
} from "../features/text-editor/toolbar-connector";
+import { selectInstance } from "~/shared/awareness";
export const { emitCommand, subscribeCommands } = createCommandsEmitter({
source: "canvas",
@@ -45,7 +46,7 @@ export const { emitCommand, subscribeCommands } = createCommandsEmitter({
// When an event is triggered from the Builder,
// the canvas element may be unfocused, so it's important to focus the element on the canvas.
element.focus();
- $selectedInstanceSelector.set(editableInstanceSelector);
+ selectInstance(editableInstanceSelector);
$textEditingInstanceSelector.set({
selector: editableInstanceSelector,
reason: "enter",
@@ -70,7 +71,7 @@ export const { emitCommand, subscribeCommands } = createCommandsEmitter({
return;
}
// unselect both instance and style source
- $selectedInstanceSelector.set(undefined);
+ selectInstance(undefined);
},
},
diff --git a/apps/builder/app/shared/awareness.ts b/apps/builder/app/shared/awareness.ts
index f54b591374..633b452c95 100644
--- a/apps/builder/app/shared/awareness.ts
+++ b/apps/builder/app/shared/awareness.ts
@@ -1,13 +1,19 @@
-import { atom, computed } from "nanostores";
-import { findPageByIdOrPath } from "@webstudio-is/sdk";
+import { atom, computed, onSet } from "nanostores";
+import { findPageByIdOrPath, Instance, type Page } from "@webstudio-is/sdk";
import { $pages } from "./nano-states/pages";
+import { $selectedInstanceSelector } from "./nano-states/instances";
type Awareness = {
- pageId: string;
+ pageId: Page["id"];
+ instanceSelector?: Instance["id"][];
};
export const $awareness = atom<undefined | Awareness>();
+onSet($awareness, ({ newValue }) => {
+ $selectedInstanceSelector.set(newValue?.instanceSelector);
+});
+
export const $selectedPage = computed(
[$pages, $awareness],
(pages, awareness) => {
@@ -17,3 +23,27 @@ export const $selectedPage = computed(
return findPageByIdOrPath(awareness.pageId, pages);
}
);
+
+export const selectPage = (pageId: Page["id"]) => {
+ const pages = $pages.get();
+ if (pages === undefined) {
+ return;
+ }
+ const page = findPageByIdOrPath(pageId, pages);
+ if (page === undefined) {
+ return;
+ }
+ $awareness.set({ pageId: page.id, instanceSelector: [page.rootInstanceId] });
+};
+
+export const selectInstance = (
+ instanceSelector: undefined | Instance["id"][]
+) => {
+ const awareness = $awareness.get();
+ if (awareness) {
+ $awareness.set({
+ pageId: awareness.pageId,
+ instanceSelector,
+ });
+ }
+};
diff --git a/apps/builder/app/shared/copy-paste/plugin-instance.test.ts b/apps/builder/app/shared/copy-paste/plugin-instance.test.ts
index 4eb12799f7..fd2d65b34d 100644
--- a/apps/builder/app/shared/copy-paste/plugin-instance.test.ts
+++ b/apps/builder/app/shared/copy-paste/plugin-instance.test.ts
@@ -19,7 +19,6 @@ import * as baseComponentMetas from "@webstudio-is/sdk-components-react/metas";
import { registerContainers } from "../sync";
import {
$instances,
- $selectedInstanceSelector,
$dataSources,
$pages,
$project,
@@ -28,7 +27,7 @@ import {
} from "../nano-states";
import { onCopy, onCut, onPaste } from "./plugin-instance";
import { createDefaultPages } from "@webstudio-is/project-build";
-import { $awareness } from "../awareness";
+import { $awareness, selectInstance } from "../awareness";
const expectString = expect.any(String) as unknown as string;
@@ -97,9 +96,9 @@ describe("paste target", () => {
test("is inside selected instance", () => {
$instances.set(instances);
- $selectedInstanceSelector.set(["box1", "body0"]);
+ selectInstance(["box1", "body0"]);
const clipboardData = onCopy() ?? "";
- $selectedInstanceSelector.set(["box2", "body0"]);
+ selectInstance(["box2", "body0"]);
onPaste(clipboardData);
const instancesDifference = getMapDifference(instances, $instances.get());
@@ -114,7 +113,7 @@ describe("paste target", () => {
test("is after selected instance when same as copied", () => {
$instances.set(instances);
- $selectedInstanceSelector.set(["box1", "body0"]);
+ selectInstance(["box1", "body0"]);
onPaste(onCopy() ?? "");
const instancesDifference = getMapDifference(instances, $instances.get());
@@ -191,9 +190,9 @@ describe("data sources", () => {
$instances.set(instances);
$dataSources.set(dataSources);
$props.set(props);
- $selectedInstanceSelector.set(["box1", "body0"]);
+ selectInstance(["box1", "body0"]);
const clipboardData = onCopy() ?? "";
- $selectedInstanceSelector.set(["body0"]);
+ selectInstance(["body0"]);
onPaste(clipboardData);
const instancesDifference = getMapDifference(instances, $instances.get());
@@ -260,9 +259,9 @@ describe("data sources", () => {
$instances.set(instances);
$props.set(props);
$dataSources.set(dataSources);
- $selectedInstanceSelector.set(["box2", "box1", "body0"]);
+ selectInstance(["box2", "box1", "body0"]);
const clipboardData = onCopy() ?? "";
- $selectedInstanceSelector.set(["body0"]);
+ selectInstance(["body0"]);
onPaste(clipboardData);
const instancesDifference = getMapDifference(instances, $instances.get());
@@ -307,9 +306,9 @@ describe("data sources", () => {
$instances.set(instances);
$props.set(props);
$dataSources.set(dataSources);
- $selectedInstanceSelector.set(["box2", "box1", "body0"]);
+ selectInstance(["box2", "box1", "body0"]);
const clipboardData = onCopy() ?? "";
- $selectedInstanceSelector.set(["box1", "body0"]);
+ selectInstance(["box1", "body0"]);
onPaste(clipboardData);
const instancesDifference = getMapDifference(instances, $instances.get());
@@ -388,9 +387,9 @@ describe("data sources", () => {
$instances.set(instances);
$props.set(props);
$dataSources.set(dataSources);
- $selectedInstanceSelector.set(["list", "body"]);
+ selectInstance(["list", "body"]);
const clipboardData = onCopy() ?? "";
- $selectedInstanceSelector.set(["body"]);
+ selectInstance(["body"]);
onPaste(clipboardData);
const instancesDifference = getMapDifference(instances, $instances.get());
@@ -445,7 +444,7 @@ test("when paste into copied instance insert after it", () => {
createInstance("box", "Box", []),
])
);
- $selectedInstanceSelector.set(["box", "body"]);
+ selectInstance(["box", "body"]);
const clipboardData = onCopy() ?? "";
onPaste(clipboardData);
@@ -471,9 +470,9 @@ test("prevent pasting portal into own descendants", () => {
createInstance("box", "Box", []),
]);
$instances.set(instances);
- $selectedInstanceSelector.set(["portal", "body"]);
+ selectInstance(["portal", "body"]);
const clipboardData = onCopy() ?? "";
- $selectedInstanceSelector.set(["box", "fragment", "portal", "body"]);
+ selectInstance(["box", "fragment", "portal", "body"]);
onPaste(clipboardData);
expect($instances.get()).toEqual(instances);
});
@@ -493,9 +492,9 @@ test("prevent pasting portal into copy of it", () => {
createInstance("fragment", "Fragment", []),
]);
$instances.set(instances);
- $selectedInstanceSelector.set(["portal1", "body"]);
+ selectInstance(["portal1", "body"]);
const clipboardData = onCopy() ?? "";
- $selectedInstanceSelector.set(["portal2", "body"]);
+ selectInstance(["portal2", "body"]);
onPaste(clipboardData);
expect($instances.get()).toEqual(instances);
});
@@ -514,9 +513,9 @@ test("insert portal into its sibling", () => {
createInstance("sibling", "Box", []),
])
);
- $selectedInstanceSelector.set(["portal", "body"]);
+ selectInstance(["portal", "body"]);
const clipboardData = onCopy() ?? "";
- $selectedInstanceSelector.set(["sibling", "body"]);
+ selectInstance(["sibling", "body"]);
onPaste(clipboardData);
expect($instances.get()).toEqual(
@@ -548,9 +547,9 @@ test("insert into portal fragment when portal is a target", () => {
createInstance("box", "Box", []),
])
);
- $selectedInstanceSelector.set(["box", "body"]);
+ selectInstance(["box", "body"]);
const clipboardData = onCopy() ?? "";
- $selectedInstanceSelector.set(["portal", "body"]);
+ selectInstance(["portal", "body"]);
// fragment not exists
const prevInstances = $instances.get();
@@ -629,9 +628,9 @@ test("inline data source not available in portal when copy paste inside the port
},
]);
$props.set(props);
- $selectedInstanceSelector.set(["box", "body"]);
+ selectInstance(["box", "body"]);
const clipboardData = onCut() ?? "";
- $selectedInstanceSelector.set(["fragment", "portal", "body"]);
+ selectInstance(["fragment", "portal", "body"]);
onPaste(clipboardData);
expect($instances.get()).toEqual(
toMap([
diff --git a/apps/builder/app/shared/instance-utils.ts b/apps/builder/app/shared/instance-utils.ts
index 6d0f3f7f0d..2ffc4345c5 100644
--- a/apps/builder/app/shared/instance-utils.ts
+++ b/apps/builder/app/shared/instance-utils.ts
@@ -63,7 +63,7 @@ import { humanizeString } from "./string-utils";
import { serverSyncStore } from "./sync";
import { setDifference, setUnion } from "./shim";
import { breakCyclesMutable, findCycles } from "@webstudio-is/project-build";
-import { $selectedPage } from "./awareness";
+import { $selectedPage, selectInstance } from "./awareness";
export const updateWebstudioData = (mutate: (data: WebstudioData) => void) => {
serverSyncStore.createTransaction(
@@ -622,7 +622,7 @@ export const insertTemplateData = (
}
});
- $selectedInstanceSelector.set([rootInstanceId, ...dropTarget.parentSelector]);
+ selectInstance([rootInstanceId, ...dropTarget.parentSelector]);
};
export const getComponentTemplateData = (component: string) => {
@@ -687,10 +687,7 @@ export const reparentInstance = (
} else {
newParent.children.splice(reparentDropTarget.position, 0, newChild);
}
- $selectedInstanceSelector.set([
- newRootInstanceId,
- ...reparentDropTarget.parentSelector,
- ]);
+ selectInstance([newRootInstanceId, ...reparentDropTarget.parentSelector]);
});
};
diff --git a/apps/builder/app/shared/pages/use-switch-page.ts b/apps/builder/app/shared/pages/use-switch-page.ts
index d820d6d3ab..e0d8ed6fd3 100644
--- a/apps/builder/app/shared/pages/use-switch-page.ts
+++ b/apps/builder/app/shared/pages/use-switch-page.ts
@@ -1,35 +1,15 @@
import { useEffect } from "react";
import { useStore } from "@nanostores/react";
import { useNavigate } from "@remix-run/react";
-import { findPageByIdOrPath, type Page } from "@webstudio-is/sdk";
import {
$authToken,
$pages,
$project,
$selectedPageHash,
- $selectedInstanceSelector,
$isPreviewMode,
} from "~/shared/nano-states";
import { builderPath } from "~/shared/router-utils";
-import { $awareness, $selectedPage } from "../awareness";
-
-export const switchPage = (pageId: Page["id"], pageHash: string = "") => {
- const pages = $pages.get();
-
- if (pages === undefined) {
- return;
- }
-
- const page = findPageByIdOrPath(pageId, pages);
-
- if (page === undefined) {
- return;
- }
-
- $selectedPageHash.set(pageHash);
- $awareness.set({ pageId: page.id });
- $selectedInstanceSelector.set([page.rootInstanceId]);
-};
+import { $selectedPage, selectPage } from "../awareness";
const setPageStateFromUrl = () => {
const searchParams = new URLSearchParams(window.location.search);
@@ -38,11 +18,11 @@ const setPageStateFromUrl = () => {
return;
}
const pageId = searchParams.get("pageId") ?? pages.homePage.id;
- const pageHash = searchParams.get("pageHash") ?? undefined;
$isPreviewMode.set(searchParams.get("mode") === "preview");
- switchPage(pageId, pageHash);
+ $selectedPageHash.set(searchParams.get("pageHash") ?? "");
+ selectPage(pageId);
};
/**