π₯π₯π₯ 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
[WEB-1067] chore: enter key entension added to editor package and issue modal description improvement (#4617)
Anmol Singh Bhatia05807fe123eb
diff --git a/packages/editor/rich-text-editor/src/ui/extensions/enter-key-extension.tsx b/packages/editor/rich-text-editor/src/ui/extensions/enter-key-extension.tsxnew file mode 100644index 0000000000..70037f0460--- /dev/null+++ b/packages/editor/rich-text-editor/src/ui/extensions/enter-key-extension.tsx@@ -0,0 +1,25 @@+import { Extension } from "@tiptap/core";++export const EnterKeyExtension = (onEnterKeyPress?: () => void) =>+ Extension.create({+ name: "enterKey",++ addKeyboardShortcuts(this) {+ return {+ Enter: () => {+ if (onEnterKeyPress) {+ onEnterKeyPress();+ }+ return true;+ },+ "Shift-Enter": ({ editor }) =>+ editor.commands.first(({ commands }) => [+ () => commands.newlineInCode(),+ () => commands.splitListItem("listItem"),+ () => commands.createParagraphNear(),+ () => commands.liftEmptyBlock(),+ () => commands.splitBlock(),+ ]),+ };+ },+ });diff --git a/packages/editor/rich-text-editor/src/ui/extensions/index.tsx b/packages/editor/rich-text-editor/src/ui/extensions/index.tsxindex 406fb677fd..b52361f6eb 100644--- a/packages/editor/rich-text-editor/src/ui/extensions/index.tsx+++ b/packages/editor/rich-text-editor/src/ui/extensions/index.tsx@@ -1,13 +1,21 @@import { UploadImage } from "@plane/editor-core";import { DragAndDrop, SlashCommand } from "@plane/editor-extensions";+import { EnterKeyExtension } from "./enter-key-extension";type TArguments = {uploadFile: UploadImage;dragDropEnabled?: boolean;setHideDragHandle?: (hideDragHandlerFromDragDrop: () => void) => void;+ onEnterKeyPress?: () => void;};-export const RichTextEditorExtensions = ({ uploadFile, dragDropEnabled, setHideDragHandle }: TArguments) => [+export const RichTextEditorExtensions = ({+ uploadFile,+ dragDropEnabled,+ setHideDragHandle,+ onEnterKeyPress,+}: TArguments) => [SlashCommand(uploadFile),dragDropEnabled === true && DragAndDrop(setHideDragHandle),+ EnterKeyExtension(onEnterKeyPress),];diff --git a/packages/editor/rich-text-editor/src/ui/index.tsx b/packages/editor/rich-text-editor/src/ui/index.tsxindex 0cb32e5434..ec5aa7359c 100644--- a/packages/editor/rich-text-editor/src/ui/index.tsx+++ b/packages/editor/rich-text-editor/src/ui/index.tsx@@ -37,6 +37,7 @@ export type IRichTextEditor = {};placeholder?: string | ((isFocused: boolean, value: string) => string);tabIndex?: number;+ onEnterKeyPress?: (e?: any) => void;};const RichTextEditor = (props: IRichTextEditor) => {@@ -54,6 +55,7 @@ const RichTextEditor = (props: IRichTextEditor) => {placeholder,tabIndex,mentionHandler,+ onEnterKeyPress,} = props;const [hideDragHandleOnMouseLeave, setHideDragHandleOnMouseLeave] = React.useState<() => void>(() => {});@@ -80,6 +82,7 @@ const RichTextEditor = (props: IRichTextEditor) => {uploadFile: fileHandler.upload,dragDropEnabled,setHideDragHandle: setHideDragHandleFunction,+ onEnterKeyPress,}),tabIndex,mentionHandler,diff --git a/web/components/inbox/modals/create-edit-modal/create-root.tsx b/web/components/inbox/modals/create-edit-modal/create-root.tsxindex 27e710a5fb..e22c48557c 100644--- a/web/components/inbox/modals/create-edit-modal/create-root.tsx+++ b/web/components/inbox/modals/create-edit-modal/create-root.tsx@@ -42,6 +42,7 @@ export const InboxIssueCreateRoot: FC<TInboxIssueCreateRoot> = observer((props)const router = useRouter();// refsconst descriptionEditorRef = useRef<EditorRefApi>(null);+ const submitBtnRef = useRef<HTMLButtonElement | null>(null);// hooksconst { captureIssueEvent } = useEventTracker();const { createInboxIssue } = useProjectInbox();@@ -139,6 +140,7 @@ export const InboxIssueCreateRoot: FC<TInboxIssueCreateRoot> = observer((props)handleData={handleFormData}editorRef={descriptionEditorRef}containerClassName="border-[0.5px] border-custom-border-200 py-3 min-h-[150px]"+ onEnterKeyPress={() => submitBtnRef?.current?.click()}/><InboxIssueProperties projectId={projectId} data={formData} handleData={handleFormData} /></div>@@ -158,6 +160,7 @@ export const InboxIssueCreateRoot: FC<TInboxIssueCreateRoot> = observer((props)</Button><Buttonvariant="primary"+ ref={submitBtnRef}size="sm"type="submit"loading={formSubmitting}diff --git a/web/components/inbox/modals/create-edit-modal/edit-root.tsx b/web/components/inbox/modals/create-edit-modal/edit-root.tsxindex 0c1fda13a7..a162599acd 100644--- a/web/components/inbox/modals/create-edit-modal/edit-root.tsx+++ b/web/components/inbox/modals/create-edit-modal/edit-root.tsx@@ -34,6 +34,7 @@ export const InboxIssueEditRoot: FC<TInboxIssueEditRoot> = observer((props) => {const router = useRouter();// refsconst descriptionEditorRef = useRef<EditorRefApi>(null);+ const submitBtnRef = useRef<HTMLButtonElement | null>(null);// store hooksconst { captureIssueEvent } = useEventTracker();const { currentProjectDetails } = useProject();@@ -148,6 +149,7 @@ export const InboxIssueEditRoot: FC<TInboxIssueEditRoot> = observer((props) => {handleData={handleFormData}editorRef={descriptionEditorRef}containerClassName="border-[0.5px] border-custom-border-200 py-3 min-h-[150px]"+ onEnterKeyPress={() => submitBtnRef?.current?.click()}/><InboxIssueProperties projectId={projectId} data={formData} handleData={handleFormData} isVisible /></div>@@ -160,6 +162,7 @@ export const InboxIssueEditRoot: FC<TInboxIssueEditRoot> = observer((props) => {variant="primary"size="sm"type="button"+ ref={submitBtnRef}loading={formSubmitting}disabled={isTitleLengthMoreThan255Character}onClick={handleFormSubmit}diff --git a/web/components/inbox/modals/create-edit-modal/issue-description.tsx b/web/components/inbox/modals/create-edit-modal/issue-description.tsxindex 882fb0f955..4b4cb261e7 100644--- a/web/components/inbox/modals/create-edit-modal/issue-description.tsx+++ b/web/components/inbox/modals/create-edit-modal/issue-description.tsx@@ -18,11 +18,13 @@ type TInboxIssueDescription = {data: Partial<TIssue>;handleData: (issueKey: keyof Partial<TIssue>, issueValue: Partial<TIssue>[keyof Partial<TIssue>]) => void;editorRef: RefObject<EditorRefApi>;+ onEnterKeyPress?: (e?: any) => void;};// TODO: have to implement GPT Assistanceexport const InboxIssueDescription: FC<TInboxIssueDescription> = observer((props) => {- const { containerClassName, workspaceSlug, projectId, workspaceId, data, handleData, editorRef } = props;+ const { containerClassName, workspaceSlug, projectId, workspaceId, data, handleData, editorRef, onEnterKeyPress } =+ props;// hooksconst { loader } = useProjectInbox();@@ -44,6 +46,7 @@ export const InboxIssueDescription: FC<TInboxIssueDescription> = observer((propsonChange={(_description: object, description_html: string) => handleData("description_html", description_html)}placeholder={getDescriptionPlaceholder}containerClassName={containerClassName}+ onEnterKeyPress={onEnterKeyPress}/>);});diff --git a/web/components/issues/issue-modal/form.tsx b/web/components/issues/issue-modal/form.tsxindex 4c608f83a3..a8a43ced88 100644--- a/web/components/issues/issue-modal/form.tsx+++ b/web/components/issues/issue-modal/form.tsx@@ -109,6 +109,7 @@ export const IssueFormRoot: FC<IssueFormProps> = observer((props) => {const [iAmFeelingLucky, setIAmFeelingLucky] = useState(false);// refsconst editorRef = useRef<EditorRefApi>(null);+ const submitBtnRef = useRef<HTMLButtonElement | null>(null);// routerconst router = useRouter();const { workspaceSlug } = router.query;@@ -470,6 +471,7 @@ export const IssueFormRoot: FC<IssueFormProps> = observer((props) => {onChange(description_html);handleFormChange();}}+ onEnterKeyPress={() => submitBtnRef?.current?.click()}ref={editorRef}tabIndex={getTabIndex("description_html")}placeholder={getDescriptionPlaceholder}@@ -770,6 +772,7 @@ export const IssueFormRoot: FC<IssueFormProps> = observer((props) => {variant="primary"type="submit"size="sm"+ ref={submitBtnRef}loading={isSubmitting}tabIndex={isDraft ? getTabIndex("submit_button") : getTabIndex("draft_button")}>