π₯π₯π₯ Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.
TypeScript boardsbug-trackerdjangodockerganttissue-trackerjirajira-alternativekanbanlinearpostgresqlproduct-managementproject-managementproject-planningpythonreactredistypesciptvitework-management
improvement: add disable image upload using props (#6706)
Aaryan Khandelwalf65b9a4dcb6f
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.tsxindex 2bd84fcb31..de2a20ab96 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@@ -76,7 +76,7 @@ export const CustomImageNode = (props: CustomImageNodeProps) => {failedToLoadImage={failedToLoadImage}getPos={getPos}loadImageFromFileSystem={setImageFromFileSystem}- maxFileSize={editor.storage.imageComponent.maxFileSize}+ maxFileSize={editor.storage.imageComponent?.maxFileSize}node={node}setIsUploaded={setIsUploaded}selected={selected}diff --git a/packages/editor/src/core/extensions/custom-image/components/upload-status.tsx b/packages/editor/src/core/extensions/custom-image/components/upload-status.tsxindex 7b23713e9e..8b71713d24 100644--- a/packages/editor/src/core/extensions/custom-image/components/upload-status.tsx+++ b/packages/editor/src/core/extensions/custom-image/components/upload-status.tsx@@ -16,7 +16,7 @@ export const ImageUploadStatus: React.FC<Props> = (props) => {// subscribe to image upload statusconst uploadStatus: number | undefined = useEditorState({editor,- selector: ({ editor }) => editor.storage.imageComponent.assetsUploadStatus[nodeId],+ selector: ({ editor }) => editor.storage.imageComponent?.assetsUploadStatus[nodeId],});useEffect(() => {diff --git a/packages/editor/src/core/extensions/custom-image/custom-image.ts b/packages/editor/src/core/extensions/custom-image/custom-image.tsindex a4d38ceb59..3e35fd0e38 100644--- a/packages/editor/src/core/extensions/custom-image/custom-image.ts+++ b/packages/editor/src/core/extensions/custom-image/custom-image.ts@@ -22,7 +22,7 @@ declare module "@tiptap/core" {imageComponent: {insertImageComponent: ({ file, pos, event }: InsertImageComponentProps) => ReturnType;uploadImage: (blockId: string, file: File) => () => Promise<string> | undefined;- updateAssetsUploadStatus: (updatedStatus: TFileHandler["assetsUploadStatus"]) => () => void;+ updateAssetsUploadStatus?: (updatedStatus: TFileHandler["assetsUploadStatus"]) => () => void;getImageSource?: (path: string) => () => Promise<string>;restoreImage: (src: string) => () => Promise<void>;};diff --git a/packages/editor/src/core/extensions/extensions.tsx b/packages/editor/src/core/extensions/extensions.tsxindex 485269e828..8b9290d62d 100644--- a/packages/editor/src/core/extensions/extensions.tsx+++ b/packages/editor/src/core/extensions/extensions.tsx@@ -50,8 +50,7 @@ type TArguments = {export const CoreEditorExtensions = (args: TArguments): Extensions => {const { disabledExtensions, enableHistory, fileHandler, mentionHandler, placeholder, tabIndex } = args;- return [- // @ts-expect-error tiptap types are incorrect+ const extensions = [StarterKit.configure({bulletList: {HTMLAttributes: {@@ -109,12 +108,6 @@ export const CoreEditorExtensions = (args: TArguments): Extensions => {},}),CustomTypographyExtension,- ImageExtension(fileHandler).configure({- HTMLAttributes: {- class: "rounded-md",- },- }),- CustomImageExtension(fileHandler),TiptapUnderline,TextStyle,TaskList.configure({@@ -152,7 +145,7 @@ export const CoreEditorExtensions = (args: TArguments): Extensions => {if (node.type.name === "heading") return `Heading ${node.attrs.level}`;- if (editor.storage.imageComponent.uploadInProgress) return "";+ if (editor.storage.imageComponent?.uploadInProgress) return "";const shouldHidePlaceholder =editor.isActive("table") ||@@ -179,4 +172,18 @@ export const CoreEditorExtensions = (args: TArguments): Extensions => {disabledExtensions,}),];++ if (!disabledExtensions.includes("image")) {+ extensions.push(+ ImageExtension(fileHandler).configure({+ HTMLAttributes: {+ class: "rounded-md",+ },+ }),+ CustomImageExtension(fileHandler)+ );+ }++ // @ts-expect-error tiptap types are incorrect+ return extensions;};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.tsxindex b6dbd4c308..7167e622c3 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@@ -48,6 +48,7 @@ export const CustomImageComponentWithoutProps = () =>return {fileMap: new Map(),deletedImageSet: new Map<string, boolean>(),+ assetsUploadStatus: {},};},});diff --git a/packages/editor/src/core/extensions/read-only-extensions.tsx b/packages/editor/src/core/extensions/read-only-extensions.tsxindex eb52566572..b949fe6b7a 100644--- a/packages/editor/src/core/extensions/read-only-extensions.tsx+++ b/packages/editor/src/core/extensions/read-only-extensions.tsx@@ -41,8 +41,7 @@ type Props = {export const CoreReadOnlyEditorExtensions = (props: Props): Extensions => {const { disabledExtensions, fileHandler, mentionHandler } = props;- return [- // @ts-expect-error tiptap types are incorrect+ const extensions = [StarterKit.configure({bulletList: {HTMLAttributes: {@@ -94,12 +93,6 @@ export const CoreReadOnlyEditorExtensions = (props: Props): Extensions => {},}),CustomTypographyExtension,- ReadOnlyImageExtension(fileHandler).configure({- HTMLAttributes: {- class: "rounded-md",- },- }),- CustomReadOnlyImageExtension(fileHandler),TiptapUnderline,TextStyle,TaskList.configure({@@ -136,4 +129,18 @@ export const CoreReadOnlyEditorExtensions = (props: Props): Extensions => {disabledExtensions,}),];++ if (!disabledExtensions.includes("image")) {+ extensions.push(+ ReadOnlyImageExtension(fileHandler).configure({+ HTMLAttributes: {+ class: "rounded-md",+ },+ }),+ CustomReadOnlyImageExtension(fileHandler)+ );+ }++ // @ts-expect-error tiptap types are incorrect+ return extensions;};diff --git a/packages/editor/src/core/extensions/slash-commands/command-items-list.tsx b/packages/editor/src/core/extensions/slash-commands/command-items-list.tsxindex 034d3d8978..9fcc733aef 100644--- a/packages/editor/src/core/extensions/slash-commands/command-items-list.tsx+++ b/packages/editor/src/core/extensions/slash-commands/command-items-list.tsx@@ -43,7 +43,7 @@ import { CommandProps, ISlashCommandItem, TSlashCommandSectionKeys } from "@/typ// plane editor extensionsimport { coreEditorAdditionalSlashCommandOptions } from "@/plane-editor/extensions";// local types-import { TExtensionProps } from "./root";+import { TExtensionProps, TSlashCommandAdditionalOption } from "./root";export type TSlashCommandSection = {key: TSlashCommandSectionKeys;@@ -54,7 +54,7 @@ export type TSlashCommandSection = {export const getSlashCommandFilteredSections =(args: TExtensionProps) =>({ query }: { query: string }): TSlashCommandSection[] => {- const { additionalOptions, disabledExtensions } = args;+ const { additionalOptions: externalAdditionalOptions, disabledExtensions } = args;const SLASH_COMMAND_SECTIONS: TSlashCommandSection[] = [{key: "general",@@ -176,15 +176,6 @@ export const getSlashCommandFilteredSections =icon: <Code2 className="size-3.5" />,command: ({ editor, range }) => editor.chain().focus().deleteRange(range).toggleCodeBlock().run(),},- {- commandKey: "image",- key: "image",- title: "Image",- icon: <ImageIcon className="size-3.5" />,- description: "Insert an image",- searchTerms: ["img", "photo", "picture", "media", "upload"],- command: ({ editor, range }: CommandProps) => insertImage({ editor, event: "insert", range }),- },{commandKey: "callout",key: "callout",@@ -284,8 +275,24 @@ export const getSlashCommandFilteredSections =},];+ const internalAdditionalOptions: TSlashCommandAdditionalOption[] = [];+ if (!disabledExtensions?.includes("image")) {+ internalAdditionalOptions.push({+ commandKey: "image",+ key: "image",+ title: "Image",+ icon: <ImageIcon className="size-3.5" />,+ description: "Insert an image",+ searchTerms: ["img", "photo", "picture", "media", "upload"],+ command: ({ editor, range }: CommandProps) => insertImage({ editor, event: "insert", range }),+ section: "general",+ pushAfter: "code",+ });+ }+[- ...(additionalOptions ?? []),+ ...internalAdditionalOptions,+ ...(externalAdditionalOptions ?? []),...coreEditorAdditionalSlashCommandOptions({disabledExtensions,}),diff --git a/packages/editor/src/core/hooks/use-editor.ts b/packages/editor/src/core/hooks/use-editor.tsindex 16df9151ca..e520305ba8 100644--- a/packages/editor/src/core/hooks/use-editor.ts+++ b/packages/editor/src/core/hooks/use-editor.ts@@ -111,7 +111,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 populatedif (value == null) return;- if (editor && !editor.isDestroyed && !editor.storage.imageComponent.uploadInProgress) {+ if (editor && !editor.isDestroyed && !editor.storage.imageComponent?.uploadInProgress) {try {editor.commands.setContent(value, false, { preserveWhitespace: "full" });if (editor.state.selection) {@@ -129,7 +129,7 @@ export const useEditor = (props: CustomEditorProps) => {useEffect(() => {if (!editor) return;const assetsUploadStatus = fileHandler.assetsUploadStatus;- editor.commands.updateAssetsUploadStatus(assetsUploadStatus);+ editor.commands.updateAssetsUploadStatus?.(assetsUploadStatus);}, [editor, fileHandler.assetsUploadStatus]);useImperativeHandle(@@ -221,7 +221,7 @@ export const useEditor = (props: CustomEditorProps) => {if (!editor) return;scrollSummary(editor, marking);},- isEditorReadyToDiscard: () => editor?.storage.imageComponent.uploadInProgress === false,+ isEditorReadyToDiscard: () => editor?.storage.imageComponent?.uploadInProgress === false,setFocusAtPosition: (position: number) => {if (!editor || editor.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.tsindex 7d3dc7eaed..e57c811a07 100644--- a/packages/editor/src/core/hooks/use-file-upload.ts+++ b/packages/editor/src/core/hooks/use-file-upload.ts@@ -21,7 +21,9 @@ export const useUploader = (args: TUploaderArgs) => {const uploadFile = useCallback(async (file: File) => {const setImageUploadInProgress = (isUploading: boolean) => {- editor.storage.imageComponent.uploadInProgress = isUploading;+ if (editor.storage.imageComponent) {+ editor.storage.imageComponent.uploadInProgress = isUploading;+ }};setImageUploadInProgress(true);setUploading(true);diff --git a/packages/editor/src/core/types/extensions.ts b/packages/editor/src/core/types/extensions.tsindex b3aacccc0a..8c1c0a4803 100644--- a/packages/editor/src/core/types/extensions.ts+++ b/packages/editor/src/core/types/extensions.ts@@ -1 +1 @@-export type TExtensions = "ai" | "collaboration-cursor" | "issue-embed" | "slash-commands" | "enter-key";+export type TExtensions = "ai" | "collaboration-cursor" | "issue-embed" | "slash-commands" | "enter-key" | "image";