Skip to content

Negative example of a Custom Event Name might cause confusion #1986

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
spikeyfish2 opened this issue Feb 6, 2019 · 0 comments · Fixed by #1990
Closed

Negative example of a Custom Event Name might cause confusion #1986

spikeyfish2 opened this issue Feb 6, 2019 · 0 comments · Fixed by #1990
Labels

Comments

@spikeyfish2
Copy link

I'm working with Vue and hit a problem that had me stumped for a few hours. I was using the documentation as a loose guide to emit and receive custom events, however the first example under Event Names here illustrates how not to name both the emitter and the receiving handler. Skim reading the documentation caused me to name the emitter using camel case, and the receiver as kebab case, just working off what I thought was the example.

Perhaps it would be better to illustrate naming these correctly initially, then mention the lack of automatic case transformation afterwards as a common pitfall? Appreciate that fully reading the paragraphs surrounding the example make this clear, however I would suspect a proportion of developers would skim over that like I did.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants