[Feature] customize keymaps #443
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Implements [[artisticat1#400](https://github.com/superle3/obsidian-latex-suite/issues/400)](https://github.com/artisticat1/obsidian-latex-suite/issue/400). This adds an easy framework to add keymaps. Looking at the implementation of [keymap.ts](https://github.com/codemirror/view/blob/main/src/keymap.ts), it was clear rolling our own keymap would be more trouble than its worth, as a lot of "magic" things were happening there. Using the default keymap also doesn't work as that has the default priority and we need the highest priority. As such we use their api `runScopeHandeler` instead and attach our own custom scope (the name of this plugin). This way we only have to standardize the formatting of the `key` instead of dealing with the complicated `KeyBoardEvent`. This currently only adds customization for the snippet Trigger key and the tabout trigger key, as I haven't seen any feature requests for the other keys and that would needlessly add configuration.
superle3
force-pushed
the
feat/keymaps
branch
from
e7ff14e to
0ded4da
Compare
superle3
commented
Sep 6, 2025
| })); | ||
| new Setting(containerEl) | ||
| .setName("Key trigger for tabout") | ||
| .setDesc("What key to press to trigger tabout. Key names may be strings like \"Shift-Ctrl-Enter\" a key prefixed with zero or more modifiers. Modifiers can be given in any order. Shift- (or s-), Alt- (or a-), Ctrl- (or c- or Control-), Cmd- (or m- or Meta-) or Mod- (Cmd- on Mac, Ctrl- on Windows/Linux) are recognized. Chords are seperated by a space.") |
Collaborator
Author
There was a problem hiding this comment.
also not satisfied with this explanation
superle3
commented
Sep 6, 2025
| .addDropdown((dropdown) => dropdown | ||
| .addOption("Tab", "Tab") | ||
| .addOption(" ", "Space") | ||
| .setDesc("What key to press to expand non-auto snippets. Key names may be strings like \"Shift-Ctrl-Enter\" a key prefixed with zero or more modifiers. Modifiers can be given in any order. Shift- (or s-), Alt- (or a-), Ctrl- (or c- or Control-), Cmd- (or m- or Meta-) or Mod- (Cmd- on Mac, Ctrl- on Windows/Linux) are recognized. Chords are seperated by a space.") |
Collaborator
Author
There was a problem hiding this comment.
Not satisfied with this explanation. Am inclined to just point them to the official docs of https://codemirror.net/docs/ref/#view.KeyBinding, but that might be a bit much. Maybe like no explanation here or a small example and mention it in the DOCS.md? since we have to explain the triggerKey there arleady.
superle3
commented
Sep 6, 2025
| flags: optional(string_()), | ||
| priority: optional(number()), | ||
| description: optional(string_()), | ||
| triggerKey: optional(string_()), |
Collaborator
Author
There was a problem hiding this comment.
following the same style here, but defaultvalue and validator could also be used.
This was
linked to
issues
Oct 12, 2025
This was referenced Nov 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #439.
Resolves #400.
Resolves #409.
Rely on @codemirror/view for handling keymaps instead rolling our own. This allows for more customization later on.
I looked at the implementation of https://github.com/codemirror/view/blob/main/src/keymap.ts to see if it was worth it to roll our own keymap handling, but it was a bit too complex to include it, thus this relies on their implementation and adds the scope
latex-suitesuch this extension only triggers it.