π₯π₯π₯ 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-773] refactor: editor mention components and hooks (#8111)
Aaryan Khandelwalc65e2c4aab05
diff --git a/apps/space/ce/components/editor/embeds/mentions/root.tsx b/apps/space/ce/components/editor/embeds/mentions/root.tsxindex 23f15fe274..299a1e36a0 100644--- a/apps/space/ce/components/editor/embeds/mentions/root.tsx+++ b/apps/space/ce/components/editor/embeds/mentions/root.tsx@@ -1,4 +1,4 @@// plane editor-import type { TMentionComponentProps } from "@plane/editor";+import type { TCallbackMentionComponentProps } from "@plane/editor";-export const EditorAdditionalMentionsRoot: React.FC<TMentionComponentProps> = () => null;+export const EditorAdditionalMentionsRoot: React.FC<TCallbackMentionComponentProps> = () => null;diff --git a/apps/space/core/components/editor/embeds/mentions/root.tsx b/apps/space/core/components/editor/embeds/mentions/root.tsxindex 95149b9267..348bc1e094 100644--- a/apps/space/core/components/editor/embeds/mentions/root.tsx+++ b/apps/space/core/components/editor/embeds/mentions/root.tsx@@ -1,11 +1,11 @@// plane editor-import type { TMentionComponentProps } from "@plane/editor";+import type { TCallbackMentionComponentProps } from "@plane/editor";// plane web componentsimport { EditorAdditionalMentionsRoot } from "@/plane-web/components/editor";// local componentsimport { EditorUserMention } from "./user";-export const EditorMentionsRoot: React.FC<TMentionComponentProps> = (props) => {+export const EditorMentionsRoot: React.FC<TCallbackMentionComponentProps> = (props) => {const { entity_identifier, entity_name } = props;switch (entity_name) {diff --git a/apps/web/ce/components/editor/embeds/index.ts b/apps/web/ce/components/editor/embeds/index.tsdeleted file mode 100644index 8146e94d92..0000000000--- a/apps/web/ce/components/editor/embeds/index.ts+++ /dev/null@@ -1 +0,0 @@-export * from "./mentions";diff --git a/apps/web/ce/components/editor/embeds/mentions/root.tsx b/apps/web/ce/components/editor/embeds/mentions/root.tsxindex 23f15fe274..e3d7cc49de 100644--- a/apps/web/ce/components/editor/embeds/mentions/root.tsx+++ b/apps/web/ce/components/editor/embeds/mentions/root.tsx@@ -1,4 +1,6 @@-// plane editor-import type { TMentionComponentProps } from "@plane/editor";+// plane imports+import type { TCallbackMentionComponentProps } from "@plane/editor";-export const EditorAdditionalMentionsRoot: React.FC<TMentionComponentProps> = () => null;+export type TEditorMentionComponentProps = TCallbackMentionComponentProps;++export const EditorAdditionalMentionsRoot: React.FC<TEditorMentionComponentProps> = () => null;diff --git a/apps/web/ce/components/editor/index.ts b/apps/web/ce/components/editor/index.tsdeleted file mode 100644index cf8352ae4a..0000000000--- a/apps/web/ce/components/editor/index.ts+++ /dev/null@@ -1 +0,0 @@-export * from "./embeds";diff --git a/apps/web/ce/constants/editor.ts b/apps/web/ce/constants/editor.tsdeleted file mode 100644index f018796026..0000000000--- a/apps/web/ce/constants/editor.ts+++ /dev/null@@ -1,4 +0,0 @@-// plane types-import type { TSearchEntities } from "@plane/types";--export const EDITOR_MENTION_TYPES: TSearchEntities[] = ["user_mention"];diff --git a/apps/web/ce/hooks/use-additional-editor-mention.tsx b/apps/web/ce/hooks/use-additional-editor-mention.tsxindex 604649e71f..a3b719231d 100644--- a/apps/web/ce/hooks/use-additional-editor-mention.tsx+++ b/apps/web/ce/hooks/use-additional-editor-mention.tsx@@ -1,11 +1,18 @@-import { useCallback } from "react";+import { useCallback, useMemo } from "react";// plane editorimport type { TMentionSection } from "@plane/editor";// plane typesimport type { TSearchEntities, TSearchResponse } from "@plane/types";+export type TUseAdditionalEditorMentionArgs = {+ enableAdvancedMentions: boolean;+};+export type TAdditionalEditorMentionHandlerArgs = {response: TSearchResponse;+};++export type TAdditionalEditorMentionHandlerReturnType = {sections: TMentionSection[];};@@ -21,21 +28,24 @@ export type TAdditionalParseEditorContentReturnType =}| undefined;-export const useAdditionalEditorMention = () => {- const updateAdditionalSections = useCallback((args: TAdditionalEditorMentionHandlerArgs) => {- const {} = args;- }, []);+export const useAdditionalEditorMention = (_args: TUseAdditionalEditorMentionArgs) => {+ const updateAdditionalSections = useCallback(+ (_args: TAdditionalEditorMentionHandlerArgs): TAdditionalEditorMentionHandlerReturnType => ({+ sections: [],+ }),+ []+ );const parseAdditionalEditorContent = useCallback(- (args: TAdditionalParseEditorContentArgs): TAdditionalParseEditorContentReturnType => {- const {} = args;- return undefined;- },+ (_args: TAdditionalParseEditorContentArgs): TAdditionalParseEditorContentReturnType => undefined,[]);+ const editorMentionTypes: TSearchEntities[] = useMemo(() => ["user_mention"], []);+return {updateAdditionalSections,parseAdditionalEditorContent,+ editorMentionTypes,};};diff --git a/apps/web/core/components/editor/document/editor.tsx b/apps/web/core/components/editor/document/editor.tsxindex 9695088b4a..573d96d3d6 100644--- a/apps/web/core/components/editor/document/editor.tsx+++ b/apps/web/core/components/editor/document/editor.tsx@@ -1,4 +1,4 @@-import React, { forwardRef } from "react";+import { forwardRef } from "react";// plane importsimport { DocumentEditorWithRef } from "@plane/editor";import type { IEditorPropsExtended, EditorRefApi, IDocumentEditorProps, TFileHandler } from "@plane/editor";@@ -50,6 +50,7 @@ export const DocumentEditor = forwardRef<EditorRefApi, DocumentEditorWrapperProp});// use editor mentionconst { fetchMentions } = useEditorMention({+ enableAdvancedMentions: true,searchEntity: editable ? async (payload) => await props.searchMentionCallback(payload) : async () => ({}),});// editor configdiff --git a/apps/web/core/components/editor/embeds/mentions/root.tsx b/apps/web/core/components/editor/embeds/mentions/root.tsxindex 95149b9267..bc27dd82f9 100644--- a/apps/web/core/components/editor/embeds/mentions/root.tsx+++ b/apps/web/core/components/editor/embeds/mentions/root.tsx@@ -1,11 +1,10 @@-// plane editor-import type { TMentionComponentProps } from "@plane/editor";-// plane web components-import { EditorAdditionalMentionsRoot } from "@/plane-web/components/editor";-// local components+// plane web imports+import type { TEditorMentionComponentProps } from "@/plane-web/components/editor/embeds/mentions";+import { EditorAdditionalMentionsRoot } from "@/plane-web/components/editor/embeds/mentions";+// local importsimport { EditorUserMention } from "./user";-export const EditorMentionsRoot: React.FC<TMentionComponentProps> = (props) => {+export const EditorMentionsRoot: React.FC<TEditorMentionComponentProps> = (props) => {const { entity_identifier, entity_name } = props;switch (entity_name) {diff --git a/apps/web/core/components/editor/embeds/mentions/user.tsx b/apps/web/core/components/editor/embeds/mentions/user.tsxindex 0c4239cf32..206682fba5 100644--- a/apps/web/core/components/editor/embeds/mentions/user.tsx+++ b/apps/web/core/components/editor/embeds/mentions/user.tsx@@ -1,15 +1,11 @@-import { useState } from "react";import { observer } from "mobx-react";-import Link from "next/link";import { useParams } from "next/navigation";-import { usePopper } from "react-popper";+import { Link } from "react-router";// plane importsimport { ROLE } from "@plane/constants";-// plane ui+import { Popover } from "@plane/propel/popover";import { Avatar } from "@plane/ui";import { cn, getFileURL } from "@plane/utils";-// constants-// helpers// hooksimport { useMember } from "@/hooks/store/use-member";import { useUser } from "@/hooks/store/user";@@ -22,9 +18,6 @@ export const EditorUserMention: React.FC<Props> = observer((props) => {const { id } = props;// routerconst { projectId } = useParams();- // states- const [popperElement, setPopperElement] = useState<HTMLDivElement | null>(null);- const [referenceElement, setReferenceElement] = useState<HTMLAnchorElement | null>(null);// paramsconst { workspaceSlug } = useParams();// store hooks@@ -33,18 +26,6 @@ export const EditorUserMention: React.FC<Props> = observer((props) => {getUserDetails,project: { getProjectMemberDetails },} = useMember();- // popper-js refs- const { styles, attributes } = usePopper(referenceElement, popperElement, {- placement: "bottom-start",- modifiers: [- {- name: "preventOverflow",- options: {- padding: 12,- },- },- ],- });// derived valuesconst userDetails = getUserDetails(id);const roleDetails = projectId ? getProjectMemberDetails(id, projectId.toString())?.role : null;@@ -53,7 +34,7 @@ export const EditorUserMention: React.FC<Props> = observer((props) => {if (!userDetails) {return (<div className="not-prose inline px-1 py-0.5 rounded bg-custom-background-80 text-custom-text-300 no-underline">- @deactivated user+ @suspended user</div>);}@@ -61,39 +42,38 @@ export const EditorUserMention: React.FC<Props> = observer((props) => {return (<divclassName={cn(- "not-prose group/user-mention inline px-1 py-0.5 rounded bg-custom-primary-100/20 text-custom-primary-100 no-underline",+ "not-prose inline px-1 py-0.5 rounded bg-custom-primary-100/20 text-custom-primary-100 no-underline",{"bg-yellow-500/20 text-yellow-500": id === currentUser?.id,})}>- <Link href={profileLink} ref={setReferenceElement}>- @{userDetails?.display_name}- </Link>- <div- className="top-full left-0 z-10 min-w-60 bg-custom-background-90 shadow-custom-shadow-rg rounded-lg p-4 opacity-0 pointer-events-none group-hover/user-mention:opacity-100 group-hover/user-mention:pointer-events-auto transition-opacity"- ref={setPopperElement}- style={styles.popper}- {...attributes.popper}- >- <div className="flex items-center gap-3">- <div className="flex-shrink-0 size-10 grid place-items-center">- <Avatar- src={getFileURL(userDetails?.avatar_url ?? "")}- name={userDetails?.display_name}- size={40}- className="text-xl"- showTooltip={false}- />+ <Popover delay={100} openOnHover>+ <Popover.Button>+ <Link to={profileLink}>@{userDetails?.display_name}</Link>+ </Popover.Button>+ <Popover.Panel side="bottom" align="start">+ <div className="w-60 bg-custom-background-100 shadow-custom-shadow-rg rounded-lg p-3 border-[0.5px] border-custom-border-300">+ <div className="flex items-center gap-3">+ <div className="flex-shrink-0 size-10 grid place-items-center">+ <Avatar+ src={getFileURL(userDetails?.avatar_url ?? "")}+ name={userDetails?.display_name}+ size={40}+ className="text-xl"+ showTooltip={false}+ />+ </div>+ <div>+ <Link to={profileLink} className="not-prose font-medium text-custom-text-100 text-sm hover:underline">+ {userDetails?.first_name} {userDetails?.last_name}+ </Link>+ {roleDetails && <p className="text-custom-text-200 text-xs">{ROLE[roleDetails]}</p>}+ </div>+ </div></div>- <div>- <Link href={profileLink} className="not-prose font-medium text-custom-text-100 text-sm hover:underline">- {userDetails?.first_name} {userDetails?.last_name}- </Link>- {roleDetails && <p className="text-custom-text-200 text-xs">{ROLE[roleDetails]}</p>}- </div>- </div>- </div>+ </Popover.Panel>+ </Popover></div>);});diff --git a/apps/web/core/components/pages/editor/editor-body.tsx b/apps/web/core/components/pages/editor/editor-body.tsxindex 476917252c..598a9e1fc2 100644--- a/apps/web/core/components/pages/editor/editor-body.tsx+++ b/apps/web/core/components/pages/editor/editor-body.tsx@@ -95,6 +95,7 @@ export const PageEditorBody: React.FC<Props> = observer((props) => {const workspaceId = getWorkspaceBySlug(workspaceSlug)?.id ?? "";// use editor mentionconst { fetchMentions } = useEditorMention({+ enableAdvancedMentions: true,searchEntity: handlers.fetchEntity,});// editor flaggingsdiff --git a/apps/web/core/hooks/editor/use-editor-mention.tsx b/apps/web/core/hooks/editor/use-editor-mention.tsxindex 03598191ae..622fc04389 100644--- a/apps/web/core/hooks/editor/use-editor-mention.tsx+++ b/apps/web/core/hooks/editor/use-editor-mention.tsx@@ -7,26 +7,27 @@ import type { TSearchEntities, TSearchEntityRequestPayload, TSearchResponse, TUsimport { Avatar } from "@plane/ui";// helpersimport { getFileURL } from "@plane/utils";-// plane web constants-import { EDITOR_MENTION_TYPES } from "@/plane-web/constants/editor";// plane web hooksimport { useAdditionalEditorMention } from "@/plane-web/hooks/use-additional-editor-mention";type TArgs = {+ enableAdvancedMentions?: boolean;searchEntity: (payload: TSearchEntityRequestPayload) => Promise<TSearchResponse>;};export const useEditorMention = (args: TArgs) => {- const { searchEntity } = args;+ const { enableAdvancedMentions = false, searchEntity } = args;// additional mentions- const { updateAdditionalSections } = useAdditionalEditorMention();+ const { editorMentionTypes, updateAdditionalSections } = useAdditionalEditorMention({+ enableAdvancedMentions,+ });// fetch mentions handlerconst fetchMentions = useCallback(async (query: string): Promise<TMentionSection[]> => {try {const res = await searchEntity({count: 5,- query_type: EDITOR_MENTION_TYPES,+ query_type: editorMentionTypes,query,});const suggestionSections: TMentionSection[] = [];@@ -57,17 +58,16 @@ export const useEditorMention = (args: TArgs) => {});}});- updateAdditionalSections({+ const { sections } = updateAdditionalSections({response: res,- sections: suggestionSections,});- return suggestionSections;+ return [...suggestionSections, ...sections];} catch (error) {- console.error("Error in fetching mentions for project pages:", error);+ console.error("Error in fetching mentions:", error);throw error;}},- [searchEntity, updateAdditionalSections]+ [editorMentionTypes, searchEntity, updateAdditionalSections]);return {diff --git a/apps/web/core/hooks/use-parse-editor-content.ts b/apps/web/core/hooks/use-parse-editor-content.tsindex 2845ba20b3..bf52fff084 100644--- a/apps/web/core/hooks/use-parse-editor-content.ts+++ b/apps/web/core/hooks/use-parse-editor-content.ts@@ -15,7 +15,9 @@ export const useParseEditorContent = () => {// store hooksconst { getUserDetails } = useMember();// parse additional content- const { parseAdditionalEditorContent } = useAdditionalEditorMention();+ const { parseAdditionalEditorContent } = useAdditionalEditorMention({+ enableAdvancedMentions: true,+ });/*** @description function to replace all the custom components from the html component to make it pdf compatiblediff --git a/apps/web/ee/components/editor/index.ts b/apps/web/ee/components/editor/index.tsdeleted file mode 100644index f8506c1d6d..0000000000--- a/apps/web/ee/components/editor/index.ts+++ /dev/null@@ -1 +0,0 @@-export * from "ce/components/editor";diff --git a/apps/web/ee/constants/editor.ts b/apps/web/ee/constants/editor.tsdeleted file mode 100644index c59cd0b613..0000000000--- a/apps/web/ee/constants/editor.ts+++ /dev/null@@ -1 +0,0 @@-export * from "ce/constants/editor";diff --git a/packages/editor/src/core/types/mention.ts b/packages/editor/src/core/types/mention.tsindex ab7020c486..4fed4aad85 100644--- a/packages/editor/src/core/types/mention.ts+++ b/packages/editor/src/core/types/mention.ts@@ -16,10 +16,10 @@ export type TMentionSection = {items: TMentionSuggestion[];};-export type TMentionComponentProps = Pick<TMentionSuggestion, "entity_identifier" | "entity_name">;+export type TCallbackMentionComponentProps = Pick<TMentionSuggestion, "entity_identifier" | "entity_name">;export type TMentionHandler = {getMentionedEntityDetails?: (entity_identifier: string) => { display_name: string } | undefined;- renderComponent: (props: TMentionComponentProps) => React.ReactNode;+ renderComponent: (props: TCallbackMentionComponentProps) => React.ReactNode;searchCallback?: (query: string) => Promise<TMentionSection[]>;};diff --git a/packages/types/src/issues/issue.ts b/packages/types/src/issues/issue.tsindex f24e2718c9..127dc1cad4 100644--- a/packages/types/src/issues/issue.ts+++ b/packages/types/src/issues/issue.ts@@ -1,4 +1,5 @@import type { TIssuePriorities } from "../issues";+import type { TStateGroups } from "../state";import type { TIssuePublicComment } from "./activity/issue_comment";import type { TIssueAttachment } from "./issue_attachment";import type { TIssueLink } from "./issue_link";@@ -93,7 +94,7 @@ export type TIssue = TBaseIssue & {tempId?: string;// sourceIssueId is used to store the original issue id when creating a copy of an issue. Used in cloning property values. It is not a part of the API response.sourceIssueId?: string;- state__group?: string | null;+ state__group?: TStateGroups | null;};export type TIssueMap = {