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.

feat: Image Manager drag/drop suport (#3505)

Ivan Starkov0e1d1cf9632e
diff --git a/apps/builder/app/builder/features/workspace/canvas-iframe.tsx b/apps/builder/app/builder/features/workspace/canvas-iframe.tsx
index 59e098408b..3f46b9b368 100644
--- a/apps/builder/app/builder/features/workspace/canvas-iframe.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-iframe.tsx
@@ -4,6 +4,8 @@ import {
css,
canvasPointerEventsPropertyName,
} from "@webstudio-is/design-system";
+import { useUnmount } from "~/shared/hook-utils/use-mount";
+import { $canvasIframeState } from "~/shared/nano-states";
const iframeStyle = css({
border: "none",
@@ -16,6 +18,11 @@ type CanvasIframeProps = {
export const CanvasIframe = forwardRef<HTMLIFrameElement, CanvasIframeProps>(
({ css, ...rest }, ref) => {
+ useUnmount(() => {
+ // Unmount does't work inside iframe.
+ $canvasIframeState.set("idle");
+ });
+
return <iframe {...rest} ref={ref} className={iframeStyle({ css })} />;
}
);
diff --git a/apps/builder/app/builder/shared/assets/asset-upload.tsx b/apps/builder/app/builder/shared/assets/asset-upload.tsx
index 19ecf207d7..1520b3e11f 100644
--- a/apps/builder/app/builder/shared/assets/asset-upload.tsx
+++ b/apps/builder/app/builder/shared/assets/asset-upload.tsx
@@ -61,6 +61,33 @@ const acceptMap = {
font: FONT_MIME_TYPES,
};
+// https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/accept#unique_file_type_specifiers
+const acceptFileTypeSpecifier = (specifiers: string, file: File) => {
+ const specifierArray = specifiers
+ .split(",")
+ .map((specifier) => specifier.trim());
+
+ return specifierArray.some((specifier) => {
+ if (specifier.startsWith(".")) {
+ return file.name.endsWith(specifier);
+ }
+
+ return specifier === file.type;
+ });
+};
+
+export const acceptUploadType = (
+ assetType: AssetType,
+ accept: string | undefined,
+ file: File
+) => {
+ if (accept !== undefined) {
+ acceptFileTypeSpecifier(accept, file);
+ }
+
+ return acceptFileTypeSpecifier(acceptMap[assetType], file);
+};
+
type AssetUploadProps = {
type: AssetType;
accept?: string;
diff --git a/apps/builder/app/builder/shared/assets/assets-shell.tsx b/apps/builder/app/builder/shared/assets/assets-shell.tsx
index 35855f99dc..88949e8202 100644
--- a/apps/builder/app/builder/shared/assets/assets-shell.tsx
+++ b/apps/builder/app/builder/shared/assets/assets-shell.tsx
@@ -1,14 +1,33 @@
-import type { ComponentProps } from "react";
+import { useEffect, useRef, useState, type ComponentProps } from "react";
import type { AssetType } from "@webstudio-is/asset-uploader";
import {
Flex,
ScrollArea,
SearchField,
+ Text,
theme,
} from "@webstudio-is/design-system";
-import { AssetUpload } from "./asset-upload";
+import { AssetUpload, acceptUploadType } from "./asset-upload";
import { NotFound } from "./not-found";
import { Separator } from "./separator";
+import { combine } from "@atlaskit/pragmatic-drag-and-drop/combine";
+import {
+ containsFiles,
+ getFiles,
+} from "@atlaskit/pragmatic-drag-and-drop/external/file";
+import {
+ dropTargetForExternal,
+ monitorForExternal,
+} from "@atlaskit/pragmatic-drag-and-drop/external/adapter";
+import { preventUnhandled } from "@atlaskit/pragmatic-drag-and-drop/prevent-unhandled";
+import invariant from "tiny-invariant";
+import type { ContainsSource } from "@atlaskit/pragmatic-drag-and-drop/dist/types/public-utils/external/native-types";
+import { canvasApi } from "~/shared/canvas-api";
+import { useDebouncedCallback } from "use-debounce";
+import { $canvasIframeState } from "~/shared/nano-states";
+import { isFeatureEnabled } from "@webstudio-is/feature-flags";
+import { useUploadAsset } from "./use-assets";
+import { UploadIcon } from "@webstudio-is/icons";
type AssetsShellProps = {
searchProps: ComponentProps<typeof SearchField>;
@@ -18,6 +37,22 @@ type AssetsShellProps = {
isEmpty: boolean;
};
+const containsFilesOrUri = (parameter: ContainsSource) => {
+ if (false === isFeatureEnabled("assetDragSupport")) {
+ return false;
+ }
+
+ return (
+ containsFiles(parameter) || parameter.source.types.includes("text/uri-list")
+ );
+};
+
+const IDLE = 0;
+const POTENTIAL = 1;
+const OVER = 2;
+
+type DRAG_STATE = typeof IDLE | typeof POTENTIAL | typeof OVER;
+
export const AssetsShell = ({
searchProps,
isEmpty,
@@ -25,12 +60,148 @@ export const AssetsShell = ({
type,
accept,
}: AssetsShellProps) => {
+ const ref = useRef<HTMLDivElement>(null);
+ const [state, setState] = useState<DRAG_STATE>(IDLE);
+ const [canvasState, setCanvasState] = useState<DRAG_STATE>(IDLE);
+ const [refresh, setRefresh] = useState(0);
+ const uploadAssets = useUploadAsset();
+
+ const handleBuilderOnDrop = useDebouncedCallback(() => {
+ setState(IDLE);
+ }, 300);
+
+ const handleCanvasOnDrop = useDebouncedCallback(() => {
+ setCanvasState(IDLE);
+ }, 300);
+
+ const preventUnhandledStop = useDebouncedCallback(() => {
+ preventUnhandled.stop();
+ canvasApi.preventUnhandled.stop();
+ }, 300);
+
+ useEffect(() => {
+ if (false === canvasApi.isInitialized()) {
+ return $canvasIframeState.listen((state) => {
+ if (state === "ready") {
+ setRefresh((prev) => prev + 1);
+ }
+ });
+ }
+
+ const element = ref.current;
+
+ invariant(element);
+
+ const preventUnhandledStart = () => {
+ preventUnhandled.start();
+ canvasApi.preventUnhandled.start();
+ };
+
+ // Do not react if any dialog is opened above
+ const isBlockedByBackdrop = (
+ blocked: typeof containsFilesOrUri,
+ notBlocked: typeof containsFilesOrUri
+ ) => {
+ return (parameter: ContainsSource) => {
+ const elementRect = element.getBoundingClientRect();
+ const centerX = elementRect.left + elementRect.width / 2;
+ const centerY = elementRect.top + elementRect.height / 2;
+
+ // Get the element directly under the center of the target element
+ const topElement = document.elementFromPoint(centerX, centerY);
+
+ const isNotBlocked =
+ element.contains(topElement) || topElement === element;
+
+ // Check if this element is the original element or its descendant
+ return isNotBlocked ? notBlocked(parameter) : blocked(parameter);
+ };
+ };
+
+ return combine(
+ dropTargetForExternal({
+ element: element,
+ canDrop: isBlockedByBackdrop(() => false, containsFilesOrUri),
+ onDragEnter: () => setState(OVER),
+ onDragLeave: () => setState(POTENTIAL),
+ onDrop: async ({ source }) => {
+ const droppedFiles = await getFiles({ source });
+
+ const files = droppedFiles
+ .filter((file) => file != null)
+ .filter((file) => {
+ if (acceptUploadType(type, accept, file)) {
+ return true;
+ }
+
+ // eslint-disable-next-line no-console
+ console.warn(
+ `Unsupported file dropped for type=${type}, accept=${accept} and file.type=${file.type}, file.name=${file.name}`
+ );
+ return false;
+ });
+
+ if (files.length === 0) {
+ return;
+ }
+
+ uploadAssets(type, files);
+ },
+ }),
+ monitorForExternal({
+ canMonitor: isBlockedByBackdrop(() => false, containsFilesOrUri),
+ onDragStart: () => {
+ preventUnhandledStart();
+ setState(POTENTIAL);
+ handleBuilderOnDrop.cancel();
+ preventUnhandledStop.cancel();
+ },
+ onDrop: () => {
+ handleBuilderOnDrop();
+ preventUnhandledStop();
+ },
+ }),
+ canvasApi.monitorForExternal({
+ canMonitor: isBlockedByBackdrop(() => false, containsFilesOrUri),
+ onDragStart: () => {
+ preventUnhandledStart();
+ setCanvasState(POTENTIAL);
+ handleCanvasOnDrop.cancel();
+ preventUnhandledStop.cancel();
+ },
+ onDrop: () => {
+ handleCanvasOnDrop();
+ preventUnhandledStop();
+ },
+ }),
+ () => {
+ return () => {
+ preventUnhandled.stop();
+ canvasApi.preventUnhandled.stop();
+ };
+ }
+ );
+ }, [
+ accept,
+ handleBuilderOnDrop,
+ handleCanvasOnDrop,
+ preventUnhandledStop,
+ refresh,
+ type,
+ uploadAssets,
+ ]);
+
+ const dragState = Math.max(state, canvasState);
+
return (
<Flex
+ ref={ref}
direction="column"
css={{
overflow: "hidden",
py: theme.spacing[5],
+ flex: 1,
+ position: "relative",
}}
>
<Flex
@@ -47,6 +218,35 @@ export const AssetsShell = ({
<ScrollArea css={{ display: "flex", flexDirection: "column" }}>
{children}
</ScrollArea>
+ <Flex
+ css={{
+ position: "absolute",
+ inset: 0,
+ display: dragState !== IDLE ? "flex" : "none",
+ backgroundColor: theme.colors.background,
+ opacity: 0.85,
+ color:
+ dragState === OVER
+ ? theme.colors.foregroundMain
+ : theme.colors.foregroundSubtle,
+ }}
+ >
+ <Flex
+ align="center"
+ justify="center"
+ css={{
+ position: "absolute",
+ inset: theme.spacing[4],
+ border: `2px dashed ${dragState === OVER ? theme.colors.foregroundMain : theme.colors.foregroundMoreSubtle}`,
+ }}
+ >
+ <Flex align={"center"} gap={1}>
+ <UploadIcon />
+
+ <Text variant={"regularBold"}>Drop files here</Text>
+ </Flex>
+ </Flex>
+ </Flex>
</Flex>
);
};
diff --git a/apps/builder/app/builder/shared/assets/use-assets.tsx b/apps/builder/app/builder/shared/assets/use-assets.tsx
index c77a503ed4..c1227891f4 100644
--- a/apps/builder/app/builder/shared/assets/use-assets.tsx
+++ b/apps/builder/app/builder/shared/assets/use-assets.tsx
@@ -15,6 +15,7 @@ import type { ActionData } from "~/builder/shared/assets";
import { $assets, $authToken, $project } from "~/shared/nano-states";
import { atom, computed } from "nanostores";
import { serverSyncStore } from "~/shared/sync";
+import { useEffectEvent } from "~/shared/hook-utils/effect-event";
export const deleteAssets = (assetIds: Asset["id"][]) => {
serverSyncStore.createTransaction([$assets], (assets) => {
@@ -199,7 +200,7 @@ export const useUploadAsset = () => {
}
};
- return uploadAssets;
+ return useEffectEvent(uploadAssets);
};
const filterByType = (assetContainers: AssetContainer[], type: AssetType) => {
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsx
index d1df7f850c..42fd30b5fd 100644
--- a/apps/builder/app/canvas/canvas.tsx
+++ b/apps/builder/app/canvas/canvas.tsx
@@ -179,9 +179,7 @@ export const Canvas = ({ params, imageLoader }: CanvasProps) => {
$params.set(params);
});
- useMount(() => {
- initCanvasApi();
- });
+ useMount(initCanvasApi);
useLayoutEffect(() => {
mountStyles();
diff --git a/apps/builder/app/shared/canvas-api.ts b/apps/builder/app/shared/canvas-api.ts
index 6da13a9dc9..ca5e01c8b3 100644
--- a/apps/builder/app/shared/canvas-api.ts
+++ b/apps/builder/app/shared/canvas-api.ts
@@ -1,10 +1,18 @@
+import { preventUnhandled } from "@atlaskit/pragmatic-drag-and-drop/prevent-unhandled";
import { setInert, resetInert } from "../canvas/shared/inert";
+import { monitorForExternal } from "@atlaskit/pragmatic-drag-and-drop/external/adapter";
+import { createRecursiveProxy } from "@trpc/server/shared";
+import invariant from "tiny-invariant";
+import { $canvasIframeState } from "./nano-states";
const apiWindowNamespace = "__webstudio__$__canvasApi";
const _canvasApi = {
+ isInitialized: () => true,
setInert,
resetInert,
+ preventUnhandled,
+ monitorForExternal,
};
declare global {
@@ -34,7 +42,7 @@ const getIframeApi = () => {
}
}
- throw new Error("Iframe or API not found");
+ return;
}
};
@@ -47,27 +55,55 @@ const isKeyOf = <T>(key: unknown, obj: T): key is keyof T => {
/**
* Forwards the call from the builder to the iframe, invoking the original API in the iframe.
*/
-export const canvasApi = new Proxy(_canvasApi, {
- get(_target, prop) {
- if (typeof prop === "symbol") {
- throw new Error("Symbol properties are not supported");
+export const canvasApi = createRecursiveProxy((options) => {
+ const api = getIframeApi();
+
+ if (api == null) {
+ if (
+ options.path.join(".") ===
+ ("isInitialized" satisfies keyof typeof _canvasApi)
+ ) {
+ return false;
}
- const api = getIframeApi();
+ // eslint-disable-next-line no-console
+ console.warn(
+ `API not found in the iframe, skipping ${options.path.join(".")} call, iframe probably not loaded yet`
+ );
+ return null;
+ }
+
+ let currentMethod = api as unknown;
- if (api && isKeyOf(prop, api)) {
- return api[prop].bind(api);
- } else {
- throw new Error(`API method ${prop} not found`);
- }
- },
-});
+ for (const key of options.path) {
+ invariant(
+ isKeyOf(key, currentMethod),
+ `API method ${options.path.join(".")} not found`
+ );
+ invariant(typeof currentMethod === "object");
+ invariant(currentMethod != null);
+
+ currentMethod = currentMethod[key];
+ }
+
+ invariant(
+ typeof currentMethod === "function",
+ `API method ${options.path.join(".")} is not a function`
+ );
+
+ return currentMethod.call(null, ...options.args);
+}) as typeof _canvasApi;
/**
* Initializes the canvas API in the iframe. Must be called in the iframe context.
*/
export const initCanvasApi = () => {
if (isInIframe()) {
+ $canvasIframeState.set("ready");
window[apiWindowNamespace] = _canvasApi;
}
+ return () => {
+ // Does not work as expected, because the iframe is detached from the builder
+ $canvasIframeState.set("idle");
+ };
};
diff --git a/apps/builder/app/shared/nano-states/canvas.ts b/apps/builder/app/shared/nano-states/canvas.ts
index 5161e85b08..164842b18a 100644
--- a/apps/builder/app/shared/nano-states/canvas.ts
+++ b/apps/builder/app/shared/nano-states/canvas.ts
@@ -69,3 +69,5 @@ export const synchronizedCanvasStores = [
["$collaborativeInstanceSelector", $collaborativeInstanceSelector],
["$collaborativeInstanceRect", $collaborativeInstanceRect],
] as const;
+
+export const $canvasIframeState = atom<"idle" | "ready">("idle");
diff --git a/apps/builder/app/shared/sync/sync-stores.ts b/apps/builder/app/shared/sync/sync-stores.ts
index 2a56749b64..9d0f08e2f1 100644
--- a/apps/builder/app/shared/sync/sync-stores.ts
+++ b/apps/builder/app/shared/sync/sync-stores.ts
@@ -38,6 +38,7 @@ import {
$resources,
$resourceValues,
$marketplaceProduct,
+ $canvasIframeState,
} from "~/shared/nano-states";
import { $ephemeralStyles } from "~/canvas/stores";
@@ -118,6 +119,7 @@ export const registerContainers = () => {
clientStores.set("dragAndDropState", $dragAndDropState);
clientStores.set("ephemeralStyles", $ephemeralStyles);
clientStores.set("selectedInstanceStates", $selectedInstanceStates);
+ clientStores.set("canvasIframeState", $canvasIframeState);
for (const [name, store] of $synchronizedBreakpoints) {
clientStores.set(name, store);
diff --git a/apps/builder/package.json b/apps/builder/package.json
index a8b6fd897c..ef89c0a259 100644
--- a/apps/builder/package.json
+++ b/apps/builder/package.json
@@ -19,6 +19,7 @@
"middleware:dev": "tsx watch --env-file=.env.preview ./middleware.js"
},
"dependencies": {
+ "@atlaskit/pragmatic-drag-and-drop": "^1.1.11",
"@codemirror/autocomplete": "^6.16.2",
"@codemirror/commands": "^6.5.0",
"@codemirror/lang-html": "^6.4.9",
@@ -113,6 +114,7 @@
"shallow-equal": "^3.1.0",
"slugify": "^1.6.6",
"strip-indent": "^4.0.0",
+ "tiny-invariant": "^1.3.3",
"title-case": "^4.1.0",
"ultraflag": "^0.1.0",
"untruncate-json": "^0.0.1",
diff --git a/packages/feature-flags/src/flags.ts b/packages/feature-flags/src/flags.ts
index 03cd16f3b5..a398f9cc3b 100644
--- a/packages/feature-flags/src/flags.ts
+++ b/packages/feature-flags/src/flags.ts
@@ -8,3 +8,4 @@ export const cssVars = false;
export const filters = false;
export const xmlElement = false;
export const pasteFromWebflow = false;
+export const assetDragSupport = false;
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 6791c4e7e8..9497020d7e 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -104,6 +104,9 @@ importers:
apps/builder:
dependencies:
+ '@atlaskit/pragmatic-drag-and-drop':
+ specifier: ^1.1.11
+ version: 1.1.11
'@codemirror/autocomplete':
specifier: ^6.16.2
version: 6.16.2(@codemirror/[email protected])(@codemirror/[email protected])(@codemirror/[email protected])(@lezer/[email protected])
@@ -386,6 +389,9 @@ importers:
strip-indent:
specifier: ^4.0.0
version: 4.0.0
+ tiny-invariant:
+ specifier: ^1.3.3
+ version: 1.3.3
title-case:
specifier: ^4.1.0
version: 4.1.0
@@ -2043,6 +2049,9 @@ packages:
resolution: {integrity: sha512-lFMjJTrFL3j7L9yBxwYfCq2k6qqwHyzuUl/XBnif78PWTJYyL/dfowQHWE3sp6U6ZzqWiiIZnpTMO96zhkjwtg==}
engines: {node: '>=6.0.0'}
+ '@atlaskit/[email protected]':
+ resolution: {integrity: sha512-oAwMGM68d7PrAHvcgwzJbOtZJKW6BJsc2eDWfVWb7W+lGo8tWDIFdMSmR2K+EczV03lXgdnQbRWDMcOrZ/98mQ==}
+
'@aw-web-design/[email protected]':
resolution: {integrity: sha512-Xk1sIhyNC/esHGGVjL/niHLowM0csl/kFO5uawBy4IrWwy0o1G8LGt3jP6nmWGz+USxeeqbihAmp/oVZju6wug==}
hasBin: true
@@ -5810,6 +5819,9 @@ packages:
resolution: {integrity: sha512-jDctJ/IVQbZoJykoeHbhXpOlNBqGNcwXJKJog42E5HDPUwQTSdjCHdihjj0DlnheQ7blbT6dHOafNAiS8ooQKA==}
engines: {node: '>=8'}
+ resolution: {integrity: sha512-PJvH288AWQhKs2v9zyfYdPzlPqf5bXbGMmhmUIY9x4dAUGIWgomO771oBQNwJnMQSnUIXhKu6sgzpBRXTlvb8Q==}
+
resolution: {integrity: sha512-1W07cM9gS6DcLperZfFSj+bWLtaPGSOHWhPiGzXmvVJbRLdG82sH/Kn8EtW1VqWVA54AKf2h5k5BbnIbwF3h6w==}
@@ -8685,6 +8697,9 @@ packages:
resolution: {integrity: sha512-iHZWu+q3IdFZFX36ro/lKBkSvfkztY5Y7HMiPlOUjhupPcG2JMfst2KKEpu5XndviX/3UhFbRngUPNKtgvtZiA==}
+ resolution: {integrity: sha512-tQkJl2GRWh83ui2DiPTJz9wEiMN20syf+5oKfB03yYP7ioZcJwsIK8FjrtLwH1m7C7e+Tt2yYBlrOpdT+dyeIQ==}
+
resolution: {integrity: sha512-BBea6L67bYLtdbOqfp8f58fPMqEwx0doL+pAi8TZyp2YWz8R9G8z9x75CZI8W+ftqhFHCpEX2cRnUUXK130iKA==}
@@ -10099,6 +10114,12 @@ snapshots:
'@jridgewell/gen-mapping': 0.3.2
'@jridgewell/trace-mapping': 0.3.18
+ '@atlaskit/[email protected]':
+ dependencies:
+ '@babel/runtime': 7.22.3
+ bind-event-listener: 3.0.0
+ raf-schd: 4.0.3
+
'@aw-web-design/[email protected]':
dependencies:
default-browser-id: 3.0.0
@@ -14713,6 +14734,8 @@ snapshots:
+
dependencies:
buffer: 5.7.1
@@ -18337,6 +18360,8 @@ snapshots:
dependencies:
inherits: 2.0.4
+