mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

docs: fix type information for contents.sendInputEvent (#19479)

Browse source 
The `event` type and keyword is reserved by the typescript generator, in the future we should throw an error from the generator if someone uses a reserved interface like that.

This also splits and documents the InputEvent type way better so that TS
users get strong type safety.

Fixes electron/typescript-definitions#36
This commit is contained in:
Samuel Attard 2019-07-26 16:11:50 -07:00 • committed by GitHub
parent 48f2807473
commit 12bbbef688
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 42 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/api/structures/mouse-input-event.md Normal file
View file

@ -0,0 +1,12 @@
# MouseInputEvent Object extends `InputEvent`
* `type` String - The type of the event, can be `mouseDown`,
`mouseUp`, `mouseEnter`, `mouseLeave`, `contextMenu`, `mouseWheel` or `mouseMove`.
* `x` Integer
* `y` Integer
* `button` String (optional) - The button pressed, can be `left`, `middle`, `right`.
* `globalX` Integer (optional)
* `globalY` Integer (optional)
* `movementX` Integer (optional)
* `movementY` Integer (optional)
* `clickCount` Integer (optional)