https://github.com/yangmingshan/vue-bus

A event bus for Vue.js
https://github.com/yangmingshan/vue-bus

Last synced: 3 months ago
JSON representation

A event bus for Vue.js

• Host: GitHub
• URL: https://github.com/yangmingshan/vue-bus
• Owner: yangmingshan
• License: mit
• Created: 2016-11-08T13:13:30.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-03-04T03:27:03.000Z (over 1 year ago)
• Last Synced: 2024-03-18T12:21:51.838Z (3 months ago)
• Language: JavaScript
• Size: 783 KB
• Stars: 316
• Watchers: 11
• Forks: 32
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-github-vue - vue-bus - VueJS的事件总线 (实用库)
• awesome-vue - vue-bus - bus?style=social) - VueJS的事件总线 (实用库)
• awesome-github-vue - vue-bus - VueJS的事件总线 (实用库)
• awesome-github-vue - vue-bus - VueJS的事件总线 (实用库)
• awesome - vue-bus - VueJS的事件总线 (实用库)

README

        
# vue-bus [![Build Status](https://img.shields.io/circleci/project/yangmingshan/vue-bus.svg)](https://circleci.com/gh/yangmingshan/vue-bus) [![Coverage Status](https://img.shields.io/codecov/c/github/yangmingshan/vue-bus.svg)](https://codecov.io/gh/yangmingshan/vue-bus) [![Downloads](https://img.shields.io/npm/dt/vue-bus.svg)](https://www.npmjs.com/package/vue-bus) [![Version](https://img.shields.io/npm/v/vue-bus.svg)](https://www.npmjs.com/package/vue-bus) [![License](https://img.shields.io/npm/l/vue-bus.svg)](https://www.npmjs.com/package/vue-bus)

A event bus for Vue.js, support both Vue 1.0 and 2.0. See Vue [documentation](https://vuejs.org/v2/guide/migration.html#Events) for more detail.

## Installation

You can install it via [yarn](https://yarnpkg.com) or [npm](https://npmjs.com).

```

$ yarn add vue-bus

$ npm install vue-bus --save

```

And it's available on [jsdelivr](https://cdn.jsdelivr.net/npm/vue-bus/dist/vue-bus.js) or [unpkg](https://unpkg.com/vue-bus/dist/vue-bus.js).

```html

```

When used with a module system, you must explicitly install the bus via Vue.use():

```js

import Vue from 'vue';

import VueBus from 'vue-bus';

Vue.use(VueBus);

```

You don't need to do this when using global script tags.

## Usage

#### Listen and clean

```js

// ...

created() {

  this.$bus.on('add-todo', this.addTodo);

  this.$bus.once('once', () => console.log('This listener will only fire once'));

},

beforeDestroy() {

  this.$bus.off('add-todo', this.addTodo);

},

methods: {

  addTodo(newTodo) {

    this.todos.push(newTodo);

  }

}

```

#### Trigger

```js

// ...

methods: {

  addTodo() {

    this.$bus.emit('add-todo', { text: this.newTodoText });

    this.$bus.emit('once');

    this.newTodoText = '';

  }

}

```

#### Another way to use vue-bus

```js

// xxx.js

import Vue from 'vue';

Vue.bus.emit('someEvent');

```

*Note: `on` `once` `off` `emit` are aliases for `$on` `$once` `$off` `$emit`. See the [API](https://vuejs.org/v2/api/#Instance-Methods-Events) for more detail.*

## License

[MIT](https://opensource.org/licenses/MIT)