VimMotionArgs

Unofficial

Arguments describing how a Vim motion should move the cursor.

Every field is optional because a key mapping only supplies the ones its motion cares about. The resolved form handed to a motion handler always carries a repeat, modelled by VimResolvedMotionArgs.

Import:

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

Signature:

export interface VimMotionArgs

Properties

Property	Type	Description
bigWord?	boolean	Whether the motion operates on WORDs (whitespace-delimited) rather than words.
explicitRepeat?	boolean	Whether the motion consumes a repeat count typed before it.
forward?	boolean	Whether the motion moves towards the end of the document.
inclusive?	boolean	Whether the character under the resulting cursor position is part of the motion's range.
linewise?	boolean	Whether the motion covers whole lines rather than a character range.
noRepeat?	boolean	Whether the motion refuses to be repeated by a count.
repeat?	number	How many times the motion is applied.
repeatIsExplicit?	boolean	Whether the repeat count was typed by the user rather than defaulted.
repeatOffset?	number	Offset applied to the repeat count before the motion runs.
sameLine?	boolean	Whether the motion is confined to the line it started on.
selectedCharacter?	string	The character the motion searches for, for character-search motions such as `f` and `t`.
textObjectInner?	boolean	Whether a text-object motion selects the inner range, excluding its delimiters.
toFirstChar?	boolean	Whether the motion lands on the first non-whitespace character of the target line.
toJumplist?	boolean	Whether the position the motion started from is pushed onto the jump list.
wordEnd?	boolean	Whether a word motion lands on the end of the word rather than its start.

Links to this page: