mirror of
https://github.com/overleaf/overleaf.git
synced 2024-09-16 02:52:31 -04:00
e025088065
Add documentation for CodeMirror extensions GitOrigin-RevId: e5f07084173f201919272f9d46dcdaef4b817874
50 lines
1.6 KiB
TypeScript
50 lines
1.6 KiB
TypeScript
import { keymap } from '@codemirror/view'
|
|
import { defaultKeymap, historyKeymap } from '@codemirror/commands'
|
|
import { lintKeymap } from '@codemirror/lint'
|
|
import { scrollOneLineKeymap } from './scroll-one-line'
|
|
import { foldingKeymap } from './folding-keymap'
|
|
|
|
const ignoredDefaultKeybindings = new Set([
|
|
// NOTE: disable "Mod-Enter" as it's used for "Compile"
|
|
'Mod-Enter',
|
|
// Disable Alt+Arrow as we have special behaviour on Windows / Linux
|
|
'Alt-ArrowLeft',
|
|
'Alt-ArrowRight',
|
|
// This keybinding causes issues on some keyboard layouts where \ is entered
|
|
// using AltGr. Windows treats Ctrl-Alt as AltGr, so trying to insert a \
|
|
// with Ctrl-Alt would trigger this keybinding, rather than inserting a \
|
|
'Mod-Alt-\\',
|
|
])
|
|
|
|
const ignoredDefaultMacKeybindings = new Set([
|
|
// We replace these with our custom visual-line versions
|
|
'Mod-Backspace',
|
|
'Mod-Delete',
|
|
])
|
|
|
|
const filteredDefaultKeymap = defaultKeymap.filter(
|
|
// We only filter on keys, so if the keybinding doesn't have a key,
|
|
// allow it
|
|
item => {
|
|
if (item.key && ignoredDefaultKeybindings.has(item.key)) {
|
|
return false
|
|
}
|
|
if (item.mac && ignoredDefaultMacKeybindings.has(item.mac)) {
|
|
return false
|
|
}
|
|
return true
|
|
}
|
|
)
|
|
|
|
export const keymaps = keymap.of([
|
|
// The default CodeMirror keymap, with a few key bindings filtered out.
|
|
...filteredDefaultKeymap,
|
|
// Key bindings for undo/redo/undoSelection/redoSelection
|
|
...historyKeymap,
|
|
// Key bindings for “open lint panel” and “next diagnostic”
|
|
...lintKeymap,
|
|
// Key bindings for folding actions
|
|
...foldingKeymap,
|
|
// Key bindings for scrolling the viewport
|
|
...scrollOneLineKeymap,
|
|
])
|