VimState

Unofficial

Both Official Unofficial

Both Own Inherited

The state bag hanging off a CM5 editor adapter, which is where the Vim layer keeps everything it associates with that editor.

Import:

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

Signature:

export interface VimState

Properties

	Property	Type	Description
	overwrite?	boolean	Whether typing replaces the character under the cursor rather than inserting before it.
	vim	VimStateVim	Vim's mode and command state for this editor.
	vimPlugin	VimStateVimPlugin	Vim plugin state for tracking key events.

Methods

	Method	Returns	Description
	closeVimNotification()	void	Dismiss the notification the Vim layer is currently showing. Only present while one is showing.

---

Links to this page:

• CodeMirrorEditor