Skip to content

VimKeyMappingBase

Unofficial

The fields every Vim key mapping carries, whatever kind of command it binds to.

Import:

import type { VimKeyMappingBase } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface VimKeyMappingBase

Properties

PropertyTypeDescription
context?VimKeyMappingContextThe mode this mapping applies in. Omitted means it applies in every mode.
exitVisualBlock?booleanWhether running the command leaves visual block mode.
expectLiteralNext?booleanWhether the next key typed is taken literally rather than matched against further mappings.
interlaceInsertRepeat?booleanWhether repeating the command in insert mode interleaves it with the recorded keystrokes.
isEdit?booleanWhether the command counts as an edit, making it repeatable with ..
keysstringThe key sequence that triggers this mapping.
noremap?booleanWhether the mapping refuses to be remapped further.
repeatOverride?numberA repeat count that overrides whatever the user typed.

Links to this page: