[metal-events] Document process to emit events

[jonathantneal]

I’m unsure how to emit events when working with metal.

In my case, I would like to emit events from metal-toggler whenever the component expands or collapses. How might I do this? I could not find emit documentation

[pragmaticivan]

hey @jonathantneal thanks,

Just in case if that helps you while that gets documented : https://github.com/metal/metal-training

[robframpton]

Hey @jonathantneal

We're currently in the process of improving Metal.js docs, we'll make sure that our improvements include this information. To answer your question, since Component has State in it's prototype chain, it has access to the emit method which allows you to emit custom events with custom payloads.

class MyComponent extends Component {
    someMethod() {
        this.emit('customEventName', {
            key: 'value'
        });
    }
}

Hope that helps.

[jonathantneal]

Thanks, @pragmaticivan, @Robert-Frampton, that does help. Let me know if I can help with the docs, or at least help review them 😄

[robframpton]

Moving this over to metaljs.com/issues bryceosterhaus/metaljs.com#86