vue-events
A Vue.js plugin that simplify events.
Works with both Vue 1.0
& Vue 2.0
.
Installation
1.) Install package via Yarn or NPM
$ yarn add vue-events
$ npm install vue-events
2.) Install plugin within project.
Vue
windowVue =
Methods
Method | Params | Description | Docs |
---|---|---|---|
vm.$events.$emit |
event, payload |
Emit the event with the given payload. | vm.$emit |
vm.$events.emit |
event, payload |
Emit the event with the given payload. Alias for vm.$events.$emit |
vm.$emit |
vm.$events.fire |
event, payload |
Emit the event with the given payload. Alias for vm.$events.$emit |
vm.$emit |
vm.$events.$on |
event, callback |
Listen for the event with the given callback. | vm.$on |
vm.$events.on |
event, callback |
Listen for the event with the given callback. Alias for vm.$events.$on |
vm.$on |
vm.$events.listen |
event, callback |
Listen for the event with the given callback. Alias for vm.$events.$on |
vm.$on |
vm.$events.$off |
event, callback |
Remove event listener(s) for the event | vm.$off |
vm.$events.off |
event, callback |
Remove event listener(s) for the event. Alias for vm.$events.$off |
vm.$off |
vm.$events.remove |
event, callback |
Remove event listener(s) for the event Alias for vm.$events.$off |
vm.$off |
Usage
$events
prototype object.
The This plugin extends Vue.prototype
to include a new $events
object, which is a just a plain vm
that will serve as your global event bus. The $events
vm
has a couple aliases for the standard
event methods.
Firing an event
There are 3 methods that fire events.
Note: $events.fire
& $events.emit
are aliases for $events.$emit
{ return eventData: foo: 'baz' } { this$events; this$events; this$events; }
Listening for an event
There are 3 methods that register event listeners.
Note: $events.listen
& $events.on
are aliases for $events.$on
.
{ this$events; this$events; this$events; }
Removing an event listener
There are 3 methods that remove event listeners.
Note: $events.off
& $events.remove
are aliases for $events.$off
.
{ this$events; } { this$events this$events this$events }
Demo
If you'd like to demo vue-events
try vue-mix