[Solved] Overriding control keys

tgrosinger · October 29, 2020, 5:10pm

I am working on the Table Editor plugin and attempting to make it so when the cursor is in a table, the Enter and Tab keys have altered behavior. I have successfully done this! However I am unable to get the default Enter behavior when the cursor is not in a table.

Here’s the code I’ve put together to accomplish the key binding.

github.com

tgrosinger/table-editor-obsidian/blob/override-enter/src/main.ts#L19-L32


const km = CodeMirror.normalizeKeyMap({
  Enter: (cm2: CodeMirror.Editor) => {
    const ote = new ObsidianTextEditor(cm2);
    const te = new TableEditor(ote);
    if (te.cursorIsInTable(defaultOptions)) {
      console.log('Override enter, not passing');
      te.nextRow(defaultOptions);
    } else {
      console.log('Fallthrough, returning pass');
      return CodeMirror.Pass;
    }
  },
});
cm.addKeyMap(km, false);

The problem is that CodeMirror.Pass does not seem to be functioning correctly as described in the documentation. Here’s the relevant documentation: https://codemirror.net/doc/manual.html#keymaps

Let me know if you have any ideas! Thanks

tgrosinger · October 30, 2020, 3:32pm

I was able to use this by listening for “keydown”. Note that “keyhandled” does not work because that means CodeMirror already did something with it, you’re just being informed after the fact.

This does mean that I can’t nicely hook into shortcuts like “shift-tab” and need to manually remember if the shift key is pressed. But that’s not so bad.