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.
TypeScript accessibilityalternativecloudflarecloudflare-workersdesignfreefrontendopen-sourceradix-uireactremixweb-developmentwebflowwebsite-builderwebsite-developmentwebsiteswebstudio
Provide params with context (#1743)
Bogdan Chadkin1263a9ab08f2
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsxindex 074a0509ea..8d9235c9ae 100644--- a/apps/builder/app/canvas/canvas.tsx+++ b/apps/builder/app/canvas/canvas.tsx@@ -6,7 +6,6 @@ import {type Params,type Components,createElementsTree,- setParams,} from "@webstudio-is/react-sdk";import * as baseComponents from "@webstudio-is/sdk-components-react";import * as baseComponentMetas from "@webstudio-is/sdk-components-react/metas";@@ -62,7 +61,7 @@ const temporaryInstances: Instances = new Map([],]);-const useElementsTree = (components: Components) => {+const useElementsTree = (components: Components, params: Params) => {const instances = useStore(instancesStore);const page = useStore(selectedPageStore);const [isPreviewMode] = useIsPreviewMode();@@ -94,6 +93,8 @@ const useElementsTree = (components: Components) => {return useMemo(() => {return createElementsTree({renderer: isPreviewMode ? "preview" : "canvas",+ imageBaseUrl: params.imageBaseUrl,+ assetBaseUrl: params.assetBaseUrl,instances: instances.size === 0 ? temporaryInstances : instances,// fallback to temporary root instance to render scripts// and receive real data from builder@@ -104,11 +105,18 @@ const useElementsTree = (components: Components) => {Component: WebstudioComponentDev,components,});- }, [instances, rootInstanceId, components, pagesMapStore, isPreviewMode]);+ }, [+ params,+ instances,+ rootInstanceId,+ components,+ pagesMapStore,+ isPreviewMode,+ ]);};-const DesignMode = () => {- useManageDesignModeStyles();+const DesignMode = ({ params }: { params: Params }) => {+ useManageDesignModeStyles(params);useDragAndDrop();// We need to initialize this in both canvas and builder,// because the events will fire in either one, depending on where the focus is@@ -128,7 +136,6 @@ type CanvasProps = {export const Canvas = ({ params }: CanvasProps): JSX.Element | null => {const handshaken = useStore(handshakenStore);- setParams(params ?? null);useCanvasStore(publish);const [isPreviewMode] = useIsPreviewMode();@@ -163,12 +170,14 @@ export const Canvas = ({ params }: CanvasProps): JSX.Element | null => {useEffect(subscribeCollapsedToPubSub, []);- const elements = useElementsTree(components);+ const elements = useElementsTree(components, params);return (<>- <GlobalStyles />- {isPreviewMode === false && handshaken === true && <DesignMode />}+ <GlobalStyles params={params} />+ {isPreviewMode === false && handshaken === true && (+ <DesignMode params={params} />+ )}{elements}</>);diff --git a/apps/builder/app/canvas/shared/styles.ts b/apps/builder/app/canvas/shared/styles.tsindex 93c57693be..c3d367e908 100644--- a/apps/builder/app/canvas/shared/styles.ts+++ b/apps/builder/app/canvas/shared/styles.ts@@ -1,4 +1,4 @@-import { useEffect, useMemo } from "react";+import { useContext, useEffect, useMemo } from "react";import { useIsomorphicLayoutEffect } from "react-use";import { computed } from "nanostores";import { useStore } from "@nanostores/react";@@ -8,8 +8,9 @@ import {idAttribute,addGlobalRules,createImageValueTransformer,- getParams,getPresetStyleRules,+ type Params,+ ReactSdkContext,} from "@webstudio-is/react-sdk";import type { Instance, StyleDecl } from "@webstudio-is/project-build";import {@@ -107,13 +108,13 @@ const subscribePreviewMode = () => {};};-export const useManageDesignModeStyles = () => {- useUpdateStyle();- usePreviewStyle();+export const useManageDesignModeStyles = (params: Params) => {+ useUpdateStyle(params);+ usePreviewStyle(params);useEffect(subscribePreviewMode, []);};-export const GlobalStyles = () => {+export const GlobalStyles = ({ params }: { params: Params }) => {const breakpoints = useStore(breakpointsStore);const assets = useStore(assetsStore);const metas = useStore(registeredComponentMetasStore);@@ -130,7 +131,6 @@ export const GlobalStyles = () => {useIsomorphicLayoutEffect(() => {fontsAndDefaultsCssEngine.clear();- const params = getParams();addGlobalRules(fontsAndDefaultsCssEngine, {assets,assetBaseUrl: params.assetBaseUrl,@@ -184,11 +184,13 @@ const getOrCreateRule = ({breakpointId,state = "",assets,+ params,}: {instanceId: string;breakpointId: string;state: undefined | string;assets: Assets;+ params: Params;}) => {const key = `${instanceId}:${breakpointId}:${state}`;let rule = wrappedRulesMap.get(key);@@ -202,7 +204,6 @@ const getOrCreateRule = ({);wrappedRulesMap.set(key, rule);}- const params = getParams();rule.styleMap.setTransformer(createImageValueTransformer(assets, { assetBaseUrl: params.assetBaseUrl }));@@ -232,6 +233,7 @@ export const useCssRules = ({instanceId: string;instanceStyles: StyleDecl[];}) => {+ const params = useContext(ReactSdkContext);const breakpoints = useStore(breakpointsStore);const selectedState = useSelectedState(instanceId);@@ -270,6 +272,7 @@ export const useCssRules = ({// to show user previewstate: selectedState === state ? undefined : state,assets,+ params,});// find existing declarations and exclude currently set properties@@ -307,7 +310,12 @@ const toVarNamespace = (id: string, property: string) => {return `${property}-${id}`;};-const setCssVar = (id: string, property: string, value?: StyleValue) => {+const setCssVar = (+ params: Params,+ id: string,+ property: string,+ value?: StyleValue+) => {const customProperty = `--${toVarNamespace(id, property)}`;if (value === undefined) {document.body.style.removeProperty(customProperty);@@ -315,7 +323,6 @@ const setCssVar = (id: string, property: string, value?: StyleValue) => {}const assets = assetsStore.get();- const params = getParams();const transformer = createImageValueTransformer(assets, {assetBaseUrl: params.assetBaseUrl,});@@ -323,7 +330,7 @@ const setCssVar = (id: string, property: string, value?: StyleValue) => {document.body.style.setProperty(customProperty, toValue(value, transformer));};-const useUpdateStyle = () => {+const useUpdateStyle = (params: Params) => {useSubscribe("updateStyle", ({ id, updates }) => {const selectedInstanceSelector = selectedInstanceSelectorStore.get();const selectedInstanceId = selectedInstanceSelector?.[0];@@ -334,18 +341,19 @@ const useUpdateStyle = () => {}for (const update of updates) {- setCssVar(id, update.property, undefined);+ setCssVar(params, id, update.property, undefined);}});};-const usePreviewStyle = () => {+const usePreviewStyle = (params: Params) => {useSubscribe("previewStyle", ({ id, updates, breakpoint, state }) => {const rule = getOrCreateRule({instanceId: id,breakpointId: breakpoint.id,state,assets: assetsStore.get(),+ params,});for (const update of updates) {@@ -358,11 +366,11 @@ const usePreviewStyle = () => {}}- setCssVar(id, update.property, update.value);+ setCssVar(params, id, update.property, update.value);}if (update.operation === "delete") {- setCssVar(id, update.property, undefined);+ setCssVar(params, id, update.property, undefined);}}diff --git a/packages/react-sdk/src/app/index.ts b/packages/react-sdk/src/app/index.tsindex 526bdd7f40..1efe34c51e 100644--- a/packages/react-sdk/src/app/index.ts+++ b/packages/react-sdk/src/app/index.ts@@ -1,2 +1 @@export * from "./root";-export * from "./params";diff --git a/packages/react-sdk/src/app/params.ts b/packages/react-sdk/src/app/params.tsdeleted file mode 100644index 26189b733f..0000000000--- a/packages/react-sdk/src/app/params.ts+++ /dev/null@@ -1,38 +0,0 @@-export type Params = {- /**- * Base url ir base path for images with ending slash.- * Used for configuring image with different sizes.- * Concatinated with "name?width=&quality=&format=".- *- * For example- * /asset/image/ used by default in builder- * https://image-transform.wstd.io/cdn-cgi/image/- * https://webstudio.is/cdn-cgi/image/- */- imageBaseUrl: string;- /**- * Base url or base path for any asset with ending slash.- * Used to load assets like fonts or images in styles- * Concatinated with "name".- *- * For example- * /s/uploads/- * /asset/file/- * https://assets-dev.webstudio.is/- * https://assets.webstudio.is/- */- assetBaseUrl: string;-};--let params: undefined | Params;--const emptyParams: Params = {- imageBaseUrl: "/",- assetBaseUrl: "/",-};--export const getParams = (): Params => params ?? emptyParams;--export const setParams = (newParams: undefined | Params) => {- params = newParams;-};diff --git a/packages/react-sdk/src/context.tsx b/packages/react-sdk/src/context.tsxindex 35206acce9..5bee7e9469 100644--- a/packages/react-sdk/src/context.tsx+++ b/packages/react-sdk/src/context.tsx@@ -3,12 +3,42 @@ import { createContext } from "react";import type { Assets } from "@webstudio-is/asset-uploader";import type { Pages, PropsByInstanceId } from "./props";-export const ReactSdkContext = createContext<{+export type Params = {renderer?: "canvas" | "preview";- propsByInstanceIdStore: ReadableAtom<PropsByInstanceId>;- assetsStore: ReadableAtom<Assets>;- pagesStore: ReadableAtom<Pages>;-}>({+ /**+ * Base url ir base path for images with ending slash.+ * Used for configuring image with different sizes.+ * Concatinated with "name?width=&quality=&format=".+ *+ * For example+ * /asset/image/ used by default in builder+ * https://image-transform.wstd.io/cdn-cgi/image/+ * https://webstudio.is/cdn-cgi/image/+ */+ imageBaseUrl: string;+ /**+ * Base url or base path for any asset with ending slash.+ * Used to load assets like fonts or images in styles+ * Concatinated with "name".+ *+ * For example+ * /s/uploads/+ * /asset/file/+ * https://assets-dev.webstudio.is/+ * https://assets.webstudio.is/+ */+ assetBaseUrl: string;+};++export const ReactSdkContext = createContext<+ Params & {+ propsByInstanceIdStore: ReadableAtom<PropsByInstanceId>;+ assetsStore: ReadableAtom<Assets>;+ pagesStore: ReadableAtom<Pages>;+ }+>({+ imageBaseUrl: "/",+ assetBaseUrl: "/",propsByInstanceIdStore: atom(new Map()),assetsStore: atom(new Map()),pagesStore: atom(new Map()),diff --git a/packages/react-sdk/src/index.ts b/packages/react-sdk/src/index.tsindex 5ad6c3a006..196ef06b26 100644--- a/packages/react-sdk/src/index.ts+++ b/packages/react-sdk/src/index.ts@@ -18,4 +18,4 @@ export {usePropAsset,getInstanceIdFromComponentProps,} from "./props";-export { ReactSdkContext } from "./context";+export { type Params, ReactSdkContext } from "./context";diff --git a/packages/react-sdk/src/tree/create-elements-tree.tsx b/packages/react-sdk/src/tree/create-elements-tree.tsxindex 4525c8c2d6..228fe5d886 100644--- a/packages/react-sdk/src/tree/create-elements-tree.tsx+++ b/packages/react-sdk/src/tree/create-elements-tree.tsx@@ -4,7 +4,7 @@ import { Scripts, ScrollRestoration } from "@remix-run/react";import type { Assets } from "@webstudio-is/asset-uploader";import type { Instance, Instances } from "@webstudio-is/project-build";import type { Components } from "../components/components-utils";-import { ReactSdkContext } from "../context";+import { ReactSdkContext, type Params } from "../context";import type { Pages, PropsByInstanceId } from "../props";import type { WebstudioComponent } from "./webstudio-component";@@ -12,6 +12,8 @@ type InstanceSelector = Instance["id"][];export const createElementsTree = ({renderer,+ imageBaseUrl,+ assetBaseUrl,instances,rootInstanceId,propsByInstanceIdStore,@@ -19,8 +21,7 @@ export const createElementsTree = ({pagesStore,Component,components,-}: {- renderer?: "canvas" | "preview";+}: Params & {instances: Instances;rootInstanceId: Instance["id"];propsByInstanceIdStore: ReadableAtom<PropsByInstanceId>;@@ -57,7 +58,14 @@ export const createElementsTree = ({});return (<ReactSdkContext.Provider- value={{ propsByInstanceIdStore, assetsStore, pagesStore, renderer }}+ value={{+ propsByInstanceIdStore,+ assetsStore,+ pagesStore,+ renderer,+ imageBaseUrl,+ assetBaseUrl,+ }}>{root}</ReactSdkContext.Provider>diff --git a/packages/react-sdk/src/tree/root.ts b/packages/react-sdk/src/tree/root.tsindex 413cd5af7b..4c5a470c16 100644--- a/packages/react-sdk/src/tree/root.ts+++ b/packages/react-sdk/src/tree/root.ts@@ -4,9 +4,9 @@ import type { Build, Page } from "@webstudio-is/project-build";import type { Asset } from "@webstudio-is/asset-uploader";import { createElementsTree } from "./create-elements-tree";import { WebstudioComponent } from "./webstudio-component";-import { setParams, type Params } from "../app/params";import { getPropsByInstanceId } from "../props";import type { Components } from "../components/components-utils";+import type { Params } from "../context";export type Data = {page: Page;@@ -31,8 +31,9 @@ export const InstanceRoot = ({Component,components,}: RootProps): JSX.Element | null => {- setParams(data.params);return createElementsTree({+ imageBaseUrl: data.params?.imageBaseUrl ?? "/",+ assetBaseUrl: data.params?.assetBaseUrl ?? "/",instances: new Map(data.build.instances),rootInstanceId: data.page.rootInstanceId,propsByInstanceIdStore: atom(diff --git a/packages/sdk-components-react/src/image.tsx b/packages/sdk-components-react/src/image.tsxindex 67bec45d85..a89ac30130 100644--- a/packages/sdk-components-react/src/image.tsx+++ b/packages/sdk-components-react/src/image.tsx@@ -3,6 +3,7 @@ import {type ElementRef,forwardRef,useMemo,+ useContext,} from "react";import {Image as WebstudioImage,@@ -11,7 +12,7 @@ import {import {usePropAsset,getInstanceIdFromComponentProps,- getParams,+ ReactSdkContext,} from "@webstudio-is/react-sdk";export const defaultTag = "img";@@ -44,12 +45,12 @@ type Props = Omit<ComponentPropsWithoutRef<typeof WebstudioImage>, "loader">;export const Image = forwardRef<ElementRef<typeof defaultTag>, Props>((props, ref) => {+ const { imageBaseUrl } = useContext(ReactSdkContext);const asset = usePropAsset(getInstanceIdFromComponentProps(props), "src");const loader = useMemo(() => {- const params = getParams();- return createImageLoader({ imageBaseUrl: params.imageBaseUrl });- }, []);+ return createImageLoader({ imageBaseUrl });+ }, [imageBaseUrl]);const src = asset?.name ?? props.src;diff --git a/packages/sdk-components-react/src/link.tsx b/packages/sdk-components-react/src/link.tsxindex ffe80fdb3a..cb8b7def6d 100644--- a/packages/sdk-components-react/src/link.tsx+++ b/packages/sdk-components-react/src/link.tsx@@ -1,8 +1,8 @@-import { forwardRef, type ComponentProps } from "react";+import { forwardRef, type ComponentProps, useContext } from "react";import {usePropUrl,getInstanceIdFromComponentProps,- getParams,+ ReactSdkContext,} from "@webstudio-is/react-sdk";export const defaultTag = "a";@@ -13,10 +13,9 @@ type Props = Omit<ComponentProps<"a">, "target"> & {};export const Link = forwardRef<HTMLAnchorElement, Props>((props, ref) => {+ const { assetBaseUrl } = useContext(ReactSdkContext);const href = usePropUrl(getInstanceIdFromComponentProps(props), "href");- const { assetBaseUrl } = getParams();-let url = "#";switch (href?.type) {