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.

Subscribe selected instance for component hooks (#2150)

Bogdan Chadkin6b5cd3303305
diff --git a/apps/builder/app/builder/features/inspector/inspector.tsx b/apps/builder/app/builder/features/inspector/inspector.tsx
index af2e369a25..a7aeca3eb4 100644
--- a/apps/builder/app/builder/features/inspector/inspector.tsx
+++ b/apps/builder/app/builder/features/inspector/inspector.tsx
@@ -73,7 +73,7 @@ export const Inspector = ({ publish, navigatorLayout }: InspectorProps) => {
const metas = useStore(registeredComponentMetasStore);
if (navigatorLayout === "docked" && isDragging) {
- return <NavigatorTree publish={publish} />;
+ return <NavigatorTree />;
}
if (selectedInstance === undefined) {
diff --git a/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsx b/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsx
index 586fb014bb..befbc99efe 100644
--- a/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsx
+++ b/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsx
@@ -21,7 +21,7 @@ export const Navigator = ({ isClosable, onClose, publish }: NavigatorProps) => {
suffix={isClosable && <CloseButton onClick={() => onClose?.()} />}
/>
<Flex grow direction="column" justify="end">
- <NavigatorTree publish={publish} />
+ <NavigatorTree />
<Separator />
<CssPreview />
</Flex>
diff --git a/apps/builder/app/builder/shared/navigator-tree.tsx b/apps/builder/app/builder/shared/navigator-tree.tsx
index 156eb56cbe..4a5a8ca57c 100644
--- a/apps/builder/app/builder/shared/navigator-tree.tsx
+++ b/apps/builder/app/builder/shared/navigator-tree.tsx
@@ -22,10 +22,9 @@ import {
isInstanceDetachable,
getComponentTemplateData,
} from "~/shared/instance-utils";
-import type { Publish } from "~/shared/pubsub";
import { InstanceTree } from "./tree";
-export const NavigatorTree = ({ publish }: { publish: Publish }) => {
+export const NavigatorTree = () => {
const selectedInstanceSelector = useStore(selectedInstanceSelectorStore);
const rootInstance = useStore(rootInstanceStore);
const instances = useStore(instancesStore);
@@ -108,50 +107,17 @@ export const NavigatorTree = ({ publish }: { publish: Publish }) => {
[setState]
);
- const handleSelect = useCallback(
- (instanceSelector: InstanceSelector) => {
- // TreeNode is refocused during "delete" hot key here https://github.com/webstudio-is/webstudio-builder/blob/5935d7818fba3739e4f16fe710ea468bf9d0ac78/packages/design-system/src/components/tree/tree.tsx#L435
- // and then focus cause handleSelect to be called with the same instanceSelector
- // This avoids additional rerender on node delete
- if (
- shallowEqual(selectedInstanceSelectorStore.get(), instanceSelector) ===
- false
- ) {
- const instances = instancesStore.get();
- const previousInstanceSelector = selectedInstanceSelectorStore.get();
- if (previousInstanceSelector) {
- publish({
- type: "emitComponentHook",
- payload: {
- name: "onNavigatorUnselect",
- data: {
- instancePath: previousInstanceSelector.flatMap((id) => {
- const instance = instances.get(id);
- return instance ? [instance] : [];
- }),
- },
- },
- });
- }
- selectedInstanceSelectorStore.set(instanceSelector);
- textEditingInstanceSelectorStore.set(undefined);
- selectedStyleSourceSelectorStore.set(undefined);
- publish({
- type: "emitComponentHook",
- payload: {
- name: "onNavigatorSelect",
- data: {
- instancePath: instanceSelector.flatMap((id) => {
- const instance = instances.get(id);
- return instance ? [instance] : [];
- }),
- },
- },
- });
- }
- },
- [publish]
- );
+ const handleSelect = useCallback((instanceSelector: InstanceSelector) => {
+ // TreeNode is refocused during "delete" hot key here https://github.com/webstudio-is/webstudio-builder/blob/5935d7818fba3739e4f16fe710ea468bf9d0ac78/packages/design-system/src/components/tree/tree.tsx#L435
+ // and then focus cause handleSelect to be called with the same instanceSelector
+ // This avoids additional rerender on node delete
+ if (shallowEqual(selectedInstanceSelectorStore.get(), instanceSelector)) {
+ return;
+ }
+ selectedInstanceSelectorStore.set(instanceSelector);
+ textEditingInstanceSelectorStore.set(undefined);
+ selectedStyleSourceSelectorStore.set(undefined);
+ }, []);
if (rootInstance === undefined) {
return null;
diff --git a/apps/builder/app/shared/nano-states/components.ts b/apps/builder/app/shared/nano-states/components.ts
index 7789cd8d44..60e45a04b4 100644
--- a/apps/builder/app/shared/nano-states/components.ts
+++ b/apps/builder/app/shared/nano-states/components.ts
@@ -10,78 +10,99 @@ import {
getIndexesWithinAncestors,
} from "@webstudio-is/react-sdk";
import type { Instance } from "@webstudio-is/project-build";
-import { subscribe } from "~/shared/pubsub";
+import type { InstanceSelector } from "../tree-utils";
import { dataSourceVariablesStore, propsStore } from "./nano-states";
-import { instancesStore, selectedPageStore } from ".";
-
-type HookCommand = NonNullable<
- {
- [Name in keyof Hook]: {
- name: Name;
- data: Parameters<NonNullable<Hook[Name]>>[1];
- };
- }[keyof Hook]
->;
-
-declare module "~/shared/pubsub" {
- export interface PubsubMap {
- emitComponentHook: HookCommand;
- }
-}
+import { instancesStore, selectedInstanceSelectorStore } from "./instances";
+import { selectedPageStore } from "./pages";
+import { shallowEqual } from "shallow-equal";
-// subscribe component hooks emitted from builder
-// and invoke all hooks
-// name and data is mapped to [name](context, data)
-export const subscribeComponentHooks = () => {
- return subscribe("emitComponentHook", (data) => {
- const hooks = registeredComponentHooksStore.get();
- const metas = registeredComponentMetasStore.get();
- const instances = instancesStore.get();
- const page = selectedPageStore.get();
- const indexesWithinAncestors = getIndexesWithinAncestors(
- metas,
- instances,
- page ? [page.rootInstanceId] : []
- );
- for (const hook of hooks) {
- const context: HookContext = {
- indexesWithinAncestors,
-
- getPropValue: (instanceId, propName) => {
- const props = propsStore.get();
- for (const prop of props.values()) {
- if (prop.instanceId === instanceId && prop.name === propName) {
- if (
- prop.type === "string" ||
- prop.type === "number" ||
- prop.type === "boolean" ||
- prop.type === "string[]"
- ) {
- return prop.value;
- }
- }
- }
- },
-
- setPropVariable: (instanceId, propName, value) => {
- const dataSourceVariables = new Map(dataSourceVariablesStore.get());
- const props = propsStore.get();
- for (const prop of props.values()) {
- if (
- prop.instanceId === instanceId &&
- prop.name === propName &&
- prop.type === "dataSource"
- ) {
- const dataSourceId = prop.value;
- dataSourceVariables.set(dataSourceId, value);
- }
+const createHookContext = (): HookContext => {
+ const metas = registeredComponentMetasStore.get();
+ const instances = instancesStore.get();
+ const page = selectedPageStore.get();
+ const indexesWithinAncestors = getIndexesWithinAncestors(
+ metas,
+ instances,
+ page ? [page.rootInstanceId] : []
+ );
+
+ return {
+ indexesWithinAncestors,
+
+ getPropValue: (instanceId, propName) => {
+ const props = propsStore.get();
+ for (const prop of props.values()) {
+ if (prop.instanceId === instanceId && prop.name === propName) {
+ if (
+ prop.type === "string" ||
+ prop.type === "number" ||
+ prop.type === "boolean" ||
+ prop.type === "string[]"
+ ) {
+ return prop.value;
}
- dataSourceVariablesStore.set(dataSourceVariables);
- },
- };
- hook[data.name]?.(context, data.data);
- }
- });
+ }
+ }
+ },
+
+ setPropVariable: (instanceId, propName, value) => {
+ const dataSourceVariables = new Map(dataSourceVariablesStore.get());
+ const props = propsStore.get();
+ for (const prop of props.values()) {
+ if (
+ prop.instanceId === instanceId &&
+ prop.name === propName &&
+ prop.type === "dataSource"
+ ) {
+ const dataSourceId = prop.value;
+ dataSourceVariables.set(dataSourceId, value);
+ }
+ }
+ dataSourceVariablesStore.set(dataSourceVariables);
+ },
+ };
+};
+
+// subscribe builder events and invoke all component hooks
+export const subscribeComponentHooks = () => {
+ let lastSelectedInstanceSelector: undefined | InstanceSelector = undefined;
+ const unsubscribeSelectedInstanceSelector =
+ selectedInstanceSelectorStore.subscribe((instanceSelector) => {
+ // prevent executing hooks when selected instance is not changed
+ if (shallowEqual(lastSelectedInstanceSelector, instanceSelector)) {
+ return;
+ }
+ const hooks = registeredComponentHooksStore.get();
+ const instances = instancesStore.get();
+ if (lastSelectedInstanceSelector) {
+ for (const hook of hooks) {
+ hook.onNavigatorUnselect?.(createHookContext(), {
+ instancePath: lastSelectedInstanceSelector.flatMap((id) => {
+ const instance = instances.get(id);
+ return instance ? [instance] : [];
+ }),
+ });
+ }
+ }
+
+ if (instanceSelector) {
+ for (const hook of hooks) {
+ hook.onNavigatorSelect?.(createHookContext(), {
+ instancePath: instanceSelector.flatMap((id) => {
+ const instance = instances.get(id);
+ return instance ? [instance] : [];
+ }),
+ });
+ }
+ }
+
+ // store converts values to readonly
+ lastSelectedInstanceSelector = instanceSelector as InstanceSelector;
+ });
+
+ return () => {
+ unsubscribeSelectedInstanceSelector();
+ };
};
export const registeredComponentsStore = atom(new Map<string, AnyComponent>());