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

Added event types and their descriptions #402

Merged
merged 2 commits into from
Apr 14, 2021

Conversation

advename
Copy link
Contributor

I was looking for a complete list of form types and couldn't find any anywhere.
I went through the source code and extracted these with adding some description to them, either using MDN's description or some other website explanation.

I was looking for a complete list of form types and couldn't find any anywhere.
I went through the source code and extracted these with adding some description to them, either using MDN's description or some other website explanation.
Copy link
Member

@eps1lon eps1lon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rather link https://developer.mozilla.org/en-US/docs/Web/API/Event#introduction. This cheatsheet is more about TypeScript and now you're trying to explain DOM API.

Is there anything missing from https://developer.mozilla.org/en-US/docs/Web/API/Event#introduction that we may want to upstream instead?

@advename
Copy link
Contributor Author

Well, I used these descriptions so that developers are not confused with which event handler belongs to which event type and just wrote a general description of what they are. Moreover, by these descriptions I wrote, users easily can see the differences between UIEvent, MouseEvent,... and how they are connected.

And attention, https://developer.mozilla.org/en-US/docs/Web/API/Event#introduction not all events from your link are implemented in TS

@eps1lon
Copy link
Member

eps1lon commented Apr 13, 2021

And attention, developer.mozilla.org/en-US/docs/Web/API/Event#introduction not all events from your link are implemented in TS

That's my point. Now we have to maintain that list and we don't have anything to add regarding the description. I don't think we can maintain a separate MDN just for TypeScript.

Copy link
Collaborator

@swyxio swyxio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think this is OK as this is a pretty handy, yet short, list :)

@swyxio swyxio merged commit e606e03 into typescript-cheatsheets:main Apr 14, 2021
stepanenko added a commit to stepanenko/react-ts-best-practices that referenced this pull request May 3, 2021
* Updated README on 2021-04-02T14:21:23.928Z

* Fix missing parenthesis in troubleshooting types code example (typescript-cheatsheets#399)

Co-authored-by: swyx <shawnthe1@gmail.com>

* format

* minor improvements to "adding non-standard attributes" (typescript-cheatsheets#400)

* Added event types and their descriptions (typescript-cheatsheets#402)

* Added form types and their descriptions

I was looking for a complete list of form types and couldn't find any anywhere.
I went through the source code and extracted these with adding some description to them, either using MDN's description or some other website explanation.

* Apply suggestions from code review

Co-authored-by: swyx <shawnthe1@gmail.com>

* fix: Remove incorrect usage of "widening" (typescript-cheatsheets#405)

Using an intersection type here is actually narrowing the type, but the intent here seems to be to introduce type assertions, not talk about the difference between wider and narrower types.

* add type assertion for useState thanks @priscilaandreani

closes typescript-cheatsheets#403

* format

* Fixed typo (typescript-cheatsheets#406)

Fixed an issue where a paragraph described three different options as two.

* Add rollpkg as an option for creating libraries (typescript-cheatsheets#407)

* useLocalStorage Type detection bug (typescript-cheatsheets#409)

in my vs code it detects that the type of soredValue is (T | (value: T | ((val: T) => T)) => void)
but it must be just (T)
so it throws error 
with this change it solved.

* Updated README on 2021-04-25T20:13:23.562Z

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Denis LE <ledenis@users.noreply.github.com>
Co-authored-by: swyx <shawnthe1@gmail.com>
Co-authored-by: Sebastian Silbermann <silbermann.sebastian@gmail.com>
Co-authored-by: Lars <32460418+advename@users.noreply.github.com>
Co-authored-by: Gerrit Birkeland <gerrit@gerritbirkeland.com>
Co-authored-by: Christopher Kumm <40023417+ChrisCrossCrash@users.noreply.github.com>
Co-authored-by: Rafael Pedicini <rafael@rafgraph.dev>
Co-authored-by: Mandy YP <63463742+mmdHasan-yazdanPanah@users.noreply.github.com>
stepanenko added a commit to stepanenko/react-ts-best-practices that referenced this pull request May 9, 2021
* Updated README on 2021-04-02T14:21:23.928Z

* Fix missing parenthesis in troubleshooting types code example (typescript-cheatsheets#399)

Co-authored-by: swyx <shawnthe1@gmail.com>

* format

* minor improvements to "adding non-standard attributes" (typescript-cheatsheets#400)

* Added event types and their descriptions (typescript-cheatsheets#402)

* Added form types and their descriptions

I was looking for a complete list of form types and couldn't find any anywhere.
I went through the source code and extracted these with adding some description to them, either using MDN's description or some other website explanation.

* Apply suggestions from code review

Co-authored-by: swyx <shawnthe1@gmail.com>

* fix: Remove incorrect usage of "widening" (typescript-cheatsheets#405)

Using an intersection type here is actually narrowing the type, but the intent here seems to be to introduce type assertions, not talk about the difference between wider and narrower types.

* add type assertion for useState thanks @priscilaandreani

closes typescript-cheatsheets#403

* format

* Fixed typo (typescript-cheatsheets#406)

Fixed an issue where a paragraph described three different options as two.

* Add rollpkg as an option for creating libraries (typescript-cheatsheets#407)

* useLocalStorage Type detection bug (typescript-cheatsheets#409)

in my vs code it detects that the type of soredValue is (T | (value: T | ((val: T) => T)) => void)
but it must be just (T)
so it throws error 
with this change it solved.

* Updated README on 2021-04-25T20:13:23.562Z

* Clarify useRef hook usages (typescript-cheatsheets#412)

Co-authored-by: swyx <shawnthe1@gmail.com>

* Update index.md

* Update from-flow.md

* docs: throw when ref.current is null (typescript-cheatsheets#413)

* Update types.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Denis LE <ledenis@users.noreply.github.com>
Co-authored-by: swyx <shawnthe1@gmail.com>
Co-authored-by: Sebastian Silbermann <silbermann.sebastian@gmail.com>
Co-authored-by: Lars <32460418+advename@users.noreply.github.com>
Co-authored-by: Gerrit Birkeland <gerrit@gerritbirkeland.com>
Co-authored-by: Christopher Kumm <40023417+ChrisCrossCrash@users.noreply.github.com>
Co-authored-by: Rafael Pedicini <rafael@rafgraph.dev>
Co-authored-by: Mandy YP <63463742+mmdHasan-yazdanPanah@users.noreply.github.com>
Co-authored-by: Thien Do <hello@thien.do>
Co-authored-by: Christina Grannas <christina.grannas@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants