π₯π₯π₯ 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
fix: tab key behaviour fixed for tabIndex containing editors with lists' and code blocks' tab key (#4216)
M. Palanikannan1080094b0111
diff --git a/packages/editor/core/src/hooks/use-editor.tsx b/packages/editor/core/src/hooks/use-editor.tsxindex ae7d903420..647b79929c 100644--- a/packages/editor/core/src/hooks/use-editor.tsx+++ b/packages/editor/core/src/hooks/use-editor.tsx@@ -35,6 +35,7 @@ interface CustomEditorProps {};handleEditorReady?: (value: boolean) => void;placeholder?: string | ((isFocused: boolean) => string);+ tabIndex?: number;}export const useEditor = ({@@ -49,6 +50,7 @@ export const useEditor = ({extensions = [],onChange,forwardedRef,+ tabIndex,restoreFile,handleEditorReady,mentionHandler,@@ -72,6 +74,7 @@ export const useEditor = ({uploadFile,},placeholder,+ tabIndex,}),...extensions,],diff --git a/packages/editor/core/src/ui/extensions/custom-list-keymap/list-keymap.ts b/packages/editor/core/src/ui/extensions/custom-list-keymap/list-keymap.tsindex 928eaff402..db1264f572 100644--- a/packages/editor/core/src/ui/extensions/custom-list-keymap/list-keymap.ts+++ b/packages/editor/core/src/ui/extensions/custom-list-keymap/list-keymap.ts@@ -9,44 +9,71 @@ export type ListKeymapOptions = {}>;};-export const ListKeymap = Extension.create<ListKeymapOptions>({- name: "listKeymap",-- addOptions() {- return {- listTypes: [- {- itemName: "listItem",- wrapperNames: ["bulletList", "orderedList"],- },- {- itemName: "taskItem",- wrapperNames: ["taskList"],- },- ],- };- },-- addKeyboardShortcuts() {- return {- Tab: () => {- if (this.editor.commands.sinkListItem("listItem")) {- return true;- } else if (this.editor.commands.sinkListItem("taskItem")) {- return true;- }- return true;- },- "Shift-Tab": () => {- if (this.editor.commands.liftListItem("listItem")) {+export const ListKeymap = ({ tabIndex }: { tabIndex?: number }) =>+ Extension.create<ListKeymapOptions>({+ name: "listKeymap",++ addOptions() {+ return {+ listTypes: [+ {+ itemName: "listItem",+ wrapperNames: ["bulletList", "orderedList"],+ },+ {+ itemName: "taskItem",+ wrapperNames: ["taskList"],+ },+ ],+ };+ },++ addKeyboardShortcuts() {+ return {+ Tab: () => {+ if (this.editor.isActive("listItem") || this.editor.isActive("taskItem")) {+ if (this.editor.commands.sinkListItem("listItem")) {+ return true;+ } else if (this.editor.commands.sinkListItem("taskItem")) {+ return true;+ }+ return true;+ }+ // if tabIndex is set, we don't want to handle Tab key+ if (tabIndex !== undefined && tabIndex !== null) {+ return false;+ }return true;- } else if (this.editor.commands.liftListItem("taskItem")) {+ },+ "Shift-Tab": () => {+ if (this.editor.commands.liftListItem("listItem")) {+ return true;+ } else if (this.editor.commands.liftListItem("taskItem")) {+ return true;+ }return true;- }- return true;- },- Delete: ({ editor }) => {- try {+ },+ Delete: ({ editor }) => {+ try {+ let handled = false;++ this.options.listTypes.forEach(({ itemName }) => {+ if (editor.state.schema.nodes[itemName] === undefined) {+ return;+ }++ if (handleDelete(editor, itemName)) {+ handled = true;+ }+ });++ return handled;+ } catch (e) {+ console.log("error in handling Backspac:", e);+ return false;+ }+ },+ "Mod-Delete": ({ editor }) => {let handled = false;this.options.listTypes.forEach(({ itemName }) => {@@ -60,28 +87,28 @@ export const ListKeymap = Extension.create<ListKeymapOptions>({});return handled;- } catch (e) {- console.log("error in handling delete:", e);- return false;- }- },- "Mod-Delete": ({ editor }) => {- let handled = false;-- this.options.listTypes.forEach(({ itemName }) => {- if (editor.state.schema.nodes[itemName] === undefined) {- return;- }-- if (handleDelete(editor, itemName)) {- handled = true;+ },+ Backspace: ({ editor }) => {+ try {+ let handled = false;++ this.options.listTypes.forEach(({ itemName, wrapperNames }) => {+ if (editor.state.schema.nodes[itemName] === undefined) {+ return;+ }++ if (handleBackspace(editor, itemName, wrapperNames)) {+ handled = true;+ }+ });++ return handled;+ } catch (e) {+ console.log("error in handling Backspac:", e);+ return false;}- });-- return handled;- },- Backspace: ({ editor }) => {- try {+ },+ "Mod-Backspace": ({ editor }) => {let handled = false;this.options.listTypes.forEach(({ itemName, wrapperNames }) => {@@ -95,26 +122,7 @@ export const ListKeymap = Extension.create<ListKeymapOptions>({});return handled;- } catch (e) {- console.log("error in handling Backspace:", e);- return false;- }- },- "Mod-Backspace": ({ editor }) => {- let handled = false;-- this.options.listTypes.forEach(({ itemName, wrapperNames }) => {- if (editor.state.schema.nodes[itemName] === undefined) {- return;- }-- if (handleBackspace(editor, itemName, wrapperNames)) {- handled = true;- }- });-- return handled;- },- };- },-});+ },+ };+ },+ });diff --git a/packages/editor/core/src/ui/extensions/index.tsx b/packages/editor/core/src/ui/extensions/index.tsxindex 4b8de461ba..f4dbaee3be 100644--- a/packages/editor/core/src/ui/extensions/index.tsx+++ b/packages/editor/core/src/ui/extensions/index.tsx@@ -44,12 +44,14 @@ type TArguments = {uploadFile: UploadImage;};placeholder?: string | ((isFocused: boolean) => string);+ tabIndex?: number;};export const CoreEditorExtensions = ({mentionConfig,fileConfig: { deleteFile, restoreFile, cancelUploadImage, uploadFile },placeholder,+ tabIndex,}: TArguments) => [StarterKit.configure({bulletList: {@@ -84,7 +86,7 @@ export const CoreEditorExtensions = ({},}),CustomKeymap,- ListKeymap,+ ListKeymap({ tabIndex }),CustomLinkExtension.configure({openOnClick: true,autolink: true,diff --git a/packages/editor/document-editor/src/ui/index.tsx b/packages/editor/document-editor/src/ui/index.tsxindex 7181274843..3c36ed11c5 100644--- a/packages/editor/document-editor/src/ui/index.tsx+++ b/packages/editor/document-editor/src/ui/index.tsx@@ -76,6 +76,7 @@ const DocumentEditor = (props: IDocumentEditor) => {setHideDragHandle: setHideDragHandleFunction,}),placeholder,+ tabIndex,});const editorContainerClassNames = getEditorClassNames({diff --git a/packages/editor/lite-text-editor/src/ui/index.tsx b/packages/editor/lite-text-editor/src/ui/index.tsxindex 859bd4c9e0..71846eca7d 100644--- a/packages/editor/lite-text-editor/src/ui/index.tsx+++ b/packages/editor/lite-text-editor/src/ui/index.tsx@@ -63,6 +63,7 @@ const LiteTextEditor = (props: ILiteTextEditor) => {extensions: LiteTextEditorExtensions(onEnterKeyPress),mentionHandler,placeholder,+ tabIndex,});const editorContainerClassName = getEditorClassNames({diff --git a/packages/editor/rich-text-editor/src/ui/index.tsx b/packages/editor/rich-text-editor/src/ui/index.tsxindex 9490d478ec..e82615b950 100644--- a/packages/editor/rich-text-editor/src/ui/index.tsx+++ b/packages/editor/rich-text-editor/src/ui/index.tsx@@ -81,6 +81,7 @@ const RichTextEditor = (props: IRichTextEditor) => {dragDropEnabled,setHideDragHandle: setHideDragHandleFunction,}),+ tabIndex,mentionHandler,placeholder,});