Add docs about using EventListener objects #2260
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dead-claudia
requested changes
Oct 27, 2018
docs/hyperscript.md
Outdated
| @@ -278,6 +278,29 @@ function doSomething(e) { | |||
| m("div", {onclick: doSomething}) | |||
| ``` | |||
|
|
|||
| Mithril adds event listeners to the DOM using [EventTarget#addEventListener](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener). This means you can provide a function (as above) or an [EventListener](https://developer.mozilla.org/en-US/docs/Web/API/EventListener) object. For example: | |||
There was a problem hiding this comment.
That's not how it works internally, and I'd rather not give people a false impression on that. You could still mention that both functions and event listener objects work, just don't include the implementation detail that gives people the wrong impression, especially of performance implications. (Changing existing listeners is a simple object property write, not a removeEventListener + addEventListener pair.)
dead-claudia
approved these changes
Oct 27, 2018
|
I made some minor grammar/typo fixes to the patch. Apart from that, looks good to me. 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Added notes about using EventListener objects, as well as preventing auto-redraw.
Motivation and Context
Document new features in v2, add needed docs for redraw prevention.
Types of changes
Checklist:
docs/change-log.md