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.

Add component hooks (#2069)

Bogdan Chadkinfdf22ab9e6e1
diff --git a/apps/builder/app/builder/features/inspector/inspector.tsx b/apps/builder/app/builder/features/inspector/inspector.tsx
index a7aeca3eb4..af2e369a25 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 />;
+ return <NavigatorTree publish={publish} />;
}
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 befbc99efe..586fb014bb 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 />
+ <NavigatorTree publish={publish} />
<Separator />
<CssPreview />
</Flex>
diff --git a/apps/builder/app/builder/shared/navigator-tree.tsx b/apps/builder/app/builder/shared/navigator-tree.tsx
index f6487455eb..68577616d8 100644
--- a/apps/builder/app/builder/shared/navigator-tree.tsx
+++ b/apps/builder/app/builder/shared/navigator-tree.tsx
@@ -22,9 +22,10 @@ import {
isInstanceDetachable,
getComponentTemplateData,
} from "~/shared/instance-utils";
+import type { Publish } from "~/shared/pubsub";
import { InstanceTree } from "./tree";
-export const NavigatorTree = () => {
+export const NavigatorTree = ({ publish }: { publish: Publish }) => {
const selectedInstanceSelector = useStore(selectedInstanceSelectorStore);
const rootInstance = useStore(rootInstanceStore);
const instances = useStore(instancesStore);
@@ -107,19 +108,50 @@ export const NavigatorTree = () => {
[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
- ) {
- selectedInstanceSelectorStore.set(instanceSelector);
- textEditingInstanceSelectorStore.set(undefined);
- selectedStyleSourceSelectorStore.set(undefined);
- }
- }, []);
+ 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: {
+ instanceSelection: 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: {
+ instanceSelection: instanceSelector.flatMap((id) => {
+ const instance = instances.get(id);
+ return instance ? [instance] : [];
+ }),
+ },
+ },
+ });
+ }
+ },
+ [publish]
+ );
if (rootInstance === undefined) {
return null;
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsx
index 129326bf6f..17c789bcec 100644
--- a/apps/builder/app/canvas/canvas.tsx
+++ b/apps/builder/app/canvas/canvas.tsx
@@ -21,6 +21,7 @@ import * as remixComponentPropsMetas from "@webstudio-is/sdk-components-react-re
import * as radixComponents from "@webstudio-is/sdk-components-react-radix";
import * as radixComponentMetas from "@webstudio-is/sdk-components-react-radix/metas";
import * as radixComponentPropsMetas from "@webstudio-is/sdk-components-react-radix/props";
+import { hooks as radixComponentHooks } from "@webstudio-is/sdk-components-react-radix/hooks";
import { publish } from "~/shared/pubsub";
import {
handshakenStore,
@@ -43,6 +44,7 @@ import {
dataSourceVariablesStore,
registeredComponentsStore,
registeredComponentMetasStore,
+ subscribeComponentHooks,
} from "~/shared/nano-states";
import { useDragAndDrop } from "./shared/use-drag-drop";
import { useCopyPaste } from "~/shared/copy-paste";
@@ -193,9 +195,12 @@ export const Canvas = ({ params }: CanvasProps): JSX.Element | null => {
components: radixComponents,
metas: radixComponentMetas,
propsMetas: radixComponentPropsMetas,
+ hooks: radixComponentHooks,
});
});
+ useEffect(subscribeComponentHooks, []);
+
// e.g. toggling preview is still needed in both modes
useCanvasShortcuts();
useSharedShortcuts({ source: "canvas" });
diff --git a/apps/builder/app/shared/nano-states/components.ts b/apps/builder/app/shared/nano-states/components.ts
index 29988b060b..b1a37df88b 100644
--- a/apps/builder/app/shared/nano-states/components.ts
+++ b/apps/builder/app/shared/nano-states/components.ts
@@ -5,11 +5,61 @@ import {
type AnyComponent,
type WsComponentMeta,
type WsComponentPropsMeta,
+ type Hook,
+ type HookContext,
} from "@webstudio-is/react-sdk";
import type { Instance } from "@webstudio-is/project-build";
+import { subscribe } from "~/shared/pubsub";
+import { dataSourceVariablesStore, propsStore } from "./nano-states";
+
+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;
+ }
+}
+
+// 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();
+ for (const hook of hooks) {
+ const context: HookContext = {
+ 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);
+ },
+ };
+ hook[data.name]?.(context, data.data);
+ }
+ });
+};
export const registeredComponentsStore = atom(new Map<string, AnyComponent>());
+export const registeredComponentHooksStore = atom<Hook[]>([]);
+
export const registeredComponentMetasStore = atom(
new Map<string, WsComponentMeta>()
);
@@ -23,6 +73,7 @@ export const registerComponentLibrary = ({
components,
metas,
propsMetas,
+ hooks,
}: {
namespace?: string;
// simplify adding component libraries
@@ -30,6 +81,7 @@ export const registerComponentLibrary = ({
components: Record<Instance["component"], ExoticComponent<any>>;
metas: Record<Instance["component"], WsComponentMeta>;
propsMetas: Record<Instance["component"], WsComponentPropsMeta>;
+ hooks?: Hook[];
}) => {
const prefix = namespace === undefined ? "" : `${namespace}:`;
@@ -52,6 +104,12 @@ export const registerComponentLibrary = ({
}
registeredComponentMetasStore.set(nextMetas);
+ if (hooks) {
+ const prevHooks = registeredComponentHooksStore.get();
+ const nextHooks = [...prevHooks, ...hooks];
+ registeredComponentHooksStore.set(nextHooks);
+ }
+
const prevPropsMetas = registeredComponentPropsMetasStore.get();
const nextPropsMetas = new Map(prevPropsMetas);
for (const [componentName, propsMeta] of Object.entries(propsMetas)) {
diff --git a/packages/react-sdk/src/hook.ts b/packages/react-sdk/src/hook.ts
new file mode 100644
index 0000000000..2c36eec68a
--- /dev/null
+++ b/packages/react-sdk/src/hook.ts
@@ -0,0 +1,42 @@
+import type { Instance, Prop } from "@webstudio-is/project-build";
+
+/**
+ * Hooks are subscriptions to builder events
+ * with limited way to interact with it.
+ * Called independently from components.
+ */
+
+export type HookContext = {
+ setPropVariable: (
+ instanceId: Instance["id"],
+ propName: Prop["name"],
+ value: unknown
+ ) => void;
+};
+
+export type InstanceSelection = Instance[];
+
+type NavigatorEvent = {
+ instanceSelection: InstanceSelection;
+};
+
+export type Hook = {
+ onNavigatorSelect?: (context: HookContext, event: NavigatorEvent) => void;
+ onNavigatorUnselect?: (context: HookContext, event: NavigatorEvent) => void;
+};
+
+export const getClosestInstance = (
+ instanceSelection: InstanceSelection,
+ currentInstance: Instance,
+ closestComponent: Instance["component"]
+) => {
+ let matched = false;
+ for (const instance of instanceSelection) {
+ if (currentInstance === instance) {
+ matched = true;
+ }
+ if (matched && instance.component === closestComponent) {
+ return instance;
+ }
+ }
+};
diff --git a/packages/react-sdk/src/index.ts b/packages/react-sdk/src/index.ts
index 4f7800b448..a2ce7a29e7 100644
--- a/packages/react-sdk/src/index.ts
+++ b/packages/react-sdk/src/index.ts
@@ -35,3 +35,4 @@ export {
} from "./expression";
export { renderComponentTemplate } from "./component-renderer";
export { getIndexesWithinAncestors } from "./instance-utils";
+export * from "./hook";
diff --git a/packages/sdk-components-react-radix/package.json b/packages/sdk-components-react-radix/package.json
index 239ea7d616..c923cc577b 100644
--- a/packages/sdk-components-react-radix/package.json
+++ b/packages/sdk-components-react-radix/package.json
@@ -30,6 +30,12 @@
"types": "./lib/types/props.d.ts",
"import": "./lib/props.js",
"require": "./lib/cjs/props.js"
+ },
+ "./hooks": {
+ "source": "./src/hooks.ts",
+ "types": "./lib/types/hooks.d.ts",
+ "import": "./lib/hooks.js",
+ "require": "./lib/cjs/hooks.js"
}
},
"scripts": {
diff --git a/packages/sdk-components-react-radix/src/collapsible.tsx b/packages/sdk-components-react-radix/src/collapsible.tsx
index 40ebb81f58..cc01784796 100644
--- a/packages/sdk-components-react-radix/src/collapsible.tsx
+++ b/packages/sdk-components-react-radix/src/collapsible.tsx
@@ -9,6 +9,7 @@ import {
Children,
} from "react";
import { Root, Trigger, Content } from "@radix-ui/react-collapsible";
+import { type Hook, getClosestInstance } from "@webstudio-is/react-sdk";
export const Collapsible: ForwardRefExoticComponent<
Omit<ComponentPropsWithRef<typeof Root>, "defaultOpen" | "asChild">
@@ -35,3 +36,41 @@ export const CollapsibleTrigger = forwardRef<
export const CollapsibleContent: ForwardRefExoticComponent<
Omit<ComponentPropsWithRef<typeof Content>, "asChild">
> = Content;
+
+/* BUILDER HOOKS */
+
+const namespace = "@webstudio-is/sdk-components-react-radix";
+
+// For each CollapsibleContent component within the selection,
+// we identify its closest parent Collapsible component
+// and update its open prop bound to variable.
+export const hooksCollapsible: Hook = {
+ onNavigatorUnselect: (context, event) => {
+ for (const instance of event.instanceSelection) {
+ if (instance.component === `${namespace}:CollapsibleContent`) {
+ const collapsible = getClosestInstance(
+ event.instanceSelection,
+ instance,
+ `${namespace}:Collapsible`
+ );
+ if (collapsible) {
+ context.setPropVariable(collapsible.id, "open", false);
+ }
+ }
+ }
+ },
+ onNavigatorSelect: (context, event) => {
+ for (const instance of event.instanceSelection) {
+ if (instance.component === `${namespace}:CollapsibleContent`) {
+ const collapsible = getClosestInstance(
+ event.instanceSelection,
+ instance,
+ `${namespace}:Collapsible`
+ );
+ if (collapsible) {
+ context.setPropVariable(collapsible.id, "open", true);
+ }
+ }
+ }
+ },
+};
diff --git a/packages/sdk-components-react-radix/src/hooks.ts b/packages/sdk-components-react-radix/src/hooks.ts
new file mode 100644
index 0000000000..47e61c7ad7
--- /dev/null
+++ b/packages/sdk-components-react-radix/src/hooks.ts
@@ -0,0 +1,4 @@
+import type { Hook } from "@webstudio-is/react-sdk";
+import { hooksCollapsible } from "./collapsible";
+
+export const hooks: Hook[] = [hooksCollapsible];