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.

Use instances index to compute selected instance (#839)

Bogdan Chadkin57a43cda6c39
diff --git a/apps/designer/app/canvas/canvas.tsx b/apps/designer/app/canvas/canvas.tsx
index cbfb0d6ea9..c16215702d 100644
--- a/apps/designer/app/canvas/canvas.tsx
+++ b/apps/designer/app/canvas/canvas.tsx
@@ -1,4 +1,5 @@
import { useCallback, useMemo, useState } from "react";
+import { useStore } from "@nanostores/react";
import store from "immerhin";
import type { CanvasData } from "@webstudio-is/project";
import {
@@ -20,13 +21,13 @@ import {
usePublishTextEditingInstanceId,
useReparentInstance,
useUnselectInstance,
- useUpdateSelectedInstance,
} from "./shared/instance";
import { useManageDesignModeStyles, GlobalStyles } from "./shared/styles";
import { useTrackSelectedElement } from "./shared/use-track-selected-element";
import { WrapperComponentDev } from "./features/wrapper-component";
import {
rootInstanceContainer,
+ selectedInstanceStore,
useBreakpoints,
useRootInstance,
useSetBreakpoints,
@@ -35,6 +36,7 @@ import {
useSetRootInstance,
useSetStyles,
useSubscribeScrollState,
+ useSubscribeSelectedInstance,
} from "~/shared/nano-states";
import { usePublishScrollState } from "./shared/use-publish-scroll-state";
import { useDragAndDrop } from "./shared/use-drag-drop";
@@ -42,7 +44,6 @@ import { utils } from "@webstudio-is/project";
import { useSubscribeDesignerReady } from "./shared/use-designer-ready";
import type { Asset } from "@webstudio-is/asset-uploader";
import { useInstanceCopyPaste } from "~/shared/copy-paste";
-import { useSelectedInstance } from "./shared/nano-states";
import { customComponents } from "./custom-components";
import { useHoveredInstanceConnector } from "./hovered-instance-connector";
@@ -98,7 +99,7 @@ const useAssets = (initialAssets: Array<Asset>) => {
};
const useCopyPaste = () => {
- const [instance] = useSelectedInstance();
+ const instance = useStore(selectedInstanceStore);
const allUserProps = useAllUserProps();
const selectedInstanceData = useMemo(
@@ -126,11 +127,11 @@ const useCopyPaste = () => {
const DesignMode = () => {
useManageDesignModeStyles();
usePublishSelectedInstanceData();
+ useSubscribeSelectedInstance();
useInsertInstance();
useReparentInstance();
useDeleteInstance();
useTrackSelectedElement();
- useUpdateSelectedInstance();
useUnselectInstance();
usePublishScrollState();
useSubscribeScrollState();
diff --git a/apps/designer/app/canvas/features/wrapper-component/wrapper-component.tsx b/apps/designer/app/canvas/features/wrapper-component/wrapper-component.tsx
index 355284fbf1..d09b11d072 100644
--- a/apps/designer/app/canvas/features/wrapper-component/wrapper-component.tsx
+++ b/apps/designer/app/canvas/features/wrapper-component/wrapper-component.tsx
@@ -13,10 +13,10 @@ import {
} from "@webstudio-is/react-sdk";
import { shallowComputed } from "~/shared/store-utils";
import {
+ selectedInstanceIdStore,
stylesIndexStore,
useTextEditingInstanceId,
} from "~/shared/nano-states";
-import { useSelectedInstance } from "~/canvas/shared/nano-states";
import { useCssRules } from "~/canvas/shared/styles";
import { publish } from "~/shared/pubsub";
import { SelectedInstanceConnector } from "./selected-instance-connector";
@@ -70,7 +70,7 @@ export const WrapperComponentDev = ({
const [editingInstanceId, setTextEditingInstanceId] =
useTextEditingInstanceId();
- const [selectedInstance] = useSelectedInstance();
+ const selectedInstanceId = useStore(selectedInstanceIdStore);
const allUserProps = useAllUserProps();
const instanceProps = allUserProps[instance.id];
@@ -119,7 +119,7 @@ export const WrapperComponentDev = ({
const instanceElement = (
<>
- {selectedInstance?.id === instance.id && (
+ {selectedInstanceId === instance.id && (
<SelectedInstanceConnector
instanceElementRef={instanceElementRef}
instance={instance}
diff --git a/apps/designer/app/canvas/shared/instance.ts b/apps/designer/app/canvas/shared/instance.ts
index d2c3ad7be8..c956badefc 100644
--- a/apps/designer/app/canvas/shared/instance.ts
+++ b/apps/designer/app/canvas/shared/instance.ts
@@ -1,4 +1,5 @@
import { useEffect } from "react";
+import { useStore } from "@nanostores/react";
import {
type Instance,
type PropsItem,
@@ -14,9 +15,9 @@ import {
type SelectedInstanceData,
} from "@webstudio-is/project";
import store from "immerhin";
-import { useSelectedInstance } from "./nano-states";
import {
rootInstanceContainer,
+ selectedInstanceIdStore,
useRootInstance,
useTextEditingInstanceId,
} from "~/shared/nano-states";
@@ -68,8 +69,8 @@ export const findInsertLocation = (
};
export const useInsertInstance = () => {
- const [selectedInstance, setSelectedInstance] = useSelectedInstance();
useSubscribe("insertInstance", ({ instance, dropTarget, props }) => {
+ const selectedInstanceId = selectedInstanceIdStore.get();
store.createTransaction(
[rootInstanceContainer, allUserPropsContainer],
(rootInstance, allUserProps) => {
@@ -79,10 +80,10 @@ export const useInsertInstance = () => {
const hasInserted = utils.tree.insertInstanceMutable(
rootInstance,
instance,
- dropTarget ?? findInsertLocation(rootInstance, selectedInstance?.id)
+ dropTarget ?? findInsertLocation(rootInstance, selectedInstanceId)
);
if (hasInserted) {
- setSelectedInstance(instance);
+ selectedInstanceIdStore.set(instance.id);
}
if (props !== undefined) {
allUserProps[instance.id] = props;
@@ -93,9 +94,8 @@ export const useInsertInstance = () => {
};
export const useReparentInstance = () => {
- const [selectedInstance, setSelectedInstance] = useSelectedInstance();
-
useSubscribe("reparentInstance", ({ instanceId, dropTarget }) => {
+ const selectedInstanceId = selectedInstanceIdStore.get();
store.createTransaction([rootInstanceContainer], (rootInstance) => {
if (rootInstance === undefined) {
return;
@@ -110,19 +110,17 @@ export const useReparentInstance = () => {
const rootInstance = rootInstanceContainer.get();
// Make the drag item the selected instance
- if (selectedInstance?.id !== instanceId && rootInstance !== undefined) {
- setSelectedInstance(
- utils.tree.findInstanceById(rootInstance, instanceId)
- );
+ if (selectedInstanceId !== instanceId && rootInstance !== undefined) {
+ selectedInstanceIdStore.set(instanceId);
}
});
};
export const useDeleteInstance = () => {
const [rootInstance] = useRootInstance();
- const [selectedInstance, setSelectedInstance] = useSelectedInstance();
useSubscribe("deleteInstance", ({ id }) => {
- if (rootInstance !== undefined && selectedInstance !== undefined) {
+ const selectedInstanceId = selectedInstanceIdStore.get();
+ if (rootInstance !== undefined && selectedInstanceId !== undefined) {
// @todo tell user they can't delete root
if (id === rootInstance.id) {
return;
@@ -134,7 +132,7 @@ export const useDeleteInstance = () => {
parentInstance,
id
);
- setSelectedInstance(siblingInstance || parentInstance);
+ selectedInstanceIdStore.set(siblingInstance?.id ?? parentInstance.id);
}
}
// @todo deleting instance should involve also deleting it's props
@@ -155,45 +153,22 @@ export const useDeleteInstance = () => {
};
export const usePublishSelectedInstanceData = () => {
- const [instance] = useSelectedInstance();
+ const selectedInstanceId = useStore(selectedInstanceIdStore);
useEffect(() => {
// Unselects the instance by `undefined`
- if (instance === undefined) {
+ if (selectedInstanceId === undefined) {
publish({
type: "selectInstance",
payload: undefined,
});
}
- }, [instance]);
-};
-
-/**
- * We need to set the selected instance after a any root instance update,
- * because anything that we change on the selected instance is actually done on the root, so
- * when we run "undo", root is going to be undone but not the selected instance, unless we update it here.
- */
-export const useUpdateSelectedInstance = () => {
- const [rootInstance] = useRootInstance();
- const [selectedInstance, setSelectedInstance] = useSelectedInstance();
-
- // When selected instance or root instance changes - we want to make sure the instance with that id still exists in the root.
- useEffect(() => {
- let instance;
- if (rootInstance !== undefined && selectedInstance?.id) {
- instance = utils.tree.findInstanceById(rootInstance, selectedInstance.id);
- }
- // When it's a new inserted instance, it will be undefined, so we can't set it to undefined and remove it.
- if (instance !== undefined) {
- setSelectedInstance(instance);
- }
- }, [rootInstance, selectedInstance, setSelectedInstance]);
+ }, [selectedInstanceId]);
};
export const useUnselectInstance = () => {
- const [, setSelectedInstance] = useSelectedInstance();
useSubscribe("unselectInstance", () => {
- setSelectedInstance(undefined);
+ selectedInstanceIdStore.set(undefined);
});
};
diff --git a/apps/designer/app/canvas/shared/nano-states.ts b/apps/designer/app/canvas/shared/nano-states.ts
deleted file mode 100644
index b080cfaa3d..0000000000
--- a/apps/designer/app/canvas/shared/nano-states.ts
+++ /dev/null
@@ -1,11 +0,0 @@
-import { atom, type WritableAtom } from "nanostores";
-import { useStore } from "@nanostores/react";
-import { type Instance } from "@webstudio-is/react-sdk";
-
-const useValue = <T>(atom: WritableAtom<T>) => {
- const value = useStore(atom);
- return [value, atom.set] as const;
-};
-
-export const selectedInstanceContainer = atom<Instance | undefined>();
-export const useSelectedInstance = () => useValue(selectedInstanceContainer);
diff --git a/apps/designer/app/canvas/shared/styles.ts b/apps/designer/app/canvas/shared/styles.ts
index 12e9aa86fc..04691f113b 100644
--- a/apps/designer/app/canvas/shared/styles.ts
+++ b/apps/designer/app/canvas/shared/styles.ts
@@ -2,6 +2,7 @@ import { useEffect } from "react";
import { useSubscribe } from "~/shared/pubsub";
import { addGlobalRules, getPresetStyleRules } from "@webstudio-is/project";
import {
+ selectedInstanceIdStore,
useBreakpoints,
useDesignTokens,
usePresetStyles,
@@ -29,7 +30,6 @@ import {
import { useIsomorphicLayoutEffect } from "react-use";
import type { Asset } from "@webstudio-is/asset-uploader";
import { tokensToStyle } from "~/designer/shared/design-tokens-manager";
-import { useSelectedInstance } from "./nano-states";
const cssEngine = createCssEngine({ name: "user-styles" });
@@ -235,11 +235,11 @@ const setCssVar = (id: string, property: string, value?: StyleValue) => {
};
const useUpdateStyle = () => {
- const [selectedInstance] = useSelectedInstance();
useSubscribe("updateStyle", ({ id, updates }) => {
+ const selectedInstanceId = selectedInstanceIdStore.get();
// Only update styles if they match the selected instance
// It can potentially happen that we selected a difference instance right after we changed the style in style panel.
- if (id !== selectedInstance?.id) {
+ if (id !== selectedInstanceId) {
return;
}
diff --git a/apps/designer/app/canvas/shared/use-shortcuts.ts b/apps/designer/app/canvas/shared/use-shortcuts.ts
index 5304d15a74..e572e64bf3 100644
--- a/apps/designer/app/canvas/shared/use-shortcuts.ts
+++ b/apps/designer/app/canvas/shared/use-shortcuts.ts
@@ -3,8 +3,11 @@ import store from "immerhin";
import { type Instance, getComponentMeta } from "@webstudio-is/react-sdk";
import { shortcuts, options } from "~/shared/shortcuts";
import { publish, useSubscribe } from "~/shared/pubsub";
-import { useSelectedInstance } from "./nano-states";
-import { useTextEditingInstanceId } from "~/shared/nano-states";
+import {
+ selectedInstanceIdStore,
+ selectedInstanceStore,
+ useTextEditingInstanceId,
+} from "~/shared/nano-states";
import { type SelectedInstanceData } from "@webstudio-is/project";
declare module "~/shared/pubsub" {
@@ -68,16 +71,16 @@ const publishCancelCurrentDrag = () => {
};
export const useShortcuts = () => {
- const [selectedInstance, setSelectedInstance] = useSelectedInstance();
const [editingInstanceId, setEditingInstanceId] = useTextEditingInstanceId();
const publishDeleteInstance = () => {
- if (selectedInstance === undefined) {
+ const selectedInstanceId = selectedInstanceIdStore.get();
+ if (selectedInstanceId === undefined) {
return;
}
publish({
type: "deleteInstance",
- payload: { id: selectedInstance.id },
+ payload: { id: selectedInstanceId },
});
};
@@ -102,7 +105,8 @@ export const useShortcuts = () => {
useHotkeys(
"esc",
() => {
- if (selectedInstance === undefined) {
+ const selectedInstanceId = selectedInstanceIdStore.get();
+ if (selectedInstanceId === undefined) {
return;
}
// Since we are in text editing mode, we want to first exit that mode without unselecting the instance.
@@ -110,16 +114,17 @@ export const useShortcuts = () => {
setEditingInstanceId(undefined);
return;
}
- setSelectedInstance(undefined);
+ selectedInstanceIdStore.set(undefined);
publish({ type: "selectInstance" });
},
{ ...options, enableOnContentEditable: true, enableOnTags: [...inputTags] },
- [selectedInstance, editingInstanceId]
+ [editingInstanceId]
);
useHotkeys(
"enter",
(event) => {
+ const selectedInstance = selectedInstanceStore.get();
if (selectedInstance === undefined) {
return;
}
@@ -131,7 +136,7 @@ export const useShortcuts = () => {
}
},
options,
- [selectedInstance, setEditingInstanceId]
+ [setEditingInstanceId]
);
useHotkeys(shortcuts.undo, shortcutHandlerMap.undo, options, []);
diff --git a/apps/designer/app/canvas/shared/use-track-selected-element.ts b/apps/designer/app/canvas/shared/use-track-selected-element.ts
index d76668ec6b..b4963b6bf5 100644
--- a/apps/designer/app/canvas/shared/use-track-selected-element.ts
+++ b/apps/designer/app/canvas/shared/use-track-selected-element.ts
@@ -1,12 +1,12 @@
-import { useCallback, useEffect, useRef } from "react";
+import { useEffect, useRef } from "react";
+import { useStore } from "@nanostores/react";
import {
type Instance,
getComponentMeta,
getComponentNames,
} from "@webstudio-is/react-sdk";
-import { useSubscribe } from "~/shared/pubsub";
-import { useSelectedInstance } from "./nano-states";
import {
+ selectedInstanceIdStore,
useRootInstance,
useTextEditingInstanceId,
} from "~/shared/nano-states";
@@ -24,32 +24,20 @@ const eventOptions = {
};
export const useTrackSelectedElement = () => {
- const [selectedInstance, setSelectedInstance] = useSelectedInstance();
+ const selectedInstanceId = useStore(selectedInstanceIdStore);
const [editingInstanceId, setEditingInstanceId] = useTextEditingInstanceId();
const editingInstanceIdRef = useRef(editingInstanceId);
editingInstanceIdRef.current = editingInstanceId;
const [rootInstance] = useRootInstance();
- const selectInstance = useCallback(
- (id) => {
- if (rootInstance === undefined) {
- return;
- }
- const instance = utils.tree.findInstanceById(rootInstance, id);
- setSelectedInstance(instance);
- },
- [setSelectedInstance, rootInstance]
- );
-
- useSubscribe("selectInstanceById", selectInstance);
useEffect(() => {
if (
editingInstanceIdRef.current !== undefined &&
- selectedInstance?.id !== editingInstanceIdRef.current
+ selectedInstanceId !== editingInstanceIdRef.current
) {
setEditingInstanceId(undefined);
}
- }, [selectedInstance, setEditingInstanceId]);
+ }, [selectedInstanceId, setEditingInstanceId]);
useEffect(() => {
const handleClick = (event: MouseEvent) => {
@@ -95,7 +83,7 @@ export const useTrackSelectedElement = () => {
parent &&
getComponentMeta(parent.component).type === "rich-text"
) {
- selectInstance(parent.id);
+ selectedInstanceIdStore.set(parent.id);
setEditingInstanceId(parent.id);
}
return;
@@ -106,7 +94,7 @@ export const useTrackSelectedElement = () => {
}
}
- selectInstance(id);
+ selectedInstanceIdStore.set(id);
};
window.addEventListener("click", handleClick, eventOptions);
@@ -114,5 +102,5 @@ export const useTrackSelectedElement = () => {
return () => {
window.removeEventListener("click", handleClick);
};
- }, [selectInstance, setEditingInstanceId, rootInstance]);
+ }, [setEditingInstanceId, rootInstance]);
};
diff --git a/apps/designer/app/designer/designer.tsx b/apps/designer/app/designer/designer.tsx
index 56d91c7762..c3aafc122a 100644
--- a/apps/designer/app/designer/designer.tsx
+++ b/apps/designer/app/designer/designer.tsx
@@ -37,6 +37,7 @@ import {
useDragAndDropState,
useIsPreviewMode,
useRootInstance,
+ useSubscribeSelectedInstance,
} from "~/shared/nano-states";
import { useClientSettings } from "./shared/client-settings";
import { Navigator } from "./features/sidebar-left";
@@ -311,6 +312,7 @@ export const Designer = ({
const [dragAndDropState] = useDragAndDropState();
useSubscribeCanvasReady(publish);
useCopyPaste(publish);
+ useSubscribeSelectedInstance();
const iframeRefCallback = useCallback(
(ref) => {
diff --git a/apps/designer/app/shared/nano-states/nano-states.ts b/apps/designer/app/shared/nano-states/nano-states.ts
index b76b6c5d95..2acc448f4a 100644
--- a/apps/designer/app/shared/nano-states/nano-states.ts
+++ b/apps/designer/app/shared/nano-states/nano-states.ts
@@ -1,3 +1,4 @@
+import { useEffect } from "react";
import { atom, computed, type WritableAtom } from "nanostores";
import { useStore } from "@nanostores/react";
import { Instance, PresetStyles, Styles } from "@webstudio-is/react-sdk";
@@ -7,6 +8,7 @@ import type {
} from "~/canvas/shared/use-drag-drop";
import type { Breakpoint } from "@webstudio-is/css-data";
import type { DesignToken } from "@webstudio-is/design-tokens";
+import { subscribe } from "~/shared/pubsub";
import { useSyncInitializeOnce } from "../hook-utils";
const useValue = <T>(atom: WritableAtom<T>) => {
@@ -21,6 +23,26 @@ export const useSetRootInstance = (root: Instance) => {
rootInstanceContainer.set(root);
});
};
+export const instancesIndexStore = computed(
+ rootInstanceContainer,
+ (rootInstance) => {
+ const instancesById = new Map<Instance["id"], Instance>();
+ const traverseInstances = (instance: Instance) => {
+ instancesById.set(instance.id, instance);
+ for (const child of instance.children) {
+ if (child.type === "instance") {
+ traverseInstances(child);
+ }
+ }
+ };
+ if (rootInstance !== undefined) {
+ traverseInstances(rootInstance);
+ }
+ return {
+ instancesById,
+ };
+ }
+);
export const presetStylesContainer = atom<PresetStyles>([]);
export const usePresetStyles = () => useValue(presetStylesContainer);
@@ -79,6 +101,26 @@ export const useSetDesignTokens = (designTokens: DesignToken[]) => {
});
};
+export const selectedInstanceIdStore = atom<undefined | Instance["id"]>(
+ undefined
+);
+export const selectedInstanceStore = computed(
+ [instancesIndexStore, selectedInstanceIdStore],
+ (instancesIndex, selectedInstanceId) => {
+ if (selectedInstanceId === undefined) {
+ return;
+ }
+ return instancesIndex.instancesById.get(selectedInstanceId);
+ }
+);
+export const useSubscribeSelectedInstance = () => {
+ useEffect(() => {
+ return subscribe("selectInstanceById", (id) => {
+ selectedInstanceIdStore.set(id);
+ });
+ }, []);
+};
+
const isPreviewModeContainer = atom<boolean>(false);
export const useIsPreviewMode = () => useValue(isPreviewModeContainer);