vue-smart-bus

A event bus plugin for Vue.js(2.0) that make bus events management much more easier. DEMO

How this plugin works

By injecting a global mixins to the Vue constructor, this plugin will register handlers of bus events in components' created hook and remove them in components' beforeDestroy hook automatically.(If you forget to remove, you are probably going to have a memory leak)

Besides,you can also have access to the bus object by this.$bus in a Vue component and bind($on/$once)/ trigger($emit) /unbind($off) bus events as normal. See the Vue API Doc for more detail.

When in SSR environment, this plugin will just do nothing. Only in browser environment handlers will be taken care of.

How to use it

i. Install the plugin

$ npm install vue-smart-bus --save

ii. Add the plugin into you app

import Vue from 'Vue'
import VueSmartBus from 'VueSmartBus'

Vue.use(VueSmartBus)

iii. add $_busEvents attribute to Vue component

$_busEvents should be a function (just like data) that returns a object containing bunch of handlers<Function | Object | Array<Function|Object>> of bus events you want to listen in the component. All the handlers registered in this way will be remove automatically in lifecycle hook beforeDestroy

export default {
 ...,
 $_busEvents() {
   return {
     // listeners registered in attribute `$_busEvents` will be cleaned up automatically
     GLOBAL_EVENT_A: this.doSomething,
     GLOBAL_EVENT_B: {
       handler: this.doSomethingElse,
       once: true
     },
     GLOBAL_EVENT_C: [
       {
         handler: this.doSomethingElse,
         once: true
       },
       this.doSomethingBigger
     ]
   }
 },
 methods: {
   addOtherBusEventListeners() {
     // you can also register listeners anywhere you like, but listeners registered
     // in this way need to be cleaned up manually
     this.$bus.$on(GLOBAL_EVENT_OTHER, () => { ... })
   }
 },
 beforeDestroy() {
   // clean up listeners manually
   this.$bus.$off(GLOBAL_EVENT_OTHER)
 }
}

Features

i. Automatically Bind in created and Unbind in beforeDestroy(only for listeners bond in $_busEvents)

ii. Separation between Components(only for listeners bond in $_busEvents)

Even though multiple components register the same bus event, the process of binding or unbinding listeners works independently on component level.

Let's say both compA and compB have registered a bus event EventC on the same page. At some point compA is going to be destroyed. In that case, only listeners(on EventC) bond in compA will be cleaned up, while listeners(on EventC) in compB will still exist, listening EventC.

For more detail, run the demo project.

License

MIT

Copyright (c) 2018-present, Zhongxian Liang