Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: document the Event interface #16966

Merged
merged 3 commits into from Feb 15, 2019
Merged

docs: document the Event interface #16966

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
241098c
docs: document the Event interface
codebytere Feb 14, 2019
9080987
update docs deps
codebytere Feb 14, 2019
468c01b
pull new VoidFunction update
codebytere Feb 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/api/structures/event.md
View file
Open in desktop
@@ -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 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Expand Up @@ -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",
Expand Down