π₯π₯π₯ 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-638] feat: add tabIndex prop support to navigate using Tab key in all the editors (#3902)
M. Palanikannan4b30339a59a6
diff --git a/packages/editor/core/src/ui/components/editor-content.tsx b/packages/editor/core/src/ui/components/editor-content.tsxindex 9c09387882..7a6ce30f77 100644--- a/packages/editor/core/src/ui/components/editor-content.tsx+++ b/packages/editor/core/src/ui/components/editor-content.tsx@@ -1,17 +1,28 @@import { Editor, EditorContent } from "@tiptap/react";-import { ReactNode } from "react";+import { FC, ReactNode } from "react";import { ImageResizer } from "src/ui/extensions/image/image-resize";interface EditorContentProps {editor: Editor | null;editorContentCustomClassNames: string | undefined;children?: ReactNode;+ tabIndex?: number;}-export const EditorContentWrapper = ({ editor, editorContentCustomClassNames = "", children }: EditorContentProps) => (- <div className={`contentEditor ${editorContentCustomClassNames}`}>- <EditorContent editor={editor} />- {editor?.isActive("image") && editor?.isEditable && <ImageResizer editor={editor} />}- {children}- </div>-);+export const EditorContentWrapper: FC<EditorContentProps> = (props) => {+ const { editor, editorContentCustomClassNames = "", tabIndex, children } = props;++ return (+ <div+ className={`contentEditor ${editorContentCustomClassNames}`}+ tabIndex={tabIndex}+ onFocus={() => {+ editor?.chain().focus(undefined, { scrollIntoView: false }).run();+ }}+ >+ <EditorContent editor={editor} />+ {editor?.isActive("image") && editor?.isEditable && <ImageResizer editor={editor} />}+ {children}+ </div>+ );+};diff --git a/packages/editor/document-editor/src/ui/components/content-browser.tsx b/packages/editor/document-editor/src/ui/components/content-browser.tsxindex be70067a20..926d9a53de 100644--- a/packages/editor/document-editor/src/ui/components/content-browser.tsx+++ b/packages/editor/document-editor/src/ui/components/content-browser.tsx@@ -19,7 +19,7 @@ export const ContentBrowser = (props: ContentBrowserProps) => {return (<div className="flex h-full flex-col overflow-hidden">- <h2 className="font-medium">Table of Contents</h2>+ <h2 className="font-medium">Outline</h2><div className="h-full overflow-y-auto">{markings.length !== 0 ? (markings.map((marking) =>diff --git a/packages/editor/document-editor/src/ui/components/page-renderer.tsx b/packages/editor/document-editor/src/ui/components/page-renderer.tsxindex d82719c875..7c2717e807 100644--- a/packages/editor/document-editor/src/ui/components/page-renderer.tsx+++ b/packages/editor/document-editor/src/ui/components/page-renderer.tsx@@ -29,11 +29,13 @@ type IPageRenderer = {editorContentCustomClassNames?: string;hideDragHandle?: () => void;readonly: boolean;+ tabIndex?: number;};export const PageRenderer = (props: IPageRenderer) => {const {documentDetails,+ tabIndex,editor,editorClassNames,editorContentCustomClassNames,@@ -169,7 +171,11 @@ export const PageRenderer = (props: IPageRenderer) => {)}<div className="flex relative h-full w-full flex-col pr-5 editor-renderer" onMouseOver={handleLinkHover}><EditorContainer hideDragHandle={hideDragHandle} editor={editor} editorClassNames={editorClassNames}>- <EditorContentWrapper editor={editor} editorContentCustomClassNames={editorContentCustomClassNames} />+ <EditorContentWrapper+ tabIndex={tabIndex}+ editor={editor}+ editorContentCustomClassNames={editorContentCustomClassNames}+ /></EditorContainer></div>{isOpen && linkViewProps && coordinates && (diff --git a/packages/editor/document-editor/src/ui/index.tsx b/packages/editor/document-editor/src/ui/index.tsxindex e9f6d884b2..eb54a204bd 100644--- a/packages/editor/document-editor/src/ui/index.tsx+++ b/packages/editor/document-editor/src/ui/index.tsx@@ -47,6 +47,8 @@ interface IDocumentEditor {duplicationConfig?: IDuplicationConfig;pageLockConfig?: IPageLockConfig;pageArchiveConfig?: IPageArchiveConfig;++ tabIndex?: number;}interface DocumentEditorProps extends IDocumentEditor {forwardedRef?: React.Ref<EditorHandle>;@@ -79,6 +81,7 @@ const DocumentEditor = ({cancelUploadImage,onActionCompleteHandler,rerenderOnPropsChange,+ tabIndex,}: IDocumentEditor) => {const { markings, updateMarkings } = useEditorMarkings();const [sidePeekVisible, setSidePeekVisible] = useState(true);@@ -160,6 +163,7 @@ const DocumentEditor = ({</div><div className="h-full w-full md:w-[calc(100%-14rem)] lg:w-[calc(100%-18rem-18rem)] page-renderer"><PageRenderer+ tabIndex={tabIndex}onActionCompleteHandler={onActionCompleteHandler}hideDragHandle={hideDragHandleOnMouseLeave}readonly={false}diff --git a/packages/editor/document-editor/src/ui/readonly/index.tsx b/packages/editor/document-editor/src/ui/readonly/index.tsxindex 7c49ffa839..ba0c760bff 100644--- a/packages/editor/document-editor/src/ui/readonly/index.tsx+++ b/packages/editor/document-editor/src/ui/readonly/index.tsx@@ -28,6 +28,7 @@ interface IDocumentReadOnlyEditor {message: string;type: "success" | "error" | "warning" | "info";}) => void;+ tabIndex?: number;}interface DocumentReadOnlyEditorProps extends IDocumentReadOnlyEditor {@@ -51,6 +52,7 @@ const DocumentReadOnlyEditor = ({pageArchiveConfig,rerenderOnPropsChange,onActionCompleteHandler,+ tabIndex,}: DocumentReadOnlyEditorProps) => {const router = useRouter();const [sidePeekVisible, setSidePeekVisible] = useState(true);@@ -108,6 +110,7 @@ const DocumentReadOnlyEditor = ({</div><div className="h-full w-[calc(100%-14rem)] lg:w-[calc(100%-18rem-18rem)] page-renderer"><PageRenderer+ tabIndex={tabIndex}onActionCompleteHandler={onActionCompleteHandler}updatePageTitle={() => Promise.resolve()}readonly={true}diff --git a/packages/editor/lite-text-editor/src/ui/index.tsx b/packages/editor/lite-text-editor/src/ui/index.tsxindex 57774ab5dc..7986e0c6b3 100644--- a/packages/editor/lite-text-editor/src/ui/index.tsx+++ b/packages/editor/lite-text-editor/src/ui/index.tsx@@ -42,6 +42,7 @@ interface ILiteTextEditor {mentionHighlights?: string[];mentionSuggestions?: IMentionSuggestion[];submitButton?: React.ReactNode;+ tabIndex?: number;}interface LiteTextEditorProps extends ILiteTextEditor {@@ -74,6 +75,7 @@ const LiteTextEditor = (props: LiteTextEditorProps) => {mentionHighlights,mentionSuggestions,submitButton,+ tabIndex,} = props;const editor = useEditor({@@ -103,7 +105,11 @@ const LiteTextEditor = (props: LiteTextEditorProps) => {return (<EditorContainer editor={editor} editorClassNames={editorClassNames}><div className="flex flex-col">- <EditorContentWrapper editor={editor} editorContentCustomClassNames={editorContentCustomClassNames} />+ <EditorContentWrapper+ tabIndex={tabIndex}+ editor={editor}+ editorContentCustomClassNames={editorContentCustomClassNames}+ /><div className="mt-4 w-full"><FixedMenueditor={editor}diff --git a/packages/editor/lite-text-editor/src/ui/read-only/index.tsx b/packages/editor/lite-text-editor/src/ui/read-only/index.tsxindex 66ce790594..9f81ba5d13 100644--- a/packages/editor/lite-text-editor/src/ui/read-only/index.tsx+++ b/packages/editor/lite-text-editor/src/ui/read-only/index.tsx@@ -8,6 +8,7 @@ interface ICoreReadOnlyEditor {borderOnFocus?: boolean;customClassName?: string;mentionHighlights: string[];+ tabIndex?: number;}interface EditorCoreProps extends ICoreReadOnlyEditor {@@ -27,6 +28,7 @@ const LiteReadOnlyEditor = ({value,forwardedRef,mentionHighlights,+ tabIndex,}: EditorCoreProps) => {const editor = useReadOnlyEditor({value,@@ -45,7 +47,11 @@ const LiteReadOnlyEditor = ({return (<EditorContainer editor={editor} editorClassNames={editorClassNames}><div className="flex flex-col">- <EditorContentWrapper editor={editor} editorContentCustomClassNames={editorContentCustomClassNames} />+ <EditorContentWrapper+ tabIndex={tabIndex}+ editor={editor}+ editorContentCustomClassNames={editorContentCustomClassNames}+ /></div></EditorContainer>);diff --git a/packages/editor/rich-text-editor/src/ui/index.tsx b/packages/editor/rich-text-editor/src/ui/index.tsxindex eeac3d2ef8..366fa471f0 100644--- a/packages/editor/rich-text-editor/src/ui/index.tsx+++ b/packages/editor/rich-text-editor/src/ui/index.tsx@@ -36,6 +36,7 @@ export type IRichTextEditor = {debouncedUpdatesEnabled?: boolean;mentionHighlights?: string[];mentionSuggestions?: IMentionSuggestion[];+ tabIndex?: number;};export interface RichTextEditorProps extends IRichTextEditor {@@ -68,6 +69,7 @@ const RichTextEditor = ({mentionHighlights,rerenderOnPropsChange,mentionSuggestions,+ tabIndex,}: RichTextEditorProps) => {const [hideDragHandleOnMouseLeave, setHideDragHandleOnMouseLeave] = React.useState<() => void>(() => {});@@ -110,7 +112,11 @@ const RichTextEditor = ({<EditorContainer hideDragHandle={hideDragHandleOnMouseLeave} editor={editor} editorClassNames={editorClassNames}>{editor && <EditorBubbleMenu editor={editor} />}<div className="flex flex-col">- <EditorContentWrapper editor={editor} editorContentCustomClassNames={editorContentCustomClassNames} />+ <EditorContentWrapper+ tabIndex={tabIndex}+ editor={editor}+ editorContentCustomClassNames={editorContentCustomClassNames}+ /></div></EditorContainer>);diff --git a/packages/editor/rich-text-editor/src/ui/read-only/index.tsx b/packages/editor/rich-text-editor/src/ui/read-only/index.tsxindex 9b0f43f579..9aa3087315 100644--- a/packages/editor/rich-text-editor/src/ui/read-only/index.tsx+++ b/packages/editor/rich-text-editor/src/ui/read-only/index.tsx@@ -9,6 +9,7 @@ interface IRichTextReadOnlyEditor {borderOnFocus?: boolean;customClassName?: string;mentionHighlights?: string[];+ tabIndex?: number;}interface RichTextReadOnlyEditorProps extends IRichTextReadOnlyEditor {diff --git a/web/components/issues/issue-modal/form.tsx b/web/components/issues/issue-modal/form.tsxindex dc1f421986..5f2ef07752 100644--- a/web/components/issues/issue-modal/form.tsx+++ b/web/components/issues/issue-modal/form.tsx@@ -467,7 +467,7 @@ export const IssueFormRoot: FC<IssueFormProps> = observer((props) => {}}mentionHighlights={mentionHighlights}mentionSuggestions={mentionSuggestions}- // tabIndex={2}+ tabIndex={getTabIndex("description_html")}/>)}/>