Ability to get a list of all the shortcut loaded in the editor

[breakingrobot]

Hello,

We would like to show a complete list of the usable keymaps / shortcuts from the editor and the extensions loaded.

I have tried to get it using the editor instance through the extensionManager, mapped over each extensions to get either :

• config.addKeyboardShortcuts
• parent.config.addKeyboardShortcuts

Obviously, this is not very reliable as they are internal methods of Extension|Mark|Node and use this with the Extension|Mark|Node context.

I could also take all the plugins individually and get their addKeyboardShortcuts but this is a bit overkill.

Is there any simple way to get all the keymaps from the Editor ?

[philippkuehn]

Do you just want the registered keys or also its methods?

[breakingrobot]

We just need the registered keys, I'll be able to do something from there.

If there is a way, we can get both, it would be great to identify what's it is binded to :)

[philippkuehn]

Unfortunately there is no easy way for doing this. You can look at how tiptap gets the value of addKeyboardShortcuts here:

tiptap/packages/core/src/ExtensionManager.ts

Lines 248 to 266 in 7a04a32

	const addKeyboardShortcuts = getExtensionField<AnyConfig['addKeyboardShortcuts']>(
	extension,
	'addKeyboardShortcuts',
	context,
	)
	if (addKeyboardShortcuts) {
	const bindings = Object.fromEntries(
	Object
	.entries(addKeyboardShortcuts())
	.map(([shortcut, method]) => {
	return [shortcut, () => method({ editor })]
	}),
	)
	const keyMapPlugin = keymap(bindings)
	plugins.push(keyMapPlugin)
	}

A list of resolved extension can be found here: editor.extensionManager.extensions