Skip to content

VimApi.handleKey method

VimApi › handleKey

Unofficial

Handle a key press in the given editor with the specified origin.

Signature:

handleKey(cm: VimEditor, key: string, origin?: string | undefined): boolean

Parameters:

Parameter Type Description
cm VimEditor The editor instance.
key string The key that was pressed.
origin? string | undefined The origin of the key press.

Returns: booleanWhether the key was handled.