Misleading description on how $emit works in the guide

[shentao]

Noticed a few times already that there is a misconception around the way this.$emit works. The source of the problem might come from this line:

To emit an event to the parent, we can call the built-in $emit method, passing the name of the event
found here: https://vuejs.org/v2/guide/components.html#Sending-Messages-to-Parents-with-Events

I understand that this might be there to make it slightly easier to grasp the idea of props down, events up but I’m not sure if this is worth it.

The issue is that it might mislead the user that it actually emits an event to the parent component even though the API docs clearly state:

Trigger an event on the current instance. Any additional arguments will be passed into the listener’s callback function.

I think it might be a good idea to update the guide to highlight that fact that $emit only emits an event on itself and the parent component can choose to listen to those events by setting up listeners on the child instance through the template syntax: @event-name="handler".

I can PR a change to the guide if we agree to introduce such change.

[sdras]

That sounds like really good feedback, I think you're right, that would be easier for people to grasp on first reading. I defer to Chris, though.

[chrisvfritz]

Sounds good to me! 🙂

[shentao]

Great! Will work on the changes over the next few days. :)