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.

File and URL:Attachment controls (#1421)

Roman Pominovb14f2cf71d7f
diff --git a/apps/builder/app/builder/features/props-panel/controls/combined.tsx b/apps/builder/app/builder/features/props-panel/controls/combined.tsx
index 59ea49dbcb..0134e6091e 100644
--- a/apps/builder/app/builder/features/props-panel/controls/combined.tsx
+++ b/apps/builder/app/builder/features/props-panel/controls/combined.tsx
@@ -67,14 +67,17 @@ export const renderControl = ({
if (
meta.control === "file" &&
- (prop === undefined || prop.type === "asset")
+ (prop === undefined || prop.type === "asset" || prop.type === "string")
) {
return <FileControl meta={meta} prop={prop} {...rest} />;
}
if (
meta.control === "url" &&
- (prop === undefined || prop.type === "string" || prop.type === "page")
+ (prop === undefined ||
+ prop.type === "string" ||
+ prop.type === "page" ||
+ prop.type === "asset")
) {
return <UrlControl meta={meta} prop={prop} {...rest} />;
}
diff --git a/apps/builder/app/builder/features/props-panel/controls/file.tsx b/apps/builder/app/builder/features/props-panel/controls/file.tsx
index 0207992238..284ea3a561 100644
--- a/apps/builder/app/builder/features/props-panel/controls/file.tsx
+++ b/apps/builder/app/builder/features/props-panel/controls/file.tsx
@@ -1,12 +1,45 @@
-import { useMemo } from "react";
-import { computed } from "nanostores";
-import { useStore } from "@nanostores/react";
-import { Button, Text } from "@webstudio-is/design-system";
-import { assetsStore } from "~/shared/nano-states";
-import { FloatingPanel } from "~/builder/shared/floating-panel";
-import { ImageManager } from "~/builder/shared/image-manager";
-import { type ControlProps, getLabel, VerticalLayout } from "../shared";
-import { acceptToMimeCategories } from "@webstudio-is/asset-uploader";
+import { type ReactNode } from "react";
+import { Flex, InputField, theme, useId } from "@webstudio-is/design-system";
+import {
+ type ControlProps,
+ getLabel,
+ VerticalLayout,
+ useLocalValue,
+} from "../shared";
+import { SelectAsset } from "./select-asset";
+
+type FileControlProps = ControlProps<"file", "asset" | "string">;
+
+const UrlInput = ({
+ id,
+ disabled,
+ localValue,
+}: {
+ id: string;
+ disabled: boolean;
+ localValue: ReturnType<typeof useLocalValue<string>>;
+}) => (
+ <InputField
+ disabled={disabled}
+ id={id}
+ value={localValue.value}
+ placeholder="http://www.url.com"
+ onChange={(event) => localValue.set(event.target.value)}
+ onBlur={localValue.save}
+ onKeyDown={(event) => {
+ if (event.key === "Enter") {
+ localValue.save();
+ }
+ }}
+ css={{ width: "100%" }}
+ />
+);
+
+const Row = ({ children }: { children: ReactNode }) => (
+ <Flex css={{ height: theme.spacing[13] }} align="center">
+ {children}
+ </Flex>
+);
export const FileControl = ({
meta,
@@ -14,42 +47,43 @@ export const FileControl = ({
propName,
onChange,
onDelete,
-}: ControlProps<"file", "asset">) => {
- const assetStore = useMemo(
- () =>
- computed(assetsStore, (assets) =>
- prop ? assets.get(prop.value) : undefined
- ),
- [prop]
- );
- const asset = useStore(assetStore);
+ onSoftDelete,
+}: FileControlProps) => {
+ const id = useId();
- const acceptCategories = acceptToMimeCategories(meta?.accept || "");
+ const localStringValue = useLocalValue(
+ prop?.type === "string" ? prop.value : "",
+ (value) => {
+ if (value === "") {
+ onSoftDelete();
+ } else {
+ onChange({ type: "string", value });
+ }
+ }
+ );
return (
- <VerticalLayout label={getLabel(meta, propName)} onDelete={onDelete}>
- {acceptCategories === "*" ||
- (acceptCategories.size === 1 && acceptCategories.has("image")) ? (
- <FloatingPanel
- title="Images"
- content={
- <ImageManager
- onChange={(asset) =>
- onChange({ type: "asset", value: asset.id }, asset)
- }
- accept={meta?.accept}
- />
- }
- >
- <Button color="neutral" css={{ width: "100%" }}>
- {asset?.name ?? "Choose source"}
- </Button>
- </FloatingPanel>
- ) : (
- <Text color="destructive">
- Unsupported accept value: {meta?.accept}
- </Text>
- )}
+ <VerticalLayout
+ label={getLabel(meta, propName)}
+ onDelete={onDelete}
+ id={id}
+ >
+ <Row>
+ <UrlInput
+ id={id}
+ disabled={prop?.type === "asset"}
+ localValue={localStringValue}
+ />
+ </Row>
+ <Row>
+ <SelectAsset
+ prop={prop?.type === "asset" ? prop : undefined}
+ accept={meta.accept}
+ onChange={onChange}
+ onSoftDelete={onSoftDelete}
+ disabled={localStringValue.value !== ""}
+ />
+ </Row>
</VerticalLayout>
);
};
diff --git a/apps/builder/app/builder/features/props-panel/controls/select-asset.tsx b/apps/builder/app/builder/features/props-panel/controls/select-asset.tsx
new file mode 100644
index 0000000000..2f5ff8b56b
--- /dev/null
+++ b/apps/builder/app/builder/features/props-panel/controls/select-asset.tsx
@@ -0,0 +1,83 @@
+import { useMemo } from "react";
+import { computed } from "nanostores";
+import { useStore } from "@nanostores/react";
+import {
+ Button,
+ Flex,
+ SmallIconButton,
+ Text,
+} from "@webstudio-is/design-system";
+import { assetsStore } from "~/shared/nano-states";
+import { FloatingPanel } from "~/builder/shared/floating-panel";
+import { ImageManager } from "~/builder/shared/image-manager";
+import { type ControlProps } from "../shared";
+import { acceptToMimeCategories } from "@webstudio-is/asset-uploader";
+import { TrashIcon } from "@webstudio-is/icons";
+
+// tests whether we can use ImageManager for the given "accept" value
+const isImageAccept = (accept?: string) => {
+ const acceptCategories = acceptToMimeCategories(accept || "");
+ return (
+ acceptCategories === "*" ||
+ (acceptCategories.size === 1 && acceptCategories.has("image"))
+ );
+};
+
+type AssetControlProps = ControlProps<unknown, "asset">;
+
+type Props = {
+ accept?: string;
+ disabled?: boolean;
+ prop: AssetControlProps["prop"];
+ onChange: AssetControlProps["onChange"];
+ onSoftDelete: AssetControlProps["onSoftDelete"];
+};
+
+export const SelectAsset = ({
+ prop,
+ onChange,
+ onSoftDelete,
+ accept,
+ disabled = false,
+}: Props) => {
+ const assetStore = useMemo(
+ () =>
+ computed(assetsStore, (assets) =>
+ prop ? assets.get(prop.value) : undefined
+ ),
+ [prop]
+ );
+
+ const asset = useStore(assetStore);
+
+ if (isImageAccept(accept) === false) {
+ return <Text color="destructive">Unsupported accept value: {accept}</Text>;
+ }
+
+ return (
+ <Flex gap={2} css={{ flex: 1 }} align="center">
+ <FloatingPanel
+ title="Images"
+ content={
+ <ImageManager
+ onChange={(asset) =>
+ onChange({ type: "asset", value: asset.id }, asset)
+ }
+ accept={accept}
+ />
+ }
+ >
+ <Button color="neutral" css={{ flex: 1 }} disabled={disabled}>
+ {asset?.name ?? "Choose source"}
+ </Button>
+ </FloatingPanel>
+ {prop && disabled === false ? (
+ <SmallIconButton
+ icon={<TrashIcon />}
+ onClick={onSoftDelete}
+ variant="destructive"
+ />
+ ) : null}
+ </Flex>
+ );
+};
diff --git a/apps/builder/app/builder/features/props-panel/controls/url.tsx b/apps/builder/app/builder/features/props-panel/controls/url.tsx
index 6895ef1a33..2358f8fa6a 100644
--- a/apps/builder/app/builder/features/props-panel/controls/url.tsx
+++ b/apps/builder/app/builder/features/props-panel/controls/url.tsx
@@ -11,7 +11,13 @@ import {
Tooltip,
Label,
} from "@webstudio-is/design-system";
-import { EmailIcon, LinkIcon, PageIcon, PhoneIcon } from "@webstudio-is/icons";
+import {
+ AttachmentIcon,
+ EmailIcon,
+ LinkIcon,
+ PageIcon,
+ PhoneIcon,
+} from "@webstudio-is/icons";
import { type ReactNode, useState } from "react";
import {
type ControlProps,
@@ -20,13 +26,15 @@ import {
VerticalLayout,
} from "../shared";
import type { Page } from "@webstudio-is/project-build";
+import { SelectAsset } from "./select-asset";
-type UrlControlProps = ControlProps<"url", "string" | "page">;
+type UrlControlProps = ControlProps<"url", "string" | "page" | "asset">;
type BaseControlProps = {
id: string;
prop: UrlControlProps["prop"];
onChange: UrlControlProps["onChange"];
+ onSoftDelete: UrlControlProps["onSoftDelete"];
};
const Row = ({ children }: { children: ReactNode }) => (
@@ -46,7 +54,7 @@ const BaseUrl = ({ prop, onChange, id }: BaseControlProps) => {
<InputField
id={id}
value={localValue.value}
- placeholder="https://example.com/"
+ placeholder="http://www.url.com"
onChange={(event) => localValue.set(event.target.value)}
onBlur={localValue.save}
onKeyDown={(event) => {
@@ -193,11 +201,26 @@ const BasePage = ({ prop, onChange, id }: BaseControlProps) => {
);
};
+const BaseAttachment = ({ prop, onChange, onSoftDelete }: BaseControlProps) => (
+ <Row>
+ <SelectAsset
+ prop={prop?.type === "asset" ? prop : undefined}
+ onChange={onChange}
+ onSoftDelete={onSoftDelete}
+ />
+ </Row>
+);
+
const modes = {
url: { icon: <LinkIcon />, control: BaseUrl, label: "URL" },
page: { icon: <PageIcon />, control: BasePage, label: "Page" },
email: { icon: <EmailIcon />, control: BaseEmail, label: "Email" },
phone: { icon: <PhoneIcon />, control: BasePhone, label: "Phone" },
+ attachment: {
+ icon: <AttachmentIcon />,
+ control: BaseAttachment,
+ label: "Attachment",
+ },
} as const;
type Mode = keyof typeof modes;
@@ -211,6 +234,10 @@ const propToMode = (prop?: UrlControlProps["prop"]): Mode => {
return "page";
}
+ if (prop.type === "asset") {
+ return "attachment";
+ }
+
if (prop.value.startsWith("tel:")) {
return "phone";
}
@@ -228,6 +255,7 @@ export const UrlControl = ({
propName,
onChange,
onDelete,
+ onSoftDelete,
}: UrlControlProps) => {
const [mode, setMode] = useState<Mode>(propToMode(prop));
@@ -267,7 +295,12 @@ export const UrlControl = ({
</ToggleGroup>
</Flex>
- <BaseControl id={id} prop={prop} onChange={onChange} />
+ <BaseControl
+ id={id}
+ prop={prop}
+ onChange={onChange}
+ onSoftDelete={onSoftDelete}
+ />
</VerticalLayout>
);
};
diff --git a/apps/builder/app/builder/features/props-panel/props-panel.stories.assets/beach.jpg b/apps/builder/app/builder/features/props-panel/props-panel.stories.assets/beach.jpg
new file mode 100644
index 0000000000..070c61b362
Binary files /dev/null and b/apps/builder/app/builder/features/props-panel/props-panel.stories.assets/beach.jpg differ
diff --git a/apps/builder/app/builder/features/props-panel/props-panel.stories.assets/car.png b/apps/builder/app/builder/features/props-panel/props-panel.stories.assets/car.png
new file mode 100644
index 0000000000..2bef8a9cf5
Binary files /dev/null and b/apps/builder/app/builder/features/props-panel/props-panel.stories.assets/car.png differ
diff --git a/apps/builder/app/builder/features/props-panel/props-panel.stories.assets/cat.jpg b/apps/builder/app/builder/features/props-panel/props-panel.stories.assets/cat.jpg
new file mode 100644
index 0000000000..9041aeef2a
Binary files /dev/null and b/apps/builder/app/builder/features/props-panel/props-panel.stories.assets/cat.jpg differ
diff --git a/apps/builder/app/builder/features/props-panel/props-panel.stories.tsx b/apps/builder/app/builder/features/props-panel/props-panel.stories.tsx
index d19642f2ea..00026d7b4e 100644
--- a/apps/builder/app/builder/features/props-panel/props-panel.stories.tsx
+++ b/apps/builder/app/builder/features/props-panel/props-panel.stories.tsx
@@ -3,6 +3,7 @@ import { ButtonElementIcon } from "@webstudio-is/icons";
import { PropsPanel } from "./props-panel";
import { usePropsLogic } from "./use-props-logic";
import { assetsStore, pagesStore } from "~/shared/nano-states";
+import { setMockEnv } from "~/shared/env";
import type { Prop } from "@webstudio-is/project-build";
import type {
WsComponentMeta,
@@ -10,6 +11,10 @@ import type {
} from "@webstudio-is/react-sdk";
import { textVariants } from "@webstudio-is/design-system";
import type { Asset } from "@webstudio-is/asset-uploader";
+// eslint-disable-next-line import/no-internal-modules
+import catPath from "./props-panel.stories.assets/cat.jpg";
+
+setMockEnv({ ASSET_BASE_URL: catPath.replace("cat.jpg", "") });
let id = 0;
const unique = () => `${++id}`;
@@ -35,7 +40,7 @@ pagesStore.set({
],
});
-const imageAsset = (name = "cat", format = "jpeg"): Asset => ({
+const imageAsset = (name = "cat", format = "jpg"): Asset => ({
id: unique(),
projectId,
type: "image",
@@ -166,6 +171,7 @@ const componentPropsMeta: WsComponentPropsMeta = {
addedUrlPage: urlProp("Added URL (Page)"),
addedUrlEmail: urlProp("Added URL (Email)"),
addedUrlPhone: urlProp("Added URL (Phone)"),
+ addedUrlAttachment: urlProp("Added URL (Attachment)"),
addedFile: fileProp(),
availableText: textProp(),
availableShortText: shortTextProp(),
@@ -277,6 +283,13 @@ const startingProps: Prop[] = [
type: "string",
value: "tel:+1234567890",
},
+ {
+ id: unique(),
+ instanceId,
+ name: "addedUrlAttachment",
+ type: "asset",
+ value: Array.from(assetsStore.get().keys() ?? [])[0] ?? "",
+ },
{
id: unique(),
instanceId,
diff --git a/apps/builder/app/builder/features/props-panel/use-props-logic.ts b/apps/builder/app/builder/features/props-panel/use-props-logic.ts
index 948b47d9d1..9617c8f846 100644
--- a/apps/builder/app/builder/features/props-panel/use-props-logic.ts
+++ b/apps/builder/app/builder/features/props-panel/use-props-logic.ts
@@ -155,32 +155,29 @@ export const usePropsLogic = ({
return { prop, propName: name, meta: known };
});
- // names of the props added by the user during the lifetime of the hook
- const [newNames, setNewNames] = useState<Prop["name"][]>([]);
-
- const oldAdded: PropAndMeta[] = Array.from(unprocessedSaved.values())
- .filter((prop) => newNames.includes(prop.name) === false)
- .map((prop) => {
- const known = getAndDelete(unprocessedKnown, prop.name);
- unprocessedSaved.delete(prop.name);
- return {
- prop,
- propName: prop.name,
-
- // @todo:
- // if meta is undefined, this means it's a "custom attribute"
- // but because custom attributes not implemented yet,
- // we'll show it as a regular optional prop for now
- meta: known ?? getDefaultMetaForType(prop.type),
- };
- });
+ // We keep track of names because sometime prop is in the list but not actually added/saved
+ // Also makes order stable etc.
+ const [addedNames, setAddedNames] = useState<Prop["name"][]>(() =>
+ Array.from(unprocessedSaved.values(), (prop) => prop.name)
+ );
- const newAdded: PropAndMeta[] = newNames.map((name) => {
+ const addedProps: PropAndMeta[] = addedNames.map((name) => {
const saved = getAndDelete(unprocessedSaved, name);
const known = getAndDelete(unprocessedKnown, name);
+ // @todo:
+ // if meta is undefined, this means it's a "custom attribute"
+ // but because custom attributes not implemented yet,
+ // we'll show it as a regular optional prop for now
if (known === undefined) {
- throw new Error(`Cannot find meta for a newly added prop "${name}`);
+ if (saved === undefined) {
+ throw new Error(`Cannot find meta for a newly added prop "${name}`);
+ }
+ return {
+ prop: saved,
+ propName: name,
+ meta: getDefaultMetaForType(saved.type),
+ };
}
return { prop: saved, propName: name, meta: known };
@@ -202,7 +199,7 @@ export const usePropsLogic = ({
if (prop) {
updateProp(prop);
}
- setNewNames((prev) => [...prev, propName]);
+ setAddedNames((prev) => [...prev, propName]);
};
const handleChange = ({ prop, propName }: PropOrName, value: PropValue) => {
@@ -217,7 +214,7 @@ export const usePropsLogic = ({
if (prop) {
deleteProp(prop.id);
}
- setNewNames((prev) => prev.filter((name) => propName !== name));
+ setAddedNames((prev) => prev.filter((name) => propName !== name));
};
const handleSoftDelete = (prop: Prop) => {
@@ -226,7 +223,7 @@ export const usePropsLogic = ({
return {
initialProps,
- addedProps: [...oldAdded, ...newAdded],
+ addedProps,
remainingProps: Array.from(unprocessedKnown.entries()).map(
([name, { label }]) => ({ name, label })
),
diff --git a/apps/builder/app/shared/env/env-getter.ts b/apps/builder/app/shared/env/env-getter.ts
index 2f102e5944..1a9b95c680 100644
--- a/apps/builder/app/shared/env/env-getter.ts
+++ b/apps/builder/app/shared/env/env-getter.ts
@@ -14,7 +14,7 @@ export default new Proxy(
? publicEnv[prop as keyof PublicEnv]
: undefined;
}
- const env = (window[namespace as never] ?? {}) as unknown as PublicEnv;
+ const env: Partial<PublicEnv> = window[namespace] ?? {};
return prop in env ? env[prop as keyof PublicEnv] : undefined;
},
}
diff --git a/apps/builder/app/shared/env/env.tsx b/apps/builder/app/shared/env/env.tsx
index 954efc81eb..8f4bcdaeba 100644
--- a/apps/builder/app/shared/env/env.tsx
+++ b/apps/builder/app/shared/env/env.tsx
@@ -1,5 +1,12 @@
import { useLoaderData } from "@remix-run/react";
import { namespace } from "./namespace";
+import type { PublicEnv } from "~/env/env.public.server";
+
+declare global {
+ interface Window {
+ [namespace]: Partial<PublicEnv> | undefined;
+ }
+}
// @todo remove once remix has a built-in way
// https://github.com/remix-run/remix/discussions/2769
@@ -14,3 +21,8 @@ export const Env = () => {
/>
);
};
+
+// For stories
+export const setMockEnv = (env: Partial<PublicEnv>) => {
+ window[namespace] = env;
+};
diff --git a/packages/react-sdk/src/app/custom-components/shared/remix-link.tsx b/packages/react-sdk/src/app/custom-components/shared/remix-link.tsx
index e6c15f21e3..0793d5c45a 100644
--- a/packages/react-sdk/src/app/custom-components/shared/remix-link.tsx
+++ b/packages/react-sdk/src/app/custom-components/shared/remix-link.tsx
@@ -11,11 +11,11 @@ export const wrapLinkComponent = (BaseLink: LinkComponent) => {
const Component: LinkComponent = forwardRef((props: LinkProps, ref) => {
const href = usePropUrl(getInstanceIdFromComponentProps(props), "href");
- if (typeof href === "string" || href === undefined) {
- return <BaseLink {...props} ref={ref} />;
+ if (href?.type === "page") {
+ return <RemixLink {...props} to={href.page.path} ref={ref} />;
}
- return <RemixLink {...props} to={href.path} ref={ref} />;
+ return <BaseLink {...props} ref={ref} />;
});
Component.displayName = BaseLink.displayName;
diff --git a/packages/react-sdk/src/components/link.tsx b/packages/react-sdk/src/components/link.tsx
index 560ec7fc9d..8b2c83b551 100644
--- a/packages/react-sdk/src/components/link.tsx
+++ b/packages/react-sdk/src/components/link.tsx
@@ -1,5 +1,6 @@
import { forwardRef, type ComponentProps } from "react";
import { usePropUrl, getInstanceIdFromComponentProps } from "../props";
+import { getParams } from "../app/params";
export const defaultTag = "a";
@@ -15,13 +16,22 @@ type Props = Omit<ComponentProps<"a">, "href" | "target"> & {
export const Link = forwardRef<HTMLAnchorElement, Props>((props, ref) => {
const href = usePropUrl(getInstanceIdFromComponentProps(props), "href");
- return (
- <a
- {...props}
- href={typeof href === "string" ? href : href?.path}
- ref={ref}
- />
- );
+
+ const { assetBaseUrl } = getParams();
+
+ let url: string | undefined;
+ switch (href?.type) {
+ case "page":
+ url = href.page.path;
+ break;
+ case "asset":
+ url = `${assetBaseUrl}${href.asset.name}`;
+ break;
+ case "string":
+ url = href.url;
+ }
+
+ return <a {...props} href={url} ref={ref} />;
});
Link.displayName = "Link";
diff --git a/packages/react-sdk/src/props.test.ts b/packages/react-sdk/src/props.test.ts
index edcd976803..6ada392502 100644
--- a/packages/react-sdk/src/props.test.ts
+++ b/packages/react-sdk/src/props.test.ts
@@ -1,11 +1,13 @@
import { describe, test, expect } from "@jest/globals";
import { resolveUrlProp, type Pages, type PropsByInstanceId } from "./props";
import type { Page, Prop } from "@webstudio-is/project-build";
+import type { Asset, Assets } from "@webstudio-is/asset-uploader";
const unique = () => Math.random().toString();
describe("resolveUrlProp", () => {
const instanceId = unique();
+ const projectId = unique();
const page1: Page = {
id: unique(),
@@ -25,6 +27,27 @@ describe("resolveUrlProp", () => {
rootInstanceId: "0",
};
+ const asset1: Asset = {
+ id: unique(),
+ name: unique(),
+ type: "image",
+ location: "REMOTE",
+ projectId,
+ format: "png",
+ size: 100000,
+ createdAt: new Date().toISOString(),
+ description: null,
+ meta: { width: 128, height: 180 },
+ };
+
+ const assetProp: Prop = {
+ type: "asset",
+ id: unique(),
+ instanceId,
+ name: unique(),
+ value: asset1.id,
+ };
+
const pageByIdProp: Prop = {
type: "page",
id: unique(),
@@ -49,8 +72,8 @@ describe("resolveUrlProp", () => {
value: unique(),
};
- const propsByInstanceId: PropsByInstanceId = new Map([
- [instanceId, [pageByIdProp, pageByPathProp, arbitraryUrlProp]],
+ const props: PropsByInstanceId = new Map([
+ [instanceId, [pageByIdProp, pageByPathProp, arbitraryUrlProp, assetProp]],
]);
const pages: Pages = new Map([
@@ -58,38 +81,45 @@ describe("resolveUrlProp", () => {
[page2.id, page2],
]);
+ const assets: Assets = new Map([[asset1.id, asset1]]);
+
+ const stores = { props, pages, assets };
+
test("if instanceId is unknown returns undefined", () => {
expect(
- resolveUrlProp("unknown", pageByIdProp.name, propsByInstanceId, pages)
+ resolveUrlProp("unknown", pageByIdProp.name, stores)
).toBeUndefined();
});
test("if prop name is unknown returns undefined", () => {
- expect(
- resolveUrlProp(instanceId, "unknown", propsByInstanceId, pages)
- ).toBeUndefined();
+ expect(resolveUrlProp(instanceId, "unknown", stores)).toBeUndefined();
+ });
+
+ test("asset by id", () => {
+ expect(resolveUrlProp(instanceId, assetProp.name, stores)).toEqual({
+ type: "asset",
+ asset: asset1,
+ });
});
test("page by id", () => {
- expect(
- resolveUrlProp(instanceId, pageByIdProp.name, propsByInstanceId, pages)
- ).toBe(page1);
+ expect(resolveUrlProp(instanceId, pageByIdProp.name, stores)).toEqual({
+ type: "page",
+ page: page1,
+ });
});
test("page by path", () => {
- expect(
- resolveUrlProp(instanceId, pageByPathProp.name, propsByInstanceId, pages)
- ).toBe(page2);
+ expect(resolveUrlProp(instanceId, pageByPathProp.name, stores)).toEqual({
+ type: "page",
+ page: page2,
+ });
});
test("arbitrary url", () => {
- expect(
- resolveUrlProp(
- instanceId,
- arbitraryUrlProp.name,
- propsByInstanceId,
- pages
- )
- ).toBe(arbitraryUrlProp.value);
+ expect(resolveUrlProp(instanceId, arbitraryUrlProp.name, stores)).toEqual({
+ type: "string",
+ url: arbitraryUrlProp.value,
+ });
});
});
diff --git a/packages/react-sdk/src/props.ts b/packages/react-sdk/src/props.ts
index 3c8ed58908..5572f7b81e 100644
--- a/packages/react-sdk/src/props.ts
+++ b/packages/react-sdk/src/props.ts
@@ -2,6 +2,7 @@ import { useContext, useMemo } from "react";
import { computed } from "nanostores";
import { useStore } from "@nanostores/react";
import type { Instance, Page, Prop, Props } from "@webstudio-is/project-build";
+import type { Asset, Assets } from "@webstudio-is/asset-uploader";
import { ReactSdkContext } from "./context";
import { idAttribute } from "./tree/webstudio-component";
@@ -67,10 +68,17 @@ export const usePropAsset = (instanceId: Instance["id"], name: string) => {
export const resolveUrlProp = (
instanceId: Instance["id"],
name: string,
- propsByInstanceId: PropsByInstanceId,
- pages: Pages
-): Page | string | undefined => {
- const instanceProps = propsByInstanceId.get(instanceId);
+ {
+ props,
+ pages,
+ assets,
+ }: { props: PropsByInstanceId; pages: Pages; assets: Assets }
+):
+ | { type: "page"; page: Page }
+ | { type: "asset"; asset: Asset }
+ | { type: "string"; url: string }
+ | undefined => {
+ const instanceProps = props.get(instanceId);
if (instanceProps === undefined) {
return;
}
@@ -80,16 +88,22 @@ export const resolveUrlProp = (
}
if (prop.type === "page") {
- return pages.get(prop.value);
+ const page = pages.get(prop.value);
+ return page && { type: "page", page };
}
if (prop.type === "string") {
for (const page of pages.values()) {
if (page.path === prop.value) {
- return page;
+ return { type: "page", page };
}
}
- return prop.value;
+ return { type: "string", url: prop.value };
+ }
+
+ if (prop.type === "asset") {
+ const asset = assets.get(prop.value);
+ return asset && { type: "asset", asset };
}
return;
@@ -99,15 +113,16 @@ export const resolveUrlProp = (
// this utility is used for link component in both builder and preview
// so need to optimize rerenders with computed
export const usePropUrl = (instanceId: Instance["id"], name: string) => {
- const { propsByInstanceIdStore, pagesStore } = useContext(ReactSdkContext);
+ const { propsByInstanceIdStore, pagesStore, assetsStore } =
+ useContext(ReactSdkContext);
const pageStore = useMemo(
() =>
computed(
- [propsByInstanceIdStore, pagesStore],
- (propsByInstanceId, pages) =>
- resolveUrlProp(instanceId, name, propsByInstanceId, pages)
+ [propsByInstanceIdStore, pagesStore, assetsStore],
+ (props, pages, assets) =>
+ resolveUrlProp(instanceId, name, { props, pages, assets })
),
- [propsByInstanceIdStore, pagesStore, instanceId, name]
+ [propsByInstanceIdStore, pagesStore, assetsStore, instanceId, name]
);
return useStore(pageStore);
};