Skip to content

ElectronKeyboardInputEvent

Unofficial

Keyboard input event passed to ElectronWebContents.sendInputEvent to inject a trusted key press.

Import:

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

Signature:

export interface ElectronKeyboardInputEvent extends ElectronInputEvent

Extends: ElectronInputEvent

Properties

Property Type Description
keyCode string The character sent as the keyboard event; use a valid Electron Accelerator key code.
modifiers? Array<
| 'alt'
| 'capsLock'
| 'cmd'
| 'command'
| 'control'
| 'ctrl'
| 'isAutoRepeat'
| 'isKeypad'
| 'left'
| 'leftButtonDown'
| 'meta'
| 'middleButtonDown'
| 'numLock'
| 'right'
| 'rightButtonDown'
| 'shift'
>
The modifier keys held during the event.
(Inherited from ElectronInputEvent)
type 'char' | 'keyDown' | 'keyUp' The type of the keyboard event.