github/electron
1
1
Fork 0
mirror of https://github.com/electron/electron.git synced 2026-01-11 00:18:02 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: document the Event interface (#16966)

Browse Source 
* docs: document the Event interface

* update docs deps

* pull new VoidFunction update
This commit is contained in:
Shelley Vohr
2019-02-15 12:08:45 -08:00
committed by GitHub
parent 31ff160431
commit 1e8ac79e6f
2 changed files with 11 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/api/structures/event.md Normal file
View File

@@ -0,0 +1,9 @@
# Event Object extends `GlobalEvent`
* `preventDefault` VoidFunction
* `sender` WebContents
* `returnValue` any
* `ctrlKey` Boolean (optional) - whether the Control key was used in an accelerator to trigger the Event
* `metaKey` Boolean (optional) - whether a meta key was used in an accelerator to trigger the Event
* `shiftKey` Boolean (optional) - whether a Shift key was used in an accelerator to trigger the Event
* `altKey` Boolean (optional) - whether an Alt key was used in an accelerator to trigger the Event

4
package.json
View File

@@ -14,8 +14,8 @@
"colors": "^1.1.2",
"dotenv-safe": "^4.0.4",
"dugite": "^1.45.0",
"electron-docs-linter": "^2.4.0",
"electron-typescript-definitions": "^7.0.0",
"electron-docs-linter": "^2.5.0",
"electron-typescript-definitions": "^8.1.0",
"eslint": "^5.13.0",
"eslint-config-standard": "^12.0.0",
"eslint-plugin-mocha": "^5.2.0",