π₯π₯π₯ 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
[WIKI-638] fix: peek overview closing while dropdowns are open (#7841)
Aaryan Khandelwaldce8b75a1e4d
diff --git a/apps/web/core/components/issues/peek-overview/issue-detail.tsx b/apps/web/core/components/issues/peek-overview/issue-detail.tsxindex 781aa623cf..20d89a78f0 100644--- a/apps/web/core/components/issues/peek-overview/issue-detail.tsx+++ b/apps/web/core/components/issues/peek-overview/issue-detail.tsx@@ -29,7 +29,8 @@ import { IssueTitleInput } from "../title-input";// services initconst workItemVersionService = new WorkItemVersionService();-interface IPeekOverviewIssueDetails {+type Props = {+ editorRef: React.RefObject<EditorRefApi>;workspaceSlug: string;projectId: string;issueId: string;@@ -38,12 +39,11 @@ interface IPeekOverviewIssueDetails {isArchived: boolean;isSubmitting: TNameDescriptionLoader;setIsSubmitting: (value: TNameDescriptionLoader) => void;-}+};-export const PeekOverviewIssueDetails: FC<IPeekOverviewIssueDetails> = observer((props) => {- const { workspaceSlug, issueId, issueOperations, disabled, isArchived, isSubmitting, setIsSubmitting } = props;- // refs- const editorRef = useRef<EditorRefApi>(null);+export const PeekOverviewIssueDetails: FC<Props> = observer((props) => {+ const { editorRef, workspaceSlug, issueId, issueOperations, disabled, isArchived, isSubmitting, setIsSubmitting } =+ props;// store hooksconst { data: currentUser } = useUser();const {diff --git a/apps/web/core/components/issues/peek-overview/view.tsx b/apps/web/core/components/issues/peek-overview/view.tsxindex bbae72db33..9840de4cee 100644--- a/apps/web/core/components/issues/peek-overview/view.tsx+++ b/apps/web/core/components/issues/peek-overview/view.tsx@@ -2,6 +2,7 @@ import { FC, useRef, useState } from "react";import { observer } from "mobx-react";import { createPortal } from "react-dom";// plane imports+import type { EditorRefApi } from "@plane/editor";import { EIssueServiceType, TNameDescriptionLoader } from "@plane/types";import { cn } from "@plane/utils";// hooks@@ -53,6 +54,7 @@ export const IssueView: FC<IIssueView> = observer((props) => {const [isEditIssueModalOpen, setIsEditIssueModalOpen] = useState(false);// refconst issuePeekOverviewRef = useRef<HTMLDivElement>(null);+ const editorRef = useRef<EditorRefApi>(null);// store hooksconst {setPeekIssue,@@ -80,8 +82,9 @@ export const IssueView: FC<IIssueView> = observer((props) => {usePeekOverviewOutsideClickDetector(issuePeekOverviewRef,() => {+ const isAnyDropbarOpen = editorRef.current?.isAnyDropbarOpen();if (!embedIssue) {- if (!isAnyModalOpen && !isAnyEpicModalOpen && !isAnyLocalModalOpen) {+ if (!isAnyModalOpen && !isAnyEpicModalOpen && !isAnyLocalModalOpen && !isAnyDropbarOpen) {removeRoutePeekId();}}@@ -90,10 +93,10 @@ export const IssueView: FC<IIssueView> = observer((props) => {);const handleKeyDown = () => {- const slashCommandDropdownElement = document.querySelector("#slash-command");const editorImageFullScreenModalElement = document.querySelector(".editor-image-full-screen-modal");const dropdownElement = document.activeElement?.tagName === "INPUT";- if (!isAnyModalOpen && !slashCommandDropdownElement && !dropdownElement && !editorImageFullScreenModalElement) {+ const isAnyDropbarOpen = editorRef.current?.isAnyDropbarOpen();+ if (!isAnyModalOpen && !dropdownElement && !isAnyDropbarOpen && !editorImageFullScreenModalElement) {removeRoutePeekId();const issueElement = document.getElementById(`issue-${issueId}`);if (issueElement) issueElement?.focus();@@ -166,6 +169,7 @@ export const IssueView: FC<IIssueView> = observer((props) => {{["side-peek", "modal"].includes(peekMode) ? (<div className="relative flex flex-col gap-3 px-8 py-5 space-y-3"><PeekOverviewIssueDetails+ editorRef={editorRef}workspaceSlug={workspaceSlug}projectId={projectId}issueId={issueId}@@ -206,6 +210,7 @@ export const IssueView: FC<IIssueView> = observer((props) => {<div className="relative h-full w-full space-y-6 overflow-auto p-4 py-5"><div className="space-y-3"><PeekOverviewIssueDetails+ editorRef={editorRef}workspaceSlug={workspaceSlug}projectId={projectId}issueId={issueId}diff --git a/packages/editor/src/core/extensions/slash-commands/root.tsx b/packages/editor/src/core/extensions/slash-commands/root.tsxindex 43d7cf6128..971c4da565 100644--- a/packages/editor/src/core/extensions/slash-commands/root.tsx+++ b/packages/editor/src/core/extensions/slash-commands/root.tsx@@ -55,11 +55,14 @@ const Command = Extension.create<SlashCommandOptions>({},});-const renderItems = () => {+const renderItems: SuggestionOptions["render"] = () => {let component: ReactRenderer<CommandListInstance, SlashCommandsMenuProps> | null = null;let popup: Instance | null = null;return {- onStart: (props: { editor: Editor; clientRect?: (() => DOMRect | null) | null }) => {+ onStart: (props) => {+ // Track active dropdown+ props.editor.commands.addActiveDropbarExtension(CORE_EXTENSIONS.SLASH_COMMANDS);+component = new ReactRenderer<CommandListInstance, SlashCommandsMenuProps>(SlashCommandsMenu, {props,editor: props.editor,@@ -78,14 +81,14 @@ const renderItems = () => {placement: "bottom-start",});},- onUpdate: (props: { editor: Editor; clientRect?: (() => DOMRect | null) | null }) => {+ onUpdate: (props) => {component?.updateProps(props);popup?.[0]?.setProps({getReferenceClientRect: props.clientRect,});},- onKeyDown: (props: { event: KeyboardEvent }) => {+ onKeyDown: (props) => {if (props.event.key === "Escape") {popup?.[0].hide();return true;@@ -95,7 +98,9 @@ const renderItems = () => {}return false;},- onExit: () => {+ onExit: ({ editor }) => {+ // Remove from active dropdowns+ editor?.commands.removeActiveDropbarExtension(CORE_EXTENSIONS.SLASH_COMMANDS);popup?.[0].destroy();component?.destroy();},diff --git a/packages/editor/src/core/extensions/table/plugins/drag-handles/column/drag-handle.tsx b/packages/editor/src/core/extensions/table/plugins/drag-handles/column/drag-handle.tsxindex 425bc7572f..b4322b2389 100644--- a/packages/editor/src/core/extensions/table/plugins/drag-handles/column/drag-handle.tsx+++ b/packages/editor/src/core/extensions/table/plugins/drag-handles/column/drag-handle.tsx@@ -15,6 +15,8 @@ import { Ellipsis } from "lucide-react";import { useCallback, useState } from "react";// plane importsimport { cn } from "@plane/utils";+// constants+import { CORE_EXTENSIONS } from "@/constants/extension";// extensionsimport {findTable,@@ -59,7 +61,16 @@ export const ColumnDragHandle: React.FC<ColumnDragHandleProps> = (props) => {}),],open: isDropdownOpen,- onOpenChange: setIsDropdownOpen,+ onOpenChange: (open) => {+ setIsDropdownOpen(open);+ if (open) {+ editor.commands.addActiveDropbarExtension(CORE_EXTENSIONS.TABLE);+ } else {+ setTimeout(() => {+ editor.commands.removeActiveDropbarExtension(CORE_EXTENSIONS.TABLE);+ }, 0);+ }+ },whileElementsMounted: autoUpdate,});const click = useClick(context);@@ -185,7 +196,6 @@ export const ColumnDragHandle: React.FC<ColumnDragHandleProps> = (props) => {}}lockScroll/>-<divclassName="max-h-[90vh] w-[12rem] overflow-y-auto rounded-md border-[0.5px] border-custom-border-300 bg-custom-background-100 px-2 py-2.5 shadow-custom-shadow-rg"ref={refs.setFloating}@@ -195,7 +205,7 @@ export const ColumnDragHandle: React.FC<ColumnDragHandleProps> = (props) => {zIndex: 100,}}>- <ColumnOptionsDropdown editor={editor} onClose={() => setIsDropdownOpen(false)} />+ <ColumnOptionsDropdown editor={editor} onClose={() => context.onOpenChange(false)} /></div></FloatingPortal>)}diff --git a/packages/editor/src/core/extensions/table/plugins/drag-handles/row/drag-handle.tsx b/packages/editor/src/core/extensions/table/plugins/drag-handles/row/drag-handle.tsxindex 7c0f1449a1..d556e71bc4 100644--- a/packages/editor/src/core/extensions/table/plugins/drag-handles/row/drag-handle.tsx+++ b/packages/editor/src/core/extensions/table/plugins/drag-handles/row/drag-handle.tsx@@ -15,6 +15,8 @@ import { Ellipsis } from "lucide-react";import { useCallback, useState } from "react";// plane importsimport { cn } from "@plane/utils";+// constants+import { CORE_EXTENSIONS } from "@/constants/extension";// extensionsimport {findTable,@@ -59,7 +61,16 @@ export const RowDragHandle: React.FC<RowDragHandleProps> = (props) => {}),],open: isDropdownOpen,- onOpenChange: setIsDropdownOpen,+ onOpenChange: (open) => {+ setIsDropdownOpen(open);+ if (open) {+ editor.commands.addActiveDropbarExtension(CORE_EXTENSIONS.TABLE);+ } else {+ setTimeout(() => {+ editor.commands.removeActiveDropbarExtension(CORE_EXTENSIONS.TABLE);+ }, 0);+ }+ },whileElementsMounted: autoUpdate,});const click = useClick(context);@@ -184,7 +195,6 @@ export const RowDragHandle: React.FC<RowDragHandleProps> = (props) => {}}lockScroll/>-<divclassName="max-h-[90vh] w-[12rem] overflow-y-auto rounded-md border-[0.5px] border-custom-border-300 bg-custom-background-100 px-2 py-2.5 shadow-custom-shadow-rg"ref={refs.setFloating}@@ -194,7 +204,7 @@ export const RowDragHandle: React.FC<RowDragHandleProps> = (props) => {zIndex: 100,}}>- <RowOptionsDropdown editor={editor} onClose={() => setIsDropdownOpen(false)} />+ <RowOptionsDropdown editor={editor} onClose={() => context.onOpenChange(false)} /></div></FloatingPortal>)}diff --git a/packages/editor/src/core/extensions/utility.ts b/packages/editor/src/core/extensions/utility.tsindex 3c014538d3..77fdcc9125 100644--- a/packages/editor/src/core/extensions/utility.ts+++ b/packages/editor/src/core/extensions/utility.ts@@ -9,13 +9,18 @@ import { DropHandlerPlugin } from "@/plugins/drop";import { FilePlugins } from "@/plugins/file/root";import { MarkdownClipboardPlugin } from "@/plugins/markdown-clipboard";// types-import type { IEditorProps, TEditorAsset, TFileHandler } from "@/types";-type TActiveDropbarExtensions = CORE_EXTENSIONS.MENTION | CORE_EXTENSIONS.EMOJI | TAdditionalActiveDropbarExtensions;++type TActiveDropbarExtensions =+ | CORE_EXTENSIONS.MENTION+ | CORE_EXTENSIONS.EMOJI+ | CORE_EXTENSIONS.SLASH_COMMANDS+ | CORE_EXTENSIONS.TABLE+ | TAdditionalActiveDropbarExtensions;declare module "@tiptap/core" {interface Commands {- utility: {+ [CORE_EXTENSIONS.UTILITY]: {updateAssetsUploadStatus: (updatedStatus: TFileHandler["assetsUploadStatus"]) => () => void;updateAssetsList: (args:@@ -26,6 +31,8 @@ declare module "@tiptap/core" {idToRemove: string;}) => () => void;+ addActiveDropbarExtension: (extension: TActiveDropbarExtensions) => () => void;+ removeActiveDropbarExtension: (extension: TActiveDropbarExtensions) => () => void;};}}@@ -102,6 +109,18 @@ export const UtilityExtension = (props: Props) => {}this.storage.assetsList = Array.from(uniqueAssets);},+ addActiveDropbarExtension: (extension) => () => {+ const index = this.storage.activeDropbarExtensions.indexOf(extension);+ if (index === -1) {+ this.storage.activeDropbarExtensions.push(extension);+ }+ },+ removeActiveDropbarExtension: (extension) => () => {+ const index = this.storage.activeDropbarExtensions.indexOf(extension);+ if (index !== -1) {+ this.storage.activeDropbarExtensions.splice(index, 1);+ }+ },};},});diff --git a/packages/editor/src/core/helpers/editor-ref.ts b/packages/editor/src/core/helpers/editor-ref.tsindex 49d20df940..2e45e89633 100644--- a/packages/editor/src/core/helpers/editor-ref.ts+++ b/packages/editor/src/core/helpers/editor-ref.ts@@ -81,6 +81,11 @@ export const getEditorRefHelpers = (args: TArgs): EditorRefApi => {const markdownOutput = editor?.storage?.markdown?.getMarkdown?.();return markdownOutput;},+ isAnyDropbarOpen: () => {+ if (!editor) return false;+ const utilityStorage = getExtensionStorage(editor, CORE_EXTENSIONS.UTILITY);+ return utilityStorage.activeDropbarExtensions.length > 0;+ },scrollSummary: (marking) => {if (!editor) return;scrollSummary(editor, marking);diff --git a/packages/editor/src/core/types/editor.ts b/packages/editor/src/core/types/editor.tsindex 6c72541377..a99870c05a 100644--- a/packages/editor/src/core/types/editor.ts+++ b/packages/editor/src/core/types/editor.ts@@ -119,6 +119,7 @@ export type EditorRefApi = {getMarkDown: () => string;getSelectedText: () => string | null;insertText: (contentHTML: string, insertOnNextLine?: boolean) => void;+ isAnyDropbarOpen: () => boolean;isEditorReadyToDiscard: () => boolean;isMenuItemActive: <T extends TEditorCommands>(props: TCommandWithPropsWithItemKey<T>) => boolean;listenToRealTimeUpdate: () => TDocumentEventEmitter | undefined;