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.

Register props meta into store (#1655)

Bogdan Chadkin6f6a4e7d34fd
diff --git a/apps/builder/app/builder/builder.tsx b/apps/builder/app/builder/builder.tsx
index 64d003067f..b62b787846 100644
--- a/apps/builder/app/builder/builder.tsx
+++ b/apps/builder/app/builder/builder.tsx
@@ -45,9 +45,7 @@ import { BlockingAlerts } from "./features/blocking-alerts";
import { useStore } from "@nanostores/react";
import {
customComponentMetas,
- customComponentPropsMetas,
registerComponentMetas,
- registerComponentPropsMetas,
} from "@webstudio-is/react-sdk";
registerContainers();
@@ -239,7 +237,6 @@ export type BuilderProps = {
// @todo: Don't do this in builder
// https://github.com/webstudio-is/webstudio-builder/issues/1545
registerComponentMetas(customComponentMetas);
-registerComponentPropsMetas(customComponentPropsMetas);
export const Builder = ({
project,
diff --git a/apps/builder/app/builder/features/props-panel/props-panel.tsx b/apps/builder/app/builder/features/props-panel/props-panel.tsx
index e71797b98d..3444f32dd0 100644
--- a/apps/builder/app/builder/features/props-panel/props-panel.tsx
+++ b/apps/builder/app/builder/features/props-panel/props-panel.tsx
@@ -1,3 +1,4 @@
+import { useStore } from "@nanostores/react";
import store from "immerhin";
import type { Instance } from "@webstudio-is/project-build";
import {
@@ -16,8 +17,16 @@ import {
InputField,
NestedInputButton,
} from "@webstudio-is/design-system";
+import {
+ type WsComponentMeta,
+ getComponentMeta,
+} from "@webstudio-is/react-sdk";
import type { Publish } from "~/shared/pubsub";
-import { propsStore, useInstanceProps } from "~/shared/nano-states";
+import {
+ propsStore,
+ registeredComponentPropsMetasStore,
+ useInstanceProps,
+} from "~/shared/nano-states";
import { CollapsibleSectionWithAddButton } from "~/builder/shared/collapsible-section";
import {
useStyleData,
@@ -31,11 +40,6 @@ import {
} from "./use-props-logic";
import { getLabel } from "./shared";
import { useState, type ReactNode } from "react";
-import {
- getComponentPropsMeta,
- getComponentMeta,
- type WsComponentMeta,
-} from "@webstudio-is/react-sdk";
import { getInstanceLabel } from "~/builder/shared/tree";
import { MetaIcon } from "~/builder/shared/meta-icon";
@@ -247,7 +251,9 @@ export const PropsPanelContainer = ({
publish: Publish;
selectedInstance: Instance;
}) => {
- const propsMeta = getComponentPropsMeta(instance.component);
+ const propsMeta = useStore(registeredComponentPropsMetasStore).get(
+ instance.component
+ );
if (propsMeta === undefined) {
throw new Error(`Could not get meta for compoent "${instance.component}"`);
}
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsx
index f88d3971a5..79d7a7c925 100644
--- a/apps/builder/app/canvas/canvas.tsx
+++ b/apps/builder/app/canvas/canvas.tsx
@@ -1,13 +1,15 @@
import { useMemo, useEffect } from "react";
import { useStore } from "@nanostores/react";
import { computed } from "nanostores";
-import type { Params } from "@webstudio-is/react-sdk";
+import {
+ type Params,
+ defaultPropsMetas,
+ registerComponentMetas,
+} from "@webstudio-is/react-sdk";
import type { Instances, Page } from "@webstudio-is/project-build";
import {
createElementsTree,
registerComponents,
- registerComponentPropsMetas,
- registerComponentMetas,
customComponentMetas,
customComponentPropsMetas,
setParams,
@@ -31,9 +33,11 @@ import {
instancesStore,
useIsPreviewMode,
selectedPageStore,
+ registerComponentPropsMetas,
} from "~/shared/nano-states";
import { useDragAndDrop } from "./shared/use-drag-drop";
import { useCopyPaste } from "~/shared/copy-paste";
+import { useSyncInitializeOnce } from "~/shared/hook-utils";
import { setDataCollapsed, subscribeCollapsedToPubSub } from "./collapsed";
import { useWindowResizeDebounced } from "~/shared/dom-hooks";
import { subscribeInstanceSelection } from "./instance-selection";
@@ -133,7 +137,10 @@ export const Canvas = ({
registerComponents(customComponents);
registerComponentMetas(customComponentMetas);
- registerComponentPropsMetas(customComponentPropsMetas);
+ useSyncInitializeOnce(() => {
+ registerComponentPropsMetas(defaultPropsMetas);
+ registerComponentPropsMetas(customComponentPropsMetas);
+ });
// e.g. toggling preview is still needed in both modes
useCanvasShortcuts();
diff --git a/apps/builder/app/shared/nano-states/components-meta.ts b/apps/builder/app/shared/nano-states/components-meta.ts
new file mode 100644
index 0000000000..b5f4d0c90f
--- /dev/null
+++ b/apps/builder/app/shared/nano-states/components-meta.ts
@@ -0,0 +1,32 @@
+import { atom } from "nanostores";
+import type { WsComponentPropsMeta } from "@webstudio-is/react-sdk";
+
+export const registeredComponentPropsMetasStore = atom(
+ new Map<string, WsComponentPropsMeta>()
+);
+
+export const registerComponentPropsMetas = (
+ newPropsMetas: Record<string, WsComponentPropsMeta>
+) => {
+ const prevPropsMetas = registeredComponentPropsMetasStore.get();
+ const nextPropsMetas = new Map(prevPropsMetas);
+ for (const [componentName, propsMeta] of Object.entries(newPropsMetas)) {
+ const { initialProps = [], props } = propsMeta;
+ const requiredProps: string[] = [];
+ for (const [name, value] of Object.entries(props)) {
+ if (value.required && initialProps.includes(name) === false) {
+ requiredProps.push(name);
+ }
+ }
+ nextPropsMetas.set(componentName, {
+ // order of initialProps must be preserved
+ initialProps: [...initialProps, ...requiredProps],
+ props: propsMeta.props,
+ });
+ }
+ registeredComponentPropsMetasStore.set(nextPropsMetas);
+};
+
+export const synchronizedComponentsMetaStores = [
+ ["registeredComponentPropsMetas", registeredComponentPropsMetasStore],
+] as const;
diff --git a/apps/builder/app/shared/nano-states/index.ts b/apps/builder/app/shared/nano-states/index.ts
index f355396f68..3ed9982fe0 100644
--- a/apps/builder/app/shared/nano-states/index.ts
+++ b/apps/builder/app/shared/nano-states/index.ts
@@ -3,3 +3,4 @@ export * from "./breakpoints";
export * from "./instances";
export * from "./canvas";
export * from "./pages";
+export * from "./components-meta";
diff --git a/apps/builder/app/shared/sync/sync-stores.ts b/apps/builder/app/shared/sync/sync-stores.ts
index 60297a7775..a478c2fb95 100644
--- a/apps/builder/app/shared/sync/sync-stores.ts
+++ b/apps/builder/app/shared/sync/sync-stores.ts
@@ -25,6 +25,7 @@ import {
synchronizedInstancesStores,
synchronizedBreakpointsStores,
selectedStyleSourceSelectorStore,
+ synchronizedComponentsMetaStores,
} from "~/shared/nano-states";
enableMapSet();
@@ -54,6 +55,7 @@ declare module "~/shared/pubsub" {
}
const clientStores = new Map<string, WritableAtom<unknown>>();
+const initializedStores = new Set<string>();
export const registerContainers = () => {
// synchronize patches
@@ -100,6 +102,22 @@ export const registerContainers = () => {
for (const [name, store] of synchronizedCanvasStores) {
clientStores.set(name, store);
}
+ for (const [name, store] of synchronizedComponentsMetaStores) {
+ clientStores.set(name, store);
+ }
+
+ // use listen to not invoke initially
+ for (const [name, store] of clientStores) {
+ // here we rely on the fact registerContainers is called before any store.set
+ // is called to find which store is initialized to send its data to the other realm
+ // this can help to find the direction between builder and canvas
+ // so canvas could send initial data to builder without builder overriding it
+ // with default store value
+ const unsubscribe = store.listen(() => {
+ initializedStores.add(name);
+ unsubscribe();
+ });
+ }
};
const syncStoresChanges = (name: SyncEventSource, publish: Publish) => {
@@ -267,6 +285,26 @@ export const useCanvasStore = (publish: Publish) => {
return handshakeAndSyncStores("canvas", publish, (publish) => {
const unsubscribeStoresState = syncStoresState("canvas", publish);
const unsubscribeStoresChanges = syncStoresChanges("canvas", publish);
+
+ // immerhin data is sent only initially so not part of syncStoresState
+ // expect data to be populated by the time effect is called
+ const data = [];
+ for (const [namespace, store] of clientStores) {
+ if (initializedStores.has(namespace)) {
+ data.push({
+ namespace,
+ value: store.get(),
+ });
+ }
+ }
+ publish({
+ type: "sendStoreData",
+ payload: {
+ source: "canvas",
+ data,
+ },
+ });
+
return () => {
unsubscribeStoresState();
unsubscribeStoresChanges();
@@ -291,10 +329,12 @@ export const useBuilderStore = (publish: Publish) => {
});
}
for (const [namespace, store] of clientStores) {
- data.push({
- namespace,
- value: store.get(),
- });
+ if (initializedStores.has(namespace)) {
+ data.push({
+ namespace,
+ value: store.get(),
+ });
+ }
}
publish({
type: "sendStoreData",
diff --git a/packages/react-sdk/src/components/index.ts b/packages/react-sdk/src/components/index.ts
index 21903bd105..7def8d028c 100644
--- a/packages/react-sdk/src/components/index.ts
+++ b/packages/react-sdk/src/components/index.ts
@@ -1,4 +1,3 @@
-import { PropMeta } from "@webstudio-is/generate-arg-types";
import type { WsComponentMeta, WsComponentPropsMeta } from "./component-meta";
import type { ComponentName } from "./components-utils";
import { meta as SlotMeta } from "./slot.ws";
@@ -69,7 +68,7 @@ import { propsMeta as CheckboxFieldPropsMeta } from "./checkbox-field.ws";
import { propsMeta as CheckboxPropsMeta } from "./checkbox.ws";
// @todo this list should not be hardcoded!
-const defaultMetas: Record<string, WsComponentMeta> = {
+export const defaultMetas: Record<string, WsComponentMeta> = {
Slot: SlotMeta,
Fragment: FragmentMeta,
Box: BoxMeta,
@@ -121,7 +120,7 @@ export const registerComponentMetas = (
};
// @todo this list should not be hardcoded!
-const defaultPropsMetasRaw = {
+export const defaultPropsMetas: Record<string, WsComponentPropsMeta> = {
Slot: SlotMetaPropsMeta,
Fragment: FragmentMetaPropsMeta,
Box: BoxMetaPropsMeta,
@@ -154,44 +153,6 @@ const defaultPropsMetasRaw = {
RadioButton: RadioButtonPropsMeta,
CheckboxField: CheckboxFieldPropsMeta,
Checkbox: CheckboxPropsMeta,
-} as const;
-
-const defaultPropsMetas: Record<string, WsComponentPropsMeta> =
- defaultPropsMetasRaw;
-
-let registeredPropsMetas: Record<string, Partial<WsComponentPropsMeta>> = {};
-
-// we start as `undefined` because pre-computing will likely kill tree-shaking
-let currentPropsMetas: Record<string, WsComponentPropsMeta> | undefined =
- undefined;
-
-export const getComponentPropsMeta = (
- name: string
-): WsComponentPropsMeta | undefined => {
- if (currentPropsMetas === undefined) {
- currentPropsMetas = {};
- for (const name of Object.keys(defaultPropsMetas)) {
- const props = computeProps(
- defaultPropsMetas[name],
- registeredPropsMetas[name] ?? {}
- );
- const initialProps = computeInitialProps(
- props,
- defaultPropsMetas[name],
- registeredPropsMetas[name] ?? {}
- );
- currentPropsMetas[name] = { props, initialProps };
- }
- }
-
- return currentPropsMetas[name];
-};
-
-export const registerComponentPropsMetas = (
- metas: Record<string, WsComponentPropsMeta>
-) => {
- registeredPropsMetas = metas;
- currentPropsMetas = undefined;
};
type RegisteredComponents = Partial<{
@@ -210,48 +171,6 @@ export const registerComponents = (components: RegisteredComponents) => {
registeredComponents = components;
};
-const computeProps = (
- defaults: WsComponentPropsMeta,
- overrides: Partial<WsComponentPropsMeta>
-) => {
- if (overrides) {
- const allNames = new Set([
- ...Object.keys(defaults.props ?? {}),
- ...Object.keys(overrides?.props ?? {}),
- ]).values();
-
- const result: WsComponentPropsMeta["props"] = {};
- for (const name of allNames) {
- result[name] = PropMeta.parse({
- ...defaults.props[name],
- ...overrides?.props?.[name],
- });
- }
- return result;
- }
-
- return defaults.props;
-};
-
-const computeInitialProps = (
- props: WsComponentPropsMeta["props"],
- defaults: WsComponentPropsMeta,
- overrides: Partial<WsComponentPropsMeta>
-): Array<string> => {
- const initialProps = overrides?.initialProps ?? defaults?.initialProps ?? [];
- const requiredProps = props
- ? Object.entries(props)
- .filter(
- ([name, value]) =>
- value?.required && initialProps.includes(name) === false
- )
- .map(([name]) => name)
- : [];
-
- // order of initialProps must be preserved
- return [...initialProps, ...requiredProps];
-};
-
export const canAcceptComponent = (
parentComponent: string,
childComponent: string