Keyboard shortcut `Mod-a` prevents selecting the whole document

[eduludi]

When enabling this extension in TipTap editor, the document can't be fully selected with the default Mod-a keyboard shortcut, at least on macOS where cmd+a selects the whole document.

cmd+a only works within a footnote, wher only the text of the footnote is selected.

It looks like these lines set this behavior:

tiptap-footnotes/package/src/footnotes/footnotes.ts

Lines 30 to 56 in 4feeced

	addKeyboardShortcuts() {
	return {
	// override the default behavior of Mod-a:
	// rather than selecting the whole text content of the editor, only select the text inside the current footnote
	"Mod-a": ({ editor }) => {
	try {
	const { selection } = editor.state;
	const { $from } = selection;
	// footnote listItems are at depth 2, we are getting the start & end position of the parent list item from the current cursor position
	const start = $from.start(2);
	const startNode = editor.$pos(start);
	if (startNode.node.type.name != "footnote") return false;
	const end = $from.end(2);
	editor.commands.setTextSelection({
	from: start + 1,
	to: end - 1,
	});
	return true;
	} catch (e) {
	return false;
	}
	},
	};
	},

P.S.: Thanks for this library!

[linear]

OSS-10 Keyboard shortcut `Mod-a` prevents selecting the whole document

[jmduke]

@eduludi just to confirm, you mean this is also hijacking the non-in-a-footnote case (e.g. you have a footnote but you're in the main editor?)

[eduludi]

@jmduke Yes, that's exactly the case.

[jmduke]

Cool! Will fix.

[eduludi]

I did attempt to fix this by extending your library but the problem persists:

const MyFootnotes = Footnotes.extend({
  addKeyboardShortcuts() {
    return {
      'Mod-a': ({ editor }) => {
        console.log('triggers!')
        editor.commands.selectAll()
      }
    }
  },
})

If I add a console.log in the Mod-a function, i can see it being triggered

Even I tried cloning your repo, removing the addKeyboardShortcuts() completely from footnotes.js, but the issue is still there.

Any ideas? Thanks!

[eduludi]

Something else I noticed is that Mod-a works if I comment out the Document.extend({content: 'block+ footnotes?' }) part in the TipTap editor's settings.

const editor = useEditor({
  extensions: [
    Footnote,
    Footnotes,
    Reference,
    Document.extend({
      // content: 'block+ footnotes?', // <-- Commented out
    }),
]

Of course, this breaks tiptap-footnotes, where the Footnotes are no longer visible.

[eduludi]

I found a temporary solution, by extending tiptap-footnotes keyboard shortcut for Mod-a like this:

import {
  Footnote,
  FootnoteReference,
  Footnotes as OriginalFootnotes,
} from 'tiptap-footnotes'

const Footnotes = OriginalFootnotes.extend({
  // Override the default document content to include footnotes
  addKeyboardShortcuts() {
    return {
      'Mod-a': ({ editor }) => {
        try {
          // Select from the start to the end of the document
          editor.commands.setTextSelection({
            from: 0,
            to: editor.state.doc.content.size + 2, // +2 to include footnotes node if present
          })
          return true
        } catch {
          return false
        }
      },
    }
  },
})

export { Footnotes, Footnote, FootnoteReference }

[ZwaarContrast]

Fixed this issue in this PR: #22