Skip to content

Proposal: Move user-event documentation here #519

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

Closed
nickserv opened this issue Jul 3, 2020 · 2 comments · Fixed by #980
Closed

Proposal: Move user-event documentation here #519

nickserv opened this issue Jul 3, 2020 · 2 comments · Fixed by #980
Assignees
Labels
organization 📂 Something needs to be moved

Comments

@nickserv
Copy link
Member

nickserv commented Jul 3, 2020

Is your feature request related to a problem? Please describe.

Some users either aren't aware about user-event because it's not mentioned by the documentation, or want to use it but find the documentation harder to find.

Describe the solution you'd like

Move at least the API documentation in user-event's readme to a prominent page in the sidebar of the docs. This should be in a format similar to fireEvent to make it easier to learn, but still in a separate section so users are aware they have to install another package. Overall, it should be clear that this is recommended, but still not actually a part of the other testing libraries.

Additional context

This could also make it easier to migrate user-event back into dom-testing-library in the future.

Related issues

@MatanBobi
Copy link
Member

I agree with this one,
I think that user-event is pretty much hidden and having the API in the docs site sounds like a good idea to me.

@nickserv nickserv self-assigned this Jul 11, 2020
@nickserv nickserv added the organization 📂 Something needs to be moved label Oct 7, 2020
@nickserv
Copy link
Member Author

nickserv commented Jul 18, 2021

There's already a user-event page in the docs, but there are still some differences between the docs page and the readme. In order to remove this content from user-event, we'll need to make sure they're in sync first.

Here's what I'm planning on doing:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
organization 📂 Something needs to be moved
Projects
Development

Successfully merging a pull request may close this issue.

2 participants