VimActionKeyMapping
Unofficial
A key mapping that runs an action — a self-contained command that needs no motion to complete it.
Import:
import type { VimActionKeyMapping } from '@obsidian-typings/obsidian-public-latest';Signature:
export interface VimActionKeyMapping extends VimKeyMappingBaseExtends: VimKeyMappingBase
Properties
| Property | Type | Description | |
|---|---|---|---|
| action | string | The name the action was registered under. | |
| actionArgs? | VimActionArgs | The arguments passed to the action. | |
| context? | VimKeyMappingContext | The mode this mapping applies in. Omitted means it applies in every mode. (Inherited from VimKeyMappingBase) | |
| exitVisualBlock? | boolean | Whether running the command leaves visual block mode. (Inherited from VimKeyMappingBase) | |
| expectLiteralNext? | boolean | Whether the next key typed is taken literally rather than matched against further mappings. (Inherited from VimKeyMappingBase) | |
| interlaceInsertRepeat? | boolean | Whether repeating the command in insert mode interleaves it with the recorded keystrokes. (Inherited from VimKeyMappingBase) | |
| isEdit? | boolean | Whether the command counts as an edit, making it repeatable with ..(Inherited from VimKeyMappingBase) | |
| keys | string | The key sequence that triggers this mapping. (Inherited from VimKeyMappingBase) | |
| motion? | string | The motion the action runs, for actions that move the cursor as part of their work. | |
| noremap? | boolean | Whether the mapping refuses to be remapped further. (Inherited from VimKeyMappingBase) | |
| operator? | string | The operator the action runs, for actions that transform text as part of their work. | |
| repeatOverride? | number | A repeat count that overrides whatever the user typed. (Inherited from VimKeyMappingBase) | |
| type | 'action' | Discriminates this mapping as an action. |
Links to this page: