VimApi.vimKeyFromEvent method

VimApi › vimKeyFromEvent

Unofficial

Translate a keyboard event into the Vim-style key name the mappings are written in.

Signature:

vimKeyFromEvent(e: KeyboardEvent, vim?: VimStateVim | undefined): string | undefined

Parameters:

Parameter	Type	Description
e	KeyboardEvent	The keyboard event.
vim?	VimStateVim | undefined	The editor's Vim state, consulted for whether the next key is taken literally.

Returns: string | undefined — The key name, or undefined for a key Vim ignores.