wawa0584 / custom-event-js

Event dispatcher based on the CustomEvent interface (works on browser)

Custom Event Dispatcher

The Custom Event Dispatcher provides the ability to communicate inside your application by dispatching events and listening to them. It also runs polyfill for Internet Explorer 9 and higher. What is the CustomEvent interface you may find here.

Custom Event Dispatcher works in all popular browsers, including Internet Explorer 9 and higher.

Install

npm

npm install --save custom-event-js

yarn

yarn add custom-event-js --save

Example

import CustomEvent from 'custom-event-js'

// Listen event 'SHOW_NAME'
CustomEvent.on('SHOW_NAME', (data) => {
    console.log(data.detail) // { name: 'GitHub' }
})

// Dispatch event 'SHOW_NAME' with data
CustomEvent.dispatch('SHOW_NAME', { name: 'GitHub' })

// Remove event listener
CustomEvent.off('SHOW_NAME')

API

• on(eventName, callback) add an appropriate event listener. When event gets fired callback will be called with detail argument

• dispatch(eventName, detail) dispatch event to all event listeners

• off(eventName) remove event listener

Contributing

Any contributions you make are greatly appreciated.

Please read the Contributions Guidelines before submitting a PR.

License

MIT © Vasyl Stokolosa