VimResolvedActionArgs

Unofficial

Both Official Unofficial

Both Own Inherited

VimActionArgs as an action handler receives them, once the command dispatcher has resolved the repeat count.

Import:

import type { VimResolvedActionArgs } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface VimResolvedActionArgs extends VimActionArgs

Extends: VimActionArgs

Properties

	Property	Type	Description
	after?	boolean	Whether the action takes effect after the cursor rather than before it. (Inherited from VimActionArgs)
	backtrack?	boolean	Whether the cursor steps back onto the last inserted character once the action completes. (Inherited from VimActionArgs)
	blockwise?	boolean	Whether the action treats the register contents as a visual block. (Inherited from VimActionArgs)
	direction?	VimResizeDirection	Which way a resize action changes the size of its target. (Inherited from VimActionArgs)
	forward?	boolean	Whether the action moves towards the end of the document. (Inherited from VimActionArgs)
	head?	EditorPosition	The position the action starts from, when it does not start from the cursor. (Inherited from VimActionArgs)
	increase?	boolean	Whether a numeric action increments. false decrements. (Inherited from VimActionArgs)
	indentRight?	boolean	Whether an indent action adds indentation. false removes it. (Inherited from VimActionArgs)
	insertAt?	VimInsertAt	Where the cursor is placed when the action enters insert mode. (Inherited from VimActionArgs)
	isEdit?	boolean	Whether the action counts as an edit, making it repeatable with .. (Inherited from VimActionArgs)
	keepSpaces?	boolean	Whether a join action preserves the whitespace between the joined lines. (Inherited from VimActionArgs)
	linewise?	boolean	Whether the action operates on whole lines rather than a character range. (Inherited from VimActionArgs)
	matchIndent?	boolean	Whether pasted text is re-indented to match the surrounding lines. (Inherited from VimActionArgs)
	position?	VimScrollPosition	Where the cursor line is placed in the viewport, for scroll-positioning actions. (Inherited from VimActionArgs)
	registerName?	string	The register the action reads from or writes to. Defaults to the unnamed register. (Inherited from VimActionArgs)
	repeat	number	How many times the action is applied. Always resolved to a concrete count before the handler runs.
	repeat?	number	How many times the action is applied. (Inherited from VimActionArgs)
	repeatIsExplicit?	boolean	Whether the repeat count was typed by the user rather than defaulted. (Inherited from VimActionArgs)
	replace?	boolean	Whether the action replaces the existing text rather than inserting alongside it. (Inherited from VimActionArgs)
	selectedCharacter?	string	The character the action was given, for actions such as r that take one. (Inherited from VimActionArgs)

---

Links to this page:

• VimActionArgs