Skip to content

armgit / plane

Public Imported from GitHub
0

πŸ”₯πŸ”₯πŸ”₯ Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.

[PE-46] fix: added aspect ratio to resizing (#5693)

M. Palanikannanbfef0e89e068
diff --git a/packages/editor/src/core/components/editors/editor-container.tsx b/packages/editor/src/core/components/editors/editor-container.tsx
index 2e6ad52503..e070d7e45e 100644
--- a/packages/editor/src/core/components/editors/editor-container.tsx
+++ b/packages/editor/src/core/components/editors/editor-container.tsx
@@ -18,7 +18,8 @@ interface EditorContainerProps {
export const EditorContainer: FC<EditorContainerProps> = (props) => {
const { children, displayConfig, editor, editorContainerClassName, id } = props;
- const handleContainerClick = () => {
+ const handleContainerClick = (event: React.MouseEvent<HTMLDivElement, MouseEvent>) => {
+ if (event.target !== event.currentTarget) return;
if (!editor) return;
if (!editor.isEditable) return;
try {
diff --git a/packages/editor/src/core/components/menus/menu-items.ts b/packages/editor/src/core/components/menus/menu-items.ts
index 6f3ae179f9..cf10081f1e 100644
--- a/packages/editor/src/core/components/menus/menu-items.ts
+++ b/packages/editor/src/core/components/menus/menu-items.ts
@@ -23,6 +23,7 @@ import {
} from "lucide-react";
// helpers
import {
+ insertImage,
insertTableCommand,
setText,
toggleBlockquote,
@@ -193,8 +194,7 @@ export const ImageItem = (editor: Editor) =>
key: "image",
name: "Image",
isActive: () => editor?.isActive("image") || editor?.isActive("imageComponent"),
- command: (savedSelection: Selection | null) =>
- editor?.commands.setImageUpload({ event: "insert", pos: savedSelection?.from }),
+ command: (savedSelection: Selection | null) => insertImage({ editor, event: "insert", pos: savedSelection?.from }),
icon: ImageIcon,
}) as const;
diff --git a/packages/editor/src/core/extensions/custom-image/components/image-block.tsx b/packages/editor/src/core/extensions/custom-image/components/image-block.tsx
index 34e936c723..42b51de5fb 100644
--- a/packages/editor/src/core/extensions/custom-image/components/image-block.tsx
+++ b/packages/editor/src/core/extensions/custom-image/components/image-block.tsx
@@ -7,105 +7,169 @@ import { cn } from "@/helpers/common";
const MIN_SIZE = 100;
-export const CustomImageBlock: React.FC<CustomImageNodeViewProps> = (props) => {
- const { node, updateAttributes, selected, getPos, editor } = props;
- const { src, width, height } = node.attrs;
+type Pixel = `${number}px`;
- const [size, setSize] = useState({
- width: width?.toString() || "35%",
- height: height?.toString() || "auto",
+type PixelAttribute<TDefault> = Pixel | TDefault;
+
+export type ImageAttributes = {
+ src: string | null;
+ width: PixelAttribute<"35%" | number>;
+ height: PixelAttribute<"auto" | number>;
+ aspectRatio: number | null;
+ id: string | null;
+};
+
+type Size = {
+ width: PixelAttribute<"35%">;
+ height: PixelAttribute<"auto">;
+ aspectRatio: number | null;
+};
+
+const ensurePixelString = <TDefault,>(value: Pixel | TDefault | number | undefined | null, defaultValue?: TDefault) => {
+ if (!value || value === defaultValue) {
+ return defaultValue;
+ }
+
+ if (typeof value === "number") {
+ return `${value}px` satisfies Pixel;
+ }
+
+ return value;
+};
+
+type CustomImageBlockProps = CustomImageNodeViewProps & {
+ imageFromFileSystem: string;
+ setFailedToLoadImage: (isError: boolean) => void;
+ editorContainer: HTMLDivElement | null;
+ setEditorContainer: (editorContainer: HTMLDivElement | null) => void;
+};
+
+export const CustomImageBlock: React.FC<CustomImageBlockProps> = (props) => {
+ // props
+ const {
+ node,
+ updateAttributes,
+ setFailedToLoadImage,
+ imageFromFileSystem,
+ selected,
+ getPos,
+ editor,
+ editorContainer,
+ setEditorContainer,
+ } = props;
+ const { src: remoteImageSrc, width, height, aspectRatio } = node.attrs;
+ // states
+ const [size, setSize] = useState<Size>({
+ width: ensurePixelString(width, "35%"),
+ height: ensurePixelString(height, "auto"),
+ aspectRatio: aspectRatio || 1,
});
- const [isLoading, setIsLoading] = useState(true);
+ const [isResizing, setIsResizing] = useState(false);
const [initialResizeComplete, setInitialResizeComplete] = useState(false);
- const isShimmerVisible = isLoading || !initialResizeComplete;
- const [editorContainer, setEditorContainer] = useState<HTMLElement | null>(null);
-
+ // refs
const containerRef = useRef<HTMLDivElement>(null);
const containerRect = useRef<DOMRect | null>(null);
const imageRef = useRef<HTMLImageElement>(null);
- const isResizing = useRef(false);
- const aspectRatioRef = useRef<number | null>(null);
- useLayoutEffect(() => {
- if (imageRef.current) {
- const img = imageRef.current;
- img.onload = () => {
- const closestEditorContainer = img.closest(".editor-container");
- if (!closestEditorContainer) {
- console.error("Editor container not found");
- return;
- }
-
- setEditorContainer(closestEditorContainer as HTMLElement);
-
- if (width === "35%") {
- const editorWidth = closestEditorContainer.clientWidth;
- const initialWidth = Math.max(editorWidth * 0.35, MIN_SIZE);
- const aspectRatio = img.naturalWidth / img.naturalHeight;
- const initialHeight = initialWidth / aspectRatio;
-
- const newSize = {
- width: `${Math.round(initialWidth)}px`,
- height: `${Math.round(initialHeight)}px`,
- };
-
- setSize(newSize);
- updateAttributes(newSize);
- }
- setInitialResizeComplete(true);
- setIsLoading(false);
+ const handleImageLoad = useCallback(() => {
+ const img = imageRef.current;
+ if (!img) return;
+ let closestEditorContainer: HTMLDivElement | null = null;
+
+ if (editorContainer) {
+ closestEditorContainer = editorContainer;
+ } else {
+ closestEditorContainer = img.closest(".editor-container") as HTMLDivElement | null;
+ if (!closestEditorContainer) {
+ console.error("Editor container not found");
+ return;
+ }
+ }
+ if (!closestEditorContainer) {
+ console.error("Editor container not found");
+ return;
+ }
+
+ setEditorContainer(closestEditorContainer);
+ const aspectRatio = img.naturalWidth / img.naturalHeight;
+
+ if (width === "35%") {
+ const editorWidth = closestEditorContainer.clientWidth;
+ const initialWidth = Math.max(editorWidth * 0.35, MIN_SIZE);
+ const initialHeight = initialWidth / aspectRatio;
+
+ const initialComputedSize = {
+ width: `${Math.round(initialWidth)}px` satisfies Pixel,
+ height: `${Math.round(initialHeight)}px` satisfies Pixel,
+ aspectRatio: aspectRatio,
};
+
+ setSize(initialComputedSize);
+ updateAttributes(initialComputedSize);
+ } else {
+ // as the aspect ratio in not stored for old images, we need to update the attrs
+ setSize((prevSize) => {
+ const newSize = { ...prevSize, aspectRatio };
+ updateAttributes(newSize);
+ return newSize;
+ });
}
- }, [width, height, updateAttributes]);
+ setInitialResizeComplete(true);
+ }, [width, updateAttributes, editorContainer]);
+ // for real time resizing
useLayoutEffect(() => {
- setSize({
- width: width?.toString(),
- height: height?.toString(),
- });
+ setSize((prevSize) => ({
+ ...prevSize,
+ width: ensurePixelString(width),
+ height: ensurePixelString(height),
+ }));
}, [width, height]);
- const handleResizeStart = useCallback(
- (e: React.MouseEvent | React.TouchEvent) => {
- e.preventDefault();
- e.stopPropagation();
- isResizing.current = true;
- if (containerRef.current && editorContainer) {
- aspectRatioRef.current = Number(size.width.replace("px", "")) / Number(size.height.replace("px", ""));
- containerRect.current = containerRef.current.getBoundingClientRect();
- }
- },
- [size, editorContainer]
- );
-
const handleResize = useCallback(
(e: MouseEvent | TouchEvent) => {
- if (!isResizing.current || !containerRef.current || !containerRect.current) return;
-
- if (size) {
- aspectRatioRef.current = Number(size.width.replace("px", "")) / Number(size.height.replace("px", ""));
- }
-
- if (!aspectRatioRef.current) return;
+ if (!containerRef.current || !containerRect.current || !size.aspectRatio) return;
const clientX = "touches" in e ? e.touches[0].clientX : e.clientX;
const newWidth = Math.max(clientX - containerRect.current.left, MIN_SIZE);
- const newHeight = newWidth / aspectRatioRef.current;
+ const newHeight = newWidth / size.aspectRatio;
- setSize({ width: `${newWidth}px`, height: `${newHeight}px` });
+ setSize((prevSize) => ({ ...prevSize, width: `${newWidth}px`, height: `${newHeight}px` }));
},
[size]
);
const handleResizeEnd = useCallback(() => {
- if (isResizing.current) {
- isResizing.current = false;
- updateAttributes(size);
- }
+ setIsResizing(false);
+ updateAttributes(size);
}, [size, updateAttributes]);
- const handleMouseDown = useCallback(
+ const handleResizeStart = useCallback((e: React.MouseEvent | React.TouchEvent) => {
+ e.preventDefault();
+ e.stopPropagation();
+ setIsResizing(true);
+
+ if (containerRef.current) {
+ containerRect.current = containerRef.current.getBoundingClientRect();
+ }
+ }, []);
+
+ useEffect(() => {
+ if (isResizing) {
+ window.addEventListener("mousemove", handleResize);
+ window.addEventListener("mouseup", handleResizeEnd);
+ window.addEventListener("mouseleave", handleResizeEnd);
+
+ return () => {
+ window.removeEventListener("mousemove", handleResize);
+ window.removeEventListener("mouseup", handleResizeEnd);
+ window.removeEventListener("mouseleave", handleResizeEnd);
+ };
+ }
+ }, [isResizing, handleResize, handleResizeEnd]);
+
+ const handleImageMouseDown = useCallback(
(e: React.MouseEvent) => {
e.stopPropagation();
const pos = getPos();
@@ -115,65 +179,86 @@ export const CustomImageBlock: React.FC<CustomImageNodeViewProps> = (props) => {
[editor, getPos]
);
- useEffect(() => {
- if (!editorContainer) return;
-
- const handleMouseMove = (e: MouseEvent) => handleResize(e);
- const handleMouseUp = () => handleResizeEnd();
- const handleMouseLeave = () => handleResizeEnd();
-
- editorContainer.addEventListener("mousemove", handleMouseMove);
- editorContainer.addEventListener("mouseup", handleMouseUp);
- editorContainer.addEventListener("mouseleave", handleMouseLeave);
-
- return () => {
- editorContainer.removeEventListener("mousemove", handleMouseMove);
- editorContainer.removeEventListener("mouseup", handleMouseUp);
- editorContainer.removeEventListener("mouseleave", handleMouseLeave);
- };
- }, [handleResize, handleResizeEnd, editorContainer]);
+ // show the image loader if the remote image's src or preview image from filesystem is not set yet (while loading the image post upload) (or)
+ // if the initial resize (from 35% width and "auto" height attrs to the actual size in px) is not complete
+ const showImageLoader = !(remoteImageSrc || imageFromFileSystem) || !initialResizeComplete;
+ // show the image utils only if the editor is editable, the remote image's (post upload) src is set and the initial resize is complete (but not while we're showing the preview imageFromFileSystem)
+ const showImageUtils = editor.isEditable && remoteImageSrc && initialResizeComplete;
+ // show the preview image from the file system if the remote image's src is not set
+ const displayedImageSrc = remoteImageSrc ?? imageFromFileSystem;
return (
<div
ref={containerRef}
className="group/image-component relative inline-block max-w-full"
- onMouseDown={handleMouseDown}
+ onMouseDown={handleImageMouseDown}
style={{
width: size.width,
- height: size.height,
+ aspectRatio: size.aspectRatio,
}}
>
- {isShimmerVisible && (
- <div className="animate-pulse bg-custom-background-80 rounded-md" style={{ width, height }} />
+ {showImageLoader && (
+ <div
+ className="animate-pulse bg-custom-background-80 rounded-md"
+ style={{ width: size.width, height: size.height }}
+ />
)}
<img
ref={imageRef}
- src={src}
+ src={displayedImageSrc}
+ onLoad={handleImageLoad}
+ onError={(e) => {
+ console.error("Error loading image", e);
+ setFailedToLoadImage(true);
+ }}
width={size.width}
- height={size.height}
className={cn("image-component block rounded-md", {
- hidden: isShimmerVisible,
+ // hide the image while the background calculations of the image loader are in progress (to avoid flickering) and show the loader until then
+ hidden: showImageLoader,
"read-only-image": !editor.isEditable,
+ "blur-sm opacity-80 loading-image": !remoteImageSrc,
})}
style={{
width: size.width,
- height: size.height,
- }}
- />
- <ImageToolbarRoot
- containerClassName="absolute top-1 right-1 z-20 bg-black/40 rounded opacity-0 pointer-events-none group-hover/image-component:opacity-100 group-hover/image-component:pointer-events-auto transition-opacity"
- image={{
- src,
- height: size.height,
- width: size.width,
+ aspectRatio: size.aspectRatio,
}}
/>
- {editor.isEditable && selected && <div className="absolute inset-0 size-full bg-custom-primary-500/30" />}
- {editor.isEditable && (
+ {showImageUtils && (
+ <ImageToolbarRoot
+ containerClassName={
+ "absolute top-1 right-1 z-20 bg-black/40 rounded opacity-0 pointer-events-none group-hover/image-component:opacity-100 group-hover/image-component:pointer-events-auto transition-opacity"
+ }
+ image={{
+ src: remoteImageSrc,
+ aspectRatio: size.aspectRatio,
+ height: size.height,
+ width: size.width,
+ }}
+ />
+ )}
+ {selected && displayedImageSrc === remoteImageSrc && (
+ <div className="absolute inset-0 size-full bg-custom-primary-500/30" />
+ )}
+ {showImageUtils && (
<>
- <div className="opacity-0 group-hover/image-component:opacity-100 absolute inset-0 border-2 border-custom-primary-100 pointer-events-none rounded-md transition-opacity duration-100 ease-in-out" />
<div
- className="opacity-0 pointer-events-none group-hover/image-component:opacity-100 group-hover/image-component:pointer-events-auto absolute bottom-0 right-0 translate-y-1/2 translate-x-1/2 size-4 rounded-full bg-custom-primary-100 border-2 border-white cursor-nwse-resize transition-opacity duration-100 ease-in-out"
+ className={cn(
+ "absolute inset-0 border-2 border-custom-primary-100 pointer-events-none rounded-md transition-opacity duration-100 ease-in-out",
+ {
+ "opacity-100": isResizing,
+ "opacity-0 group-hover/image-component:opacity-100": !isResizing,
+ }
+ )}
+ />
+ <div
+ className={cn(
+ "absolute bottom-0 right-0 translate-y-1/2 translate-x-1/2 size-4 rounded-full bg-custom-primary-100 border-2 border-white cursor-nwse-resize transition-opacity duration-100 ease-in-out",
+ {
+ "opacity-100 pointer-events-auto": isResizing,
+ "opacity-0 pointer-events-none group-hover/image-component:opacity-100 group-hover/image-component:pointer-events-auto":
+ !isResizing,
+ }
+ )}
onMouseDown={handleResizeStart}
/>
</>
diff --git a/packages/editor/src/core/extensions/custom-image/components/image-node.tsx b/packages/editor/src/core/extensions/custom-image/components/image-node.tsx
index 94d58f712b..c37bcd29cd 100644
--- a/packages/editor/src/core/extensions/custom-image/components/image-node.tsx
+++ b/packages/editor/src/core/extensions/custom-image/components/image-node.tsx
@@ -1,23 +1,14 @@
-import React, { useCallback, useEffect, useRef, useState } from "react";
+import { useEffect, useRef, useState } from "react";
import { Node as ProsemirrorNode } from "@tiptap/pm/model";
import { Editor, NodeViewWrapper } from "@tiptap/react";
// extensions
-import {
- CustomImageBlock,
- CustomImageUploader,
- UploadEntity,
- UploadImageExtensionStorage,
-} from "@/extensions/custom-image";
+import { CustomImageBlock, CustomImageUploader, ImageAttributes } from "@/extensions/custom-image";
export type CustomImageNodeViewProps = {
getPos: () => number;
editor: Editor;
node: ProsemirrorNode & {
- attrs: {
- src: string;
- width: number | string;
- height: number | string;
- };
+ attrs: ImageAttributes;
};
updateAttributes: (attrs: Record<string, any>) => void;
selected: boolean;
@@ -26,94 +17,60 @@ export type CustomImageNodeViewProps = {
export const CustomImageNode = (props: CustomImageNodeViewProps) => {
const { getPos, editor, node, updateAttributes, selected } = props;
- const fileInputRef = useRef<HTMLInputElement>(null);
- const hasTriggeredFilePickerRef = useRef(false);
- const [isUploaded, setIsUploaded] = useState(!!node.attrs.src);
+ const [isUploaded, setIsUploaded] = useState(false);
+ const [imageFromFileSystem, setImageFromFileSystem] = useState<string | undefined>(undefined);
+ const [failedToLoadImage, setFailedToLoadImage] = useState(false);
- const id = node.attrs.id as string;
- const editorStorage = editor.storage.imageComponent as UploadImageExtensionStorage | undefined;
-
- const getUploadEntity = useCallback(
- (): UploadEntity | undefined => editorStorage?.fileMap.get(id),
- [editorStorage, id]
- );
-
- const onUpload = useCallback(
- (url: string) => {
- if (url) {
- setIsUploaded(true);
- // Update the node view's src attribute
- updateAttributes({ src: url });
- editorStorage?.fileMap.delete(id);
- }
- },
- [editorStorage?.fileMap, id, updateAttributes]
- );
-
- const uploadFile = useCallback(
- async (file: File) => {
- try {
- // @ts-expect-error - TODO: fix typings, and don't remove await from
- // here for now
- const url: string = await editor?.commands.uploadImage(file);
-
- if (!url) {
- throw new Error("Something went wrong while uploading the image");
- }
- onUpload(url);
- } catch (error) {
- console.error("Error uploading file:", error);
- }
- },
- [editor.commands, onUpload]
- );
+ const [editorContainer, setEditorContainer] = useState<HTMLDivElement | null>(null);
+ const imageComponentRef = useRef<HTMLDivElement>(null);
useEffect(() => {
- const uploadEntity = getUploadEntity();
-
- if (uploadEntity) {
- if (uploadEntity.event === "drop" && "file" in uploadEntity) {
- uploadFile(uploadEntity.file);
- } else if (uploadEntity.event === "insert" && fileInputRef.current && !hasTriggeredFilePickerRef.current) {
- const entity = editorStorage?.fileMap.get(id);
- if (entity && entity.hasOpenedFileInputOnce) return;
- fileInputRef.current.click();
- hasTriggeredFilePickerRef.current = true;
- if (!entity) return;
- editorStorage?.fileMap.set(id, { ...entity, hasOpenedFileInputOnce: true });
- }
+ const closestEditorContainer = imageComponentRef.current?.closest(".editor-container");
+ if (!closestEditorContainer) {
+ console.error("Editor container not found");
+ return;
}
- }, [getUploadEntity, uploadFile]);
+ setEditorContainer(closestEditorContainer as HTMLDivElement);
+ }, []);
+
+ // the image is already uploaded if the image-component node has src attribute
+ // and we need to remove the blob from our file system
useEffect(() => {
- if (node.attrs.src) {
+ const remoteImageSrc = node.attrs.src;
+ if (remoteImageSrc) {
setIsUploaded(true);
+ setImageFromFileSystem(undefined);
+ } else {
+ setIsUploaded(false);
}
}, [node.attrs.src]);
- const existingFile = React.useMemo(() => {
- const entity = getUploadEntity();
- return entity && entity.event === "drop" ? entity.file : undefined;
- }, [getUploadEntity]);
-
return (
<NodeViewWrapper>
- <div className="p-0 mx-0 my-2" data-drag-handle>
- {isUploaded ? (
+ <div className="p-0 mx-0 my-2" data-drag-handle ref={imageComponentRef}>
+ {(isUploaded || imageFromFileSystem) && !failedToLoadImage ? (
<CustomImageBlock
+ imageFromFileSystem={imageFromFileSystem}
+ editorContainer={editorContainer}
editor={editor}
getPos={getPos}
node={node}
- updateAttributes={updateAttributes}
+ setEditorContainer={setEditorContainer}
+ setFailedToLoadImage={setFailedToLoadImage}
selected={selected}
+ updateAttributes={updateAttributes}
/>
) : (
<CustomImageUploader
- onUpload={onUpload}
editor={editor}
- fileInputRef={fileInputRef}
- existingFile={existingFile}
+ failedToLoadImage={failedToLoadImage}
+ getPos={getPos}
+ loadImageFromFileSystem={setImageFromFileSystem}
+ node={node}
+ setIsUploaded={setIsUploaded}
selected={selected}
+ updateAttributes={updateAttributes}
/>
)}
</div>
diff --git a/packages/editor/src/core/extensions/custom-image/components/image-uploader.tsx b/packages/editor/src/core/extensions/custom-image/components/image-uploader.tsx
index d288630c63..89cf36ca52 100644
--- a/packages/editor/src/core/extensions/custom-image/components/image-uploader.tsx
+++ b/packages/editor/src/core/extensions/custom-image/components/image-uploader.tsx
@@ -1,36 +1,111 @@
-import { ChangeEvent, useCallback, useEffect, useRef } from "react";
+import { ChangeEvent, useCallback, useEffect, useMemo, useRef } from "react";
+import { Node as ProsemirrorNode } from "@tiptap/pm/model";
import { Editor } from "@tiptap/core";
import { ImageIcon } from "lucide-react";
// helpers
import { cn } from "@/helpers/common";
// hooks
-import { useUploader, useFileUpload, useDropZone } from "@/hooks/use-file-upload";
+import { useUploader, useDropZone } from "@/hooks/use-file-upload";
// plugins
import { isFileValid } from "@/plugins/image";
-
-type RefType = React.RefObject<HTMLInputElement> | ((instance: HTMLInputElement | null) => void);
-
-const assignRef = (ref: RefType, value: HTMLInputElement | null) => {
- if (typeof ref === "function") {
- ref(value);
- } else if (ref && typeof ref === "object") {
- (ref as React.MutableRefObject<HTMLInputElement | null>).current = value;
- }
-};
+// extensions
+import { getImageComponentImageFileMap, ImageAttributes } from "@/extensions/custom-image";
export const CustomImageUploader = (props: {
- onUpload: (url: string) => void;
+ failedToLoadImage: boolean;
editor: Editor;
- fileInputRef: RefType;
- existingFile?: File;
selected: boolean;
+ loadImageFromFileSystem: (file: string) => void;
+ setIsUploaded: (isUploaded: boolean) => void;
+ node: ProsemirrorNode & {
+ attrs: ImageAttributes;
+ };
+ updateAttributes: (attrs: Record<string, any>) => void;
+ getPos: () => number;
}) => {
- const { selected, onUpload, editor, fileInputRef, existingFile } = props;
- const { loading, uploadFile } = useUploader({ onUpload, editor });
- const { handleUploadClick, ref: internalRef } = useFileUpload();
+ const {
+ selected,
+ failedToLoadImage,
+ editor,
+ loadImageFromFileSystem,
+ node,
+ setIsUploaded,
+ updateAttributes,
+ getPos,
+ } = props;
+ // ref
+ const fileInputRef = useRef<HTMLInputElement>(null);
+
+ const hasTriggeredFilePickerRef = useRef(false);
+ const imageEntityId = node.attrs.id;
+
+ const imageComponentImageFileMap = useMemo(() => getImageComponentImageFileMap(editor), [editor]);
+
+ const onUpload = useCallback(
+ (url: string) => {
+ if (url) {
+ setIsUploaded(true);
+ // Update the node view's src attribute post upload
+ updateAttributes({ src: url });
+ imageComponentImageFileMap?.delete(imageEntityId);
+
+ const pos = getPos();
+ // get current node
+ const getCurrentSelection = editor.state.selection;
+ const currentNode = editor.state.doc.nodeAt(getCurrentSelection.from);
+
+ // only if the cursor is at the current image component, manipulate
+ // the cursor position
+ if (currentNode && currentNode.type.name === "imageComponent" && currentNode.attrs.src === url) {
+ // control cursor position after upload
+ const nextNode = editor.state.doc.nodeAt(pos + 1);
+
+ if (nextNode && nextNode.type.name === "paragraph") {
+ // If there is a paragraph node after the image component, move the focus to the next node
+ editor.commands.setTextSelection(pos + 1);
+ } else {
+ // create a new paragraph after the image component post upload
+ editor.commands.createParagraphNear();
+ }
+ }
+ }
+ },
+ [imageComponentImageFileMap, imageEntityId, updateAttributes, getPos]
+ );
+ // hooks
+ const { uploading: isImageBeingUploaded, uploadFile } = useUploader({ onUpload, editor, loadImageFromFileSystem });
const { draggedInside, onDrop, onDragEnter, onDragLeave } = useDropZone({ uploader: uploadFile });
- const localRef = useRef<HTMLInputElement | null>(null);
+ // the meta data of the image component
+ const meta = useMemo(
+ () => imageComponentImageFileMap?.get(imageEntityId),
+ [imageComponentImageFileMap, imageEntityId]
+ );
+
+ // if the image component is dropped, we check if it has an existing file
+ const existingFile = useMemo(() => (meta && meta.event === "drop" ? meta.file : undefined), [meta]);
+
+ // after the image component is mounted we start the upload process based on
+ // it's uploaded
+ useEffect(() => {
+ if (meta) {
+ if (meta.event === "drop" && "file" in meta) {
+ uploadFile(meta.file);
+ } else if (meta.event === "insert" && fileInputRef.current && !hasTriggeredFilePickerRef.current) {
+ if (meta.hasOpenedFileInputOnce) return;
+ fileInputRef.current.click();
+ hasTriggeredFilePickerRef.current = true;
+ imageComponentImageFileMap?.set(imageEntityId, { ...meta, hasOpenedFileInputOnce: true });
+ }
+ }
+ }, [meta, uploadFile, imageComponentImageFileMap]);
+
+ // check if the image is dropped and set the local image as the existing file
+ useEffect(() => {
+ if (existingFile) {
+ uploadFile(existingFile);
+ }
+ }, [existingFile, uploadFile]);
const onFileChange = useCallback(
(e: ChangeEvent<HTMLInputElement>) => {
@@ -44,13 +119,22 @@ export const CustomImageUploader = (props: {
[uploadFile]
);
- useEffect(() => {
- // no need to validate as the file is already validated before the drop onto
- // the editor
- if (existingFile) {
- uploadFile(existingFile);
+ const getDisplayMessage = useCallback(() => {
+ const isUploading = isImageBeingUploaded || existingFile;
+ if (failedToLoadImage) {
+ return "Error loading image";
}
- }, [existingFile, uploadFile]);
+
+ if (isUploading) {
+ return "Uploading...";
+ }
+
+ if (draggedInside) {
+ return "Drop image here";
+ }
+
+ return "Add an image";
+ }, [draggedInside, failedToLoadImage, existingFile, isImageBeingUploaded]);
return (
<div
@@ -58,28 +142,27 @@ export const CustomImageUploader = (props: {
"image-upload-component flex items-center justify-start gap-2 py-3 px-2 rounded-lg text-custom-text-300 hover:text-custom-text-200 bg-custom-background-90 hover:bg-custom-background-80 border border-dashed border-custom-border-300 cursor-pointer transition-all duration-200 ease-in-out",
{
"bg-custom-background-80 text-custom-text-200": draggedInside,
- },
- {
- "text-custom-primary-200 bg-custom-primary-100/10": selected,
+ "text-custom-primary-200 bg-custom-primary-100/10 hover:bg-custom-primary-100/10 hover:text-custom-primary-200 border-custom-primary-200/10":
+ selected,
+ "text-red-500 cursor-default hover:text-red-500": failedToLoadImage,
+ "bg-red-500/10 hover:bg-red-500/10": failedToLoadImage && selected,
}
)}
onDrop={onDrop}
onDragOver={onDragEnter}
onDragLeave={onDragLeave}
contentEditable={false}
- onClick={handleUploadClick}
+ onClick={() => {
+ if (!failedToLoadImage) {
+ fileInputRef.current?.click();
+ }
+ }}
>
<ImageIcon className="size-4" />
- <div className="text-base font-medium">
- {loading ? "Uploading..." : draggedInside ? "Drop image here" : existingFile ? "Uploading..." : "Add an image"}
- </div>
+ <div className="text-base font-medium">{getDisplayMessage()}</div>
<input
className="size-0 overflow-hidden"
- ref={(element) => {
- localRef.current = element;
- assignRef(fileInputRef, element);
- assignRef(internalRef as RefType, element);
- }}
+ ref={fileInputRef}
hidden
type="file"
accept=".jpg,.jpeg,.png,.webp"
diff --git a/packages/editor/src/core/extensions/custom-image/components/toolbar/full-screen.tsx b/packages/editor/src/core/extensions/custom-image/components/toolbar/full-screen.tsx
index 93019c6068..38ea23c992 100644
--- a/packages/editor/src/core/extensions/custom-image/components/toolbar/full-screen.tsx
+++ b/packages/editor/src/core/extensions/custom-image/components/toolbar/full-screen.tsx
@@ -1,4 +1,4 @@
-import { useCallback, useEffect, useMemo, useState } from "react";
+import { useCallback, useEffect, useMemo, useRef, useState } from "react";
import { ExternalLink, Maximize, Minus, Plus, X } from "lucide-react";
// helpers
import { cn } from "@/helpers/common";
@@ -8,6 +8,7 @@ type Props = {
src: string;
height: string;
width: string;
+ aspectRatio: number;
};
isOpen: boolean;
toggleFullScreenMode: (val: boolean) => void;
@@ -17,13 +18,13 @@ const MAGNIFICATION_VALUES = [0.5, 0.75, 1, 1.5, 1.75, 2];
export const ImageFullScreenAction: React.FC<Props> = (props) => {
const { image, isOpen: isFullScreenEnabled, toggleFullScreenMode } = props;
- const { height, src, width } = image;
+ const { src, width, aspectRatio } = image;
// states
const [magnification, setMagnification] = useState(1);
+ // refs
+ const modalRef = useRef<HTMLDivElement>(null);
// derived values
const widthInNumber = useMemo(() => Number(width?.replace("px", "")), [width]);
- const heightInNumber = useMemo(() => Number(height?.replace("px", "")), [height]);
- const aspectRatio = useMemo(() => widthInNumber / heightInNumber, [heightInNumber, widthInNumber]);
// close handler
const handleClose = useCallback(() => {
toggleFullScreenMode(false);
@@ -55,25 +56,35 @@ export const ImageFullScreenAction: React.FC<Props> = (props) => {
// keydown handler
const handleKeyDown = useCallback(
(e: KeyboardEvent) => {
- e.preventDefault();
- e.stopPropagation();
- if (e.key === "Escape") handleClose();
- if (e.key === "+" || e.key === "=") handleIncreaseMagnification();
- if (e.key === "-") handleDecreaseMagnification();
+ if (e.key === "Escape" || e.key === "+" || e.key === "=" || e.key === "-") {
+ e.preventDefault();
+ e.stopPropagation();
+
+ if (e.key === "Escape") handleClose();
+ if (e.key === "+" || e.key === "=") handleIncreaseMagnification();
+ if (e.key === "-") handleDecreaseMagnification();
+ }
},
[handleClose, handleDecreaseMagnification, handleIncreaseMagnification]
);
+ // click outside handler
+ const handleClickOutside = useCallback(
+ (e: React.MouseEvent<HTMLDivElement, MouseEvent>) => {
+ if (modalRef.current && e.target === modalRef.current) {
+ handleClose();
+ }
+ },
+ [handleClose]
+ );
// register keydown listener
useEffect(() => {
- document.addEventListener("keydown", handleKeyDown);
+ if (isFullScreenEnabled) {
+ document.addEventListener("keydown", handleKeyDown);
- if (!isFullScreenEnabled) {
- document.removeEventListener("keydown", handleKeyDown);
+ return () => {
+ document.removeEventListener("keydown", handleKeyDown);
+ };
}
-
- return () => {
- document.removeEventListener("keydown", handleKeyDown);
- };
}, [handleKeyDown, isFullScreenEnabled]);
return (
@@ -86,7 +97,7 @@ export const ImageFullScreenAction: React.FC<Props> = (props) => {
}
)}
>
- <div className="relative size-full grid place-items-center">
+ <div ref={modalRef} onClick={handleClickOutside} className="relative size-full grid place-items-center">
<button
type="button"
onClick={handleClose}
@@ -103,7 +114,7 @@ export const ImageFullScreenAction: React.FC<Props> = (props) => {
}}
/>
</div>
- <div className="fixed bottom-10 left-1/2 -translate-x-1/2 flex items-center justify-center gap-1 rounded-md border border-white/20 py-2 divide-x divide-white/20">
+ <div className="fixed bottom-10 left-1/2 -translate-x-1/2 flex items-center justify-center gap-1 rounded-md border border-white/20 py-2 divide-x divide-white/20 bg-black">
<div className="flex items-center">
<button
type="button"
diff --git a/packages/editor/src/core/extensions/custom-image/components/toolbar/root.tsx b/packages/editor/src/core/extensions/custom-image/components/toolbar/root.tsx
index 3cfc844be5..d42d875cc9 100644
--- a/packages/editor/src/core/extensions/custom-image/components/toolbar/root.tsx
+++ b/packages/editor/src/core/extensions/custom-image/components/toolbar/root.tsx
@@ -10,6 +10,7 @@ type Props = {
src: string;
height: string;
width: string;
+ aspectRatio: number;
};
};
diff --git a/packages/editor/src/core/extensions/custom-image/custom-image.ts b/packages/editor/src/core/extensions/custom-image/custom-image.ts
index 73786e621f..939d97668f 100644
--- a/packages/editor/src/core/extensions/custom-image/custom-image.ts
+++ b/packages/editor/src/core/extensions/custom-image/custom-image.ts
@@ -1,4 +1,4 @@
-import { mergeAttributes } from "@tiptap/core";
+import { Editor, mergeAttributes } from "@tiptap/core";
import { Image } from "@tiptap/extension-image";
import { ReactNodeViewRenderer } from "@tiptap/react";
import { v4 as uuidv4 } from "uuid";
@@ -11,15 +11,24 @@ import { TFileHandler } from "@/types";
// helpers
import { insertEmptyParagraphAtNodeBoundaries } from "@/helpers/insert-empty-paragraph-at-node-boundary";
+export type InsertImageComponentProps = {
+ file?: File;
+ pos?: number;
+ event: "insert" | "drop";
+};
+
declare module "@tiptap/core" {
interface Commands<ReturnType> {
imageComponent: {
- setImageUpload: ({ file, pos, event }: { file?: File; pos?: number; event: "insert" | "drop" }) => ReturnType;
+ insertImageComponent: ({ file, pos, event }: InsertImageComponentProps) => ReturnType;
uploadImage: (file: File) => () => Promise<string> | undefined;
};
}
}
+export const getImageComponentImageFileMap = (editor: Editor) =>
+ (editor.storage.imageComponent as UploadImageExtensionStorage | undefined)?.fileMap;
+
export interface UploadImageExtensionStorage {
fileMap: Map<string, UploadEntity>;
}
@@ -51,6 +60,9 @@ export const CustomImageExtension = (props: TFileHandler) => {
["id"]: {
default: null,
},
+ aspectRatio: {
+ default: null,
+ },
};
},
@@ -101,12 +113,13 @@ export const CustomImageExtension = (props: TFileHandler) => {
return {
fileMap: new Map(),
deletedImageSet: new Map<string, boolean>(),
+ uploadInProgress: false,
};
},
addCommands() {
return {
- setImageUpload:
+ insertImageComponent:
(props: { file?: File; pos?: number; event: "insert" | "drop" }) =>
({ commands }) => {
// Early return if there's an invalid file being dropped
@@ -117,15 +130,21 @@ export const CustomImageExtension = (props: TFileHandler) => {
// generate a unique id for the image to keep track of dropped
// files' file data
const fileId = uuidv4();
- if (props?.event === "drop" && props.file) {
- (this.editor.storage.imageComponent as UploadImageExtensionStorage).fileMap.set(fileId, {
- file: props.file,
- event: props.event,
- });
- } else if (props.event === "insert") {
- (this.editor.storage.imageComponent as UploadImageExtensionStorage).fileMap.set(fileId, {
- event: props.event,
- });
+
+ const imageComponentImageFileMap = getImageComponentImageFileMap(this.editor);
+
+ if (imageComponentImageFileMap) {
+ if (props?.event === "drop" && props.file) {
+ imageComponentImageFileMap.set(fileId, {
+ file: props.file,
+ event: props.event,
+ });
+ } else if (props.event === "insert") {
+ imageComponentImageFileMap.set(fileId, {
+ event: props.event,
+ hasOpenedFileInputOnce: false,
+ });
+ }
}
const attributes = {
diff --git a/packages/editor/src/core/extensions/custom-image/read-only-custom-image.ts b/packages/editor/src/core/extensions/custom-image/read-only-custom-image.ts
index 4f9c7d3cd4..f7db8d6b0c 100644
--- a/packages/editor/src/core/extensions/custom-image/read-only-custom-image.ts
+++ b/packages/editor/src/core/extensions/custom-image/read-only-custom-image.ts
@@ -27,6 +27,9 @@ export const CustomReadOnlyImageExtension = () =>
["id"]: {
default: null,
},
+ aspectRatio: {
+ default: null,
+ },
};
},
diff --git a/packages/editor/src/core/extensions/drop.tsx b/packages/editor/src/core/extensions/drop.tsx
index 2b616dc4c0..8d66a5f9f5 100644
--- a/packages/editor/src/core/extensions/drop.tsx
+++ b/packages/editor/src/core/extensions/drop.tsx
@@ -1,4 +1,4 @@
-import { Extension } from "@tiptap/core";
+import { Extension, Editor } from "@tiptap/core";
import { Plugin, PluginKey } from "@tiptap/pm/state";
import { EditorView } from "@tiptap/pm/view";
@@ -8,6 +8,7 @@ export const DropHandlerExtension = () =>
priority: 1000,
addProseMirrorPlugins() {
+ const editor = this.editor;
return [
new Plugin({
key: new PluginKey("drop-handler-plugin"),
@@ -20,15 +21,9 @@ export const DropHandlerExtension = () =>
if (imageFiles.length > 0) {
const pos = view.state.selection.from;
- imageFiles.forEach((file, index) => {
- this.editor
- .chain()
- .focus()
- .setImageUpload({ file, pos: pos + index, event: "drop" })
- .run();
- });
- return true;
+ insertImages({ editor, files: imageFiles, initialPos: pos, event: "drop" });
}
+ return true;
}
return false;
},
@@ -45,15 +40,8 @@ export const DropHandlerExtension = () =>
});
if (coordinates) {
- imageFiles.forEach((file, index) => {
- setTimeout(() => {
- this.editor
- .chain()
- .focus()
- .setImageUpload({ file, pos: coordinates.pos + index, event: "drop" })
- .run();
- }, index * 100); // Slight delay between insertions
- });
+ const pos = coordinates.pos;
+ insertImages({ editor, files: imageFiles, initialPos: pos, event: "drop" });
}
return true;
}
@@ -65,3 +53,40 @@ export const DropHandlerExtension = () =>
];
},
});
+
+const insertImages = async ({
+ editor,
+ files,
+ initialPos,
+ event,
+}: {
+ editor: Editor;
+ files: File[];
+ initialPos: number;
+ event: "insert" | "drop";
+}) => {
+ let pos = initialPos;
+
+ for (const file of files) {
+ // safe insertion
+ const docSize = editor.state.doc.content.size;
+ pos = Math.min(pos, docSize);
+
+ // Check if the position has a non-empty node
+ const nodeAtPos = editor.state.doc.nodeAt(pos);
+ if (nodeAtPos && nodeAtPos.content.size > 0) {
+ // Move to the end of the current node
+ pos += nodeAtPos.nodeSize;
+ }
+
+ try {
+ // Insert the image at the current position
+ editor.commands.insertImageComponent({ file, pos, event });
+ } catch (error) {
+ console.error(`Error while ${event}ing image:`, error);
+ }
+
+ // Move to the next position
+ pos += 1;
+ }
+};
diff --git a/packages/editor/src/core/extensions/extensions.tsx b/packages/editor/src/core/extensions/extensions.tsx
index 1c2e188911..c6d29b31b2 100644
--- a/packages/editor/src/core/extensions/extensions.tsx
+++ b/packages/editor/src/core/extensions/extensions.tsx
@@ -149,7 +149,7 @@ export const CoreEditorExtensions = ({
placeholder: ({ editor, node }) => {
if (node.type.name === "heading") return `Heading ${node.attrs.level}`;
- // if (editor.storage.image.uploadInProgress) return "";
+ if (editor.storage.imageComponent.uploadInProgress) return "";
const shouldHidePlaceholder =
editor.isActive("table") || editor.isActive("codeBlock") || editor.isActive("image");
diff --git a/packages/editor/src/core/extensions/image/image-component-without-props.tsx b/packages/editor/src/core/extensions/image/image-component-without-props.tsx
index 2141f6445d..b6dbd4c308 100644
--- a/packages/editor/src/core/extensions/image/image-component-without-props.tsx
+++ b/packages/editor/src/core/extensions/image/image-component-without-props.tsx
@@ -1,8 +1,7 @@
import { mergeAttributes } from "@tiptap/core";
-import { ReactNodeViewRenderer } from "@tiptap/react";
import { Image } from "@tiptap/extension-image";
// extensions
-import { CustomImageNode, UploadImageExtensionStorage } from "@/extensions";
+import { UploadImageExtensionStorage } from "@/extensions";
export const CustomImageComponentWithoutProps = () =>
Image.extend<Record<string, unknown>, UploadImageExtensionStorage>({
@@ -27,6 +26,9 @@ export const CustomImageComponentWithoutProps = () =>
["id"]: {
default: null,
},
+ aspectRatio: {
+ default: null,
+ },
};
},
@@ -48,10 +50,6 @@ export const CustomImageComponentWithoutProps = () =>
deletedImageSet: new Map<string, boolean>(),
};
},
-
- addNodeView() {
- return ReactNodeViewRenderer(CustomImageNode);
- },
});
export default CustomImageComponentWithoutProps;
diff --git a/packages/editor/src/core/extensions/image/image-extension-without-props.tsx b/packages/editor/src/core/extensions/image/image-extension-without-props.tsx
index bd9ca3c820..0d505000c7 100644
--- a/packages/editor/src/core/extensions/image/image-extension-without-props.tsx
+++ b/packages/editor/src/core/extensions/image/image-extension-without-props.tsx
@@ -1,7 +1,4 @@
import ImageExt from "@tiptap/extension-image";
-import { ReactNodeViewRenderer } from "@tiptap/react";
-// extensions
-import { CustomImageNode } from "@/extensions";
export const ImageExtensionWithoutProps = () =>
ImageExt.extend({
@@ -16,8 +13,4 @@ export const ImageExtensionWithoutProps = () =>
},
};
},
-
- addNodeView() {
- return ReactNodeViewRenderer(CustomImageNode);
- },
});
diff --git a/packages/editor/src/core/extensions/slash-commands.tsx b/packages/editor/src/core/extensions/slash-commands.tsx
index 3b1789781c..2be8d89d96 100644
--- a/packages/editor/src/core/extensions/slash-commands.tsx
+++ b/packages/editor/src/core/extensions/slash-commands.tsx
@@ -34,6 +34,7 @@ import {
toggleHeadingFour,
toggleHeadingFive,
toggleHeadingSix,
+ insertImage,
} from "@/helpers/editor-commands";
// types
import { CommandProps, ISlashCommandItem } from "@/types";
@@ -226,9 +227,7 @@ const getSuggestionItems =
icon: <ImageIcon className="size-3.5" />,
description: "Insert an image",
searchTerms: ["img", "photo", "picture", "media", "upload"],
- command: ({ editor, range }: CommandProps) => {
- editor.chain().focus().deleteRange(range).setImageUpload({ event: "insert" }).run();
- },
+ command: ({ editor, range }: CommandProps) => insertImage({ editor, event: "insert", range }),
},
{
key: "divider",
diff --git a/packages/editor/src/core/helpers/editor-commands.ts b/packages/editor/src/core/helpers/editor-commands.ts
index 7cf3e8d1f1..66be05bb26 100644
--- a/packages/editor/src/core/helpers/editor-commands.ts
+++ b/packages/editor/src/core/helpers/editor-commands.ts
@@ -1,13 +1,10 @@
import { Editor, Range } from "@tiptap/core";
-import { Selection } from "@tiptap/pm/state";
// extensions
import { replaceCodeWithText } from "@/extensions/code/utils/replace-code-block-with-text";
// helpers
import { findTableAncestor } from "@/helpers/common";
-// plugins
-import { startImageUpload } from "@/plugins/image";
// types
-import { UploadImage } from "@/types";
+import { InsertImageComponentProps } from "@/extensions";
export const setText = (editor: Editor, range?: Range) => {
if (range) editor.chain().focus().deleteRange(range).clearNodes().run();
@@ -129,6 +126,27 @@ export const insertTableCommand = (editor: Editor, range?: Range) => {
else editor.chain().focus().clearNodes().insertTable({ rows: 3, cols: 3 }).run();
};
+export const insertImage = ({
+ editor,
+ event,
+ pos,
+ file,
+ range,
+}: {
+ editor: Editor;
+ event: "insert" | "drop";
+ pos?: number | null;
+ file?: File;
+ range?: Range;
+}) => {
+ if (range) editor.chain().focus().deleteRange(range).run();
+
+ const imageOptions: InsertImageComponentProps = { event };
+ if (pos) imageOptions.pos = pos;
+ if (file) imageOptions.file = file;
+ return editor?.chain().focus().insertImageComponent(imageOptions).run();
+};
+
export const unsetLinkEditor = (editor: Editor) => {
editor.chain().focus().unsetLink().run();
};
@@ -136,23 +154,3 @@ export const unsetLinkEditor = (editor: Editor) => {
export const setLinkEditor = (editor: Editor, url: string) => {
editor.chain().focus().setLink({ href: url }).run();
};
-
-export const insertImageCommand = (
- editor: Editor,
- uploadFile: UploadImage,
- savedSelection?: Selection | null,
- range?: Range
-) => {
- if (range) editor.chain().focus().deleteRange(range).run();
- const input = document.createElement("input");
- input.type = "file";
- input.accept = ".jpeg, .jpg, .png, .webp";
- input.onchange = async () => {
- if (input.files?.length) {
- const file = input.files[0];
- const pos = savedSelection?.anchor ?? editor.view.state.selection.from;
- startImageUpload(editor, file, editor.view, pos, uploadFile);
- }
- };
- input.click();
-};
diff --git a/packages/editor/src/core/hooks/use-editor.ts b/packages/editor/src/core/hooks/use-editor.ts
index f3ab1889b2..fee3306123 100644
--- a/packages/editor/src/core/hooks/use-editor.ts
+++ b/packages/editor/src/core/hooks/use-editor.ts
@@ -60,6 +60,7 @@ export const useEditor = (props: CustomEditorProps) => {
value,
} = props;
// states
+
const [savedSelection, setSavedSelection] = useState<Selection | null>(null);
// refs
const editorRef: MutableRefObject<Editor | null> = useRef(null);
@@ -106,7 +107,7 @@ export const useEditor = (props: CustomEditorProps) => {
// value is null when intentionally passed where syncing is not yet
// supported and value is undefined when the data from swr is not populated
if (value === null || value === undefined) return;
- if (editor && !editor.isDestroyed && !editor.storage.image.uploadInProgress) {
+ if (editor && !editor.isDestroyed && !editor.storage.imageComponent.uploadInProgress) {
try {
editor.commands.setContent(value, false, { preserveWhitespace: "full" });
const currentSavedSelection = savedSelectionRef.current;
@@ -203,7 +204,7 @@ export const useEditor = (props: CustomEditorProps) => {
if (!editorRef.current) return;
scrollSummary(editorRef.current, marking);
},
- isEditorReadyToDiscard: () => editorRef.current?.storage.image.uploadInProgress === false,
+ isEditorReadyToDiscard: () => editorRef.current?.storage.imageComponent.uploadInProgress === false,
setFocusAtPosition: (position: number) => {
if (!editorRef.current || editorRef.current.isDestroyed) {
console.error("Editor reference is not available or has been destroyed.");
diff --git a/packages/editor/src/core/hooks/use-file-upload.ts b/packages/editor/src/core/hooks/use-file-upload.ts
index 3aea2d155c..5dfa025e59 100644
--- a/packages/editor/src/core/hooks/use-file-upload.ts
+++ b/packages/editor/src/core/hooks/use-file-upload.ts
@@ -1,17 +1,48 @@
-import { DragEvent, useCallback, useEffect, useRef, useState } from "react";
+import { DragEvent, useCallback, useEffect, useState } from "react";
import { Editor } from "@tiptap/core";
import { isFileValid } from "@/plugins/image";
-export const useUploader = ({ onUpload, editor }: { onUpload: (url: string) => void; editor: Editor }) => {
- const [loading, setLoading] = useState(false);
+export const useUploader = ({
+ onUpload,
+ editor,
+ loadImageFromFileSystem,
+}: {
+ onUpload: (url: string) => void;
+ editor: Editor;
+ loadImageFromFileSystem: (file: string) => void;
+}) => {
+ const [uploading, setUploading] = useState(false);
const uploadFile = useCallback(
async (file: File) => {
- setLoading(true);
+ const setImageUploadInProgress = (isUploading: boolean) => {
+ editor.storage.imageComponent.uploadInProgress = isUploading;
+ };
+ setImageUploadInProgress(true);
+ setUploading(true);
+ const fileNameTrimmed = trimFileName(file.name);
+ const fileWithTrimmedName = new File([file], fileNameTrimmed, { type: file.type });
+ const isValid = isFileValid(fileWithTrimmedName);
+ if (!isValid) {
+ setImageUploadInProgress(false);
+ return;
+ }
try {
+ const reader = new FileReader();
+ reader.onload = () => {
+ if (reader.result) {
+ loadImageFromFileSystem(reader.result as string);
+ } else {
+ console.error("Failed to read the file: reader.result is null");
+ }
+ };
+ reader.onerror = () => {
+ console.error("Error reading file");
+ };
+ reader.readAsDataURL(fileWithTrimmedName);
// @ts-expect-error - TODO: fix typings, and don't remove await from
// here for now
- const url: string = await editor?.commands.uploadImage(file);
+ const url: string = await editor?.commands.uploadImage(fileWithTrimmedName);
if (!url) {
throw new Error("Something went wrong while uploading the image");
@@ -21,24 +52,17 @@ export const useUploader = ({ onUpload, editor }: { onUpload: (url: string) => v
console.log(errPayload);
const error = errPayload?.response?.data?.error || "Something went wrong";
console.error(error);
+ } finally {
+ setImageUploadInProgress(false);
+ setUploading(false);
}
- setLoading(false);
},
- [onUpload, editor]
+ [onUpload]
);
- return { loading, uploadFile };
+ return { uploading, uploadFile };
};
-export const useFileUpload = () => {
- const fileInput = useRef<HTMLInputElement>(null);
-
- const handleUploadClick = useCallback(() => {
- fileInput.current?.click();
- }, []);
-
- return { ref: fileInput, handleUploadClick };
-};
export const useDropZone = ({ uploader }: { uploader: (file: File) => void }) => {
const [isDragging, setIsDragging] = useState<boolean>(false);
const [draggedInside, setDraggedInside] = useState<boolean>(false);
@@ -90,10 +114,9 @@ export const useDropZone = ({ uploader }: { uploader: (file: File) => void }) =>
const file = filteredFiles.length > 0 ? filteredFiles[0] : undefined;
if (file) {
- const isValid = isFileValid(file);
- if (isValid) {
- uploader(file);
- }
+ uploader(file);
+ } else {
+ console.error("No file found");
}
},
[uploader]
@@ -109,3 +132,14 @@ export const useDropZone = ({ uploader }: { uploader: (file: File) => void }) =>
return { isDragging, draggedInside, onDragEnter, onDragLeave, onDrop };
};
+
+function trimFileName(fileName: string, maxLength = 100) {
+ if (fileName.length > maxLength) {
+ const extension = fileName.split(".").pop();
+ const nameWithoutExtension = fileName.slice(0, -(extension?.length ?? 0 + 1));
+ const allowedNameLength = maxLength - (extension?.length ?? 0) - 1; // -1 for the dot
+ return `${nameWithoutExtension.slice(0, allowedNameLength)}.${extension}`;
+ }
+
+ return fileName;
+}
diff --git a/packages/editor/src/core/plugins/image/image-upload-handler.ts b/packages/editor/src/core/plugins/image/image-upload-handler.ts
deleted file mode 100644
index d0bd339dae..0000000000
--- a/packages/editor/src/core/plugins/image/image-upload-handler.ts
+++ /dev/null
@@ -1,137 +0,0 @@
-import { Editor } from "@tiptap/core";
-import { EditorView } from "@tiptap/pm/view";
-import { v4 as uuidv4 } from "uuid";
-// plugins
-import { findPlaceholder, isFileValid, removePlaceholder, uploadKey } from "@/plugins/image";
-// types
-import { UploadImage } from "@/types";
-
-export async function startImageUpload(
- editor: Editor,
- file: File,
- view: EditorView,
- pos: number | null,
- uploadFile: UploadImage
-) {
- editor.storage.image.uploadInProgress = true;
-
- if (!isFileValid(file)) {
- editor.storage.image.uploadInProgress = false;
- return;
- }
-
- const id = uuidv4();
-
- const tr = view.state.tr;
- if (!tr.selection.empty) tr.deleteSelection();
-
- const reader = new FileReader();
- reader.readAsDataURL(file);
- reader.onload = () => {
- tr.setMeta(uploadKey, {
- add: {
- id,
- pos,
- src: reader.result,
- },
- });
- view.dispatch(tr);
- };
-
- // Handle FileReader errors
- reader.onerror = (error) => {
- console.error("FileReader error: ", error);
- removePlaceholder(editor, view, id);
- return;
- };
-
- try {
- const fileNameTrimmed = trimFileName(file.name);
- const fileWithTrimmedName = new File([file], fileNameTrimmed, { type: file.type });
-
- const resolvedPos = view.state.doc.resolve(pos ?? 0);
- const nodeBefore = resolvedPos.nodeBefore;
-
- // if the image is at the start of the line i.e. when nodeBefore is null
- if (nodeBefore === null) {
- if (pos) {
- // so that the image is not inserted at the next line, else incase the
- // image is inserted at any line where there's some content, the
- // position is kept as it is to be inserted at the next line
- pos -= 1;
- }
- }
-
- view.focus();
-
- const src = await uploadAndValidateImage(fileWithTrimmedName, uploadFile);
-
- if (src == null) {
- throw new Error("Resolved image URL is undefined.");
- }
-
- const { schema } = view.state;
- pos = findPlaceholder(view.state, id);
-
- if (pos == null) {
- editor.storage.image.uploadInProgress = false;
- return;
- }
- const imageSrc = typeof src === "object" ? reader.result : src;
-
- const node = schema.nodes.image.create({ src: imageSrc });
-
- if (pos < 0 || pos > view.state.doc.content.size) {
- throw new Error("Invalid position to insert the image node.");
- }
-
- // insert the image node at the position of the placeholder and remove the placeholder
- const transaction = view.state.tr.insert(pos, node).setMeta(uploadKey, { remove: { id } });
-
- view.dispatch(transaction);
-
- editor.storage.image.uploadInProgress = false;
- } catch (error) {
- console.error("Error in uploading and inserting image: ", error);
- removePlaceholder(editor, view, id);
- }
-}
-
-async function uploadAndValidateImage(file: File, uploadFile: UploadImage): Promise<string | undefined> {
- try {
- const imageUrl = await uploadFile(file);
-
- if (imageUrl == null) {
- throw new Error("Image URL is undefined.");
- }
-
- await new Promise<void>((resolve, reject) => {
- const image = new Image();
- image.src = imageUrl;
- image.onload = () => {
- resolve();
- };
- image.onerror = (error) => {
- console.error("Error in loading image: ", error);
- reject(error);
- };
- });
-
- return imageUrl;
- } catch (error) {
- console.error("Error in uploading image: ", error);
- // throw error to remove the placeholder
- throw error;
- }
-}
-
-function trimFileName(fileName: string, maxLength = 100) {
- if (fileName.length > maxLength) {
- const extension = fileName.split(".").pop();
- const nameWithoutExtension = fileName.slice(0, -(extension?.length ?? 0 + 1));
- const allowedNameLength = maxLength - (extension?.length ?? 0) - 1; // -1 for the dot
- return `${nameWithoutExtension.slice(0, allowedNameLength)}.${extension}`;
- }
-
- return fileName;
-}
diff --git a/packages/editor/src/core/plugins/image/index.ts b/packages/editor/src/core/plugins/image/index.ts
index e5a290abe8..dfb7878735 100644
--- a/packages/editor/src/core/plugins/image/index.ts
+++ b/packages/editor/src/core/plugins/image/index.ts
@@ -2,6 +2,4 @@ export * from "./types";
export * from "./utils";
export * from "./constants";
export * from "./delete-image";
-export * from "./image-upload-handler";
export * from "./restore-image";
-export * from "./upload-image";
diff --git a/packages/editor/src/core/plugins/image/upload-image.ts b/packages/editor/src/core/plugins/image/upload-image.ts
deleted file mode 100644
index e3db70d136..0000000000
--- a/packages/editor/src/core/plugins/image/upload-image.ts
+++ /dev/null
@@ -1,87 +0,0 @@
-import { Editor } from "@tiptap/core";
-import { Plugin } from "@tiptap/pm/state";
-import { Decoration, DecorationSet, EditorView } from "@tiptap/pm/view";
-// plugins
-import { removePlaceholder, uploadKey } from "@/plugins/image";
-
-export const UploadImagesPlugin = (editor: Editor, cancelUploadImage?: () => void) => {
- let currentView: EditorView | null = null;
-
- const createPlaceholder = (src: string): HTMLElement => {
- const placeholder = document.createElement("div");
- placeholder.setAttribute("class", "img-placeholder");
- const image = document.createElement("img");
- image.setAttribute("class", "opacity-60 rounded-lg border border-custom-border-300");
- image.src = src;
- placeholder.appendChild(image);
-
- return placeholder;
- };
-
- const createCancelButton = (id: string): HTMLButtonElement => {
- const cancelButton = document.createElement("button");
- cancelButton.type = "button";
- cancelButton.style.position = "absolute";
- cancelButton.style.right = "3px";
- cancelButton.style.top = "3px";
- cancelButton.setAttribute("class", "opacity-90 rounded-lg");
-
- cancelButton.onclick = () => {
- if (currentView) {
- cancelUploadImage?.();
- removePlaceholder(editor, currentView, id);
- }
- };
-
- // Create an SVG element from the SVG string
- const svgString = `<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-x-circle"><circle cx="12" cy="12" r="10"/><path d="m15 9-6 6"/><path d="m9 9 6 6"/></svg>`;
- const parser = new DOMParser();
- const svgElement = parser.parseFromString(svgString, "image/svg+xml").documentElement;
-
- cancelButton.appendChild(svgElement);
-
- return cancelButton;
- };
-
- return new Plugin({
- key: uploadKey,
- view(editorView) {
- currentView = editorView;
- return {
- destroy() {
- currentView = null;
- },
- };
- },
- state: {
- init() {
- return DecorationSet.empty;
- },
- apply(tr, set) {
- set = set.map(tr.mapping, tr.doc);
- const action = tr.getMeta(uploadKey);
- if (action && action.add) {
- const { id, pos, src } = action.add;
-
- const placeholder = createPlaceholder(src);
- const cancelButton = createCancelButton(id);
-
- placeholder.appendChild(cancelButton);
-
- const deco = Decoration.widget(pos, placeholder, {
- id,
- });
- set = set.add(tr.doc, [deco]);
- } else if (action && action.remove) {
- set = set.remove(set.find(undefined, undefined, (spec) => spec.id == action.remove.id));
- }
- return set;
- },
- },
- props: {
- decorations(state) {
- return this.getState(state);
- },
- },
- });
-};
diff --git a/packages/editor/src/core/plugins/image/utils/index.ts b/packages/editor/src/core/plugins/image/utils/index.ts
index 217ec41176..08d377a831 100644
--- a/packages/editor/src/core/plugins/image/utils/index.ts
+++ b/packages/editor/src/core/plugins/image/utils/index.ts
@@ -1,2 +1 @@
-export * from "./placeholder";
export * from "./validate-file";
diff --git a/packages/editor/src/core/plugins/image/utils/placeholder.ts b/packages/editor/src/core/plugins/image/utils/placeholder.ts
deleted file mode 100644
index f05f4d8905..0000000000
--- a/packages/editor/src/core/plugins/image/utils/placeholder.ts
+++ /dev/null
@@ -1,17 +0,0 @@
-import { Editor } from "@tiptap/core";
-import { EditorState } from "@tiptap/pm/state";
-import { DecorationSet, EditorView } from "@tiptap/pm/view";
-// plugins
-import { uploadKey } from "@/plugins/image";
-
-export function findPlaceholder(state: EditorState, id: string): number | null {
- const decos = uploadKey.getState(state) as DecorationSet;
- const found = decos.find(undefined, undefined, (spec: { id: string }) => spec.id === id);
- return found.length ? found[0].from : null;
-}
-
-export function removePlaceholder(editor: Editor, view: EditorView, id: string) {
- const removePlaceholderTr = view.state.tr.setMeta(uploadKey, { remove: { id } });
- view.dispatch(removePlaceholderTr);
- editor.storage.image.uploadInProgress = false;
-}
diff --git a/packages/editor/src/styles/editor.css b/packages/editor/src/styles/editor.css
index 478180aa2f..e5047fb0c4 100644
--- a/packages/editor/src/styles/editor.css
+++ b/packages/editor/src/styles/editor.css
@@ -125,7 +125,7 @@
margin-top: 0 !important;
margin-bottom: 0;
- &:not(.read-only-image) {
+ &:not(.read-only-image):not(.loading-image) {
transition: filter 0.1s ease-in-out;
&:hover {
diff --git a/web/core/components/editor/rich-text-editor/rich-text-editor.tsx b/web/core/components/editor/rich-text-editor/rich-text-editor.tsx
index 68adbb9fdf..bb29669379 100644
--- a/web/core/components/editor/rich-text-editor/rich-text-editor.tsx
+++ b/web/core/components/editor/rich-text-editor/rich-text-editor.tsx
@@ -51,7 +51,7 @@ export const RichTextEditor = forwardRef<EditorRefApi, RichTextEditorWrapperProp
suggestions: mentionSuggestions,
}}
{...rest}
- containerClassName={cn("relative pl-3", containerClassName)}
+ containerClassName={cn("relative pl-3 pb-3", containerClassName)}
/>
);
});
diff --git a/web/core/components/inbox/content/issue-root.tsx b/web/core/components/inbox/content/issue-root.tsx
index 6384696f63..df6ccdce5c 100644
--- a/web/core/components/inbox/content/issue-root.tsx
+++ b/web/core/components/inbox/content/issue-root.tsx
@@ -127,7 +127,7 @@ export const InboxIssueMainContent: React.FC<Props> = observer((props) => {
disabled={!isEditable}
issueOperations={issueOperations}
setIsSubmitting={(value) => setIsSubmitting(value)}
- containerClassName="-ml-3 !mb-6 border-none"
+ containerClassName="-ml-3 border-none"
/>
)}
diff --git a/web/core/components/issues/issue-detail/main-content.tsx b/web/core/components/issues/issue-detail/main-content.tsx
index 0dccf61635..2bb16f5153 100644
--- a/web/core/components/issues/issue-detail/main-content.tsx
+++ b/web/core/components/issues/issue-detail/main-content.tsx
@@ -92,7 +92,7 @@ export const IssueMainContent: React.FC<Props> = observer((props) => {
disabled={!isEditable}
issueOperations={issueOperations}
setIsSubmitting={(value) => setIsSubmitting(value)}
- containerClassName="-ml-3 !mb-6 border-none"
+ containerClassName="-ml-3 border-none"
/>
{/* )} */}
diff --git a/web/core/components/issues/peek-overview/issue-detail.tsx b/web/core/components/issues/peek-overview/issue-detail.tsx
index 7c801dd01a..20117d10f5 100644
--- a/web/core/components/issues/peek-overview/issue-detail.tsx
+++ b/web/core/components/issues/peek-overview/issue-detail.tsx
@@ -78,7 +78,7 @@ export const PeekOverviewIssueDetails: FC<IPeekOverviewIssueDetails> = observer(
disabled={disabled}
issueOperations={issueOperations}
setIsSubmitting={(value) => setIsSubmitting(value)}
- containerClassName="-ml-3 !mb-6 border-none"
+ containerClassName="-ml-3 border-none"
/>
{currentUser && (