Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/msonowal/vue-echo
https://github.com/msonowal/vue-echo
echo-instance laravel-echo presence-channels vue-echo
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/msonowal/vue-echo
- Owner: msonowal
- License: mit
- Created: 2017-05-17T15:18:55.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-05-16T14:25:25.000Z (over 2 years ago)
- Last Synced: 2024-11-30T05:48:16.816Z (about 1 month ago)
- Topics: echo-instance, laravel-echo, presence-channels, vue-echo
- Language: JavaScript
- Size: 37.1 KB
- Stars: 20
- Watchers: 3
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vue-echo
Vue 2 integration for the Laravel Echo library with latest dependencies.
This Vue plugin injects a Laravel Echo instance into all of your vue instances, allowing for a simple channel subscription on each instance, or using Laravel Echo through `this.$echo`.
You can use socket.io and pusher or any config as per laravel/echo
This project does not require updates as it directly uses your latest version
[NPM LINK package/vue-echo-laravel ](https://www.npmjs.com/package/vue-echo-laravel)
## Install
via yarn
``` bash
yarn add vue-echo-laravel
```
or via npm
``` bash
npm install vue-echo-laravel --save
```
## Usage
### Initialize
First you'll need to register the plugin and, optionally, initialize the Echo instance.
``` js
import VueEcho from 'vue-echo-laravel';
Vue.use(VueEcho, {
broadcaster: 'socket.io',
host: window.location.hostname + ':6001',
});
/**
* Alternatively you can pass an echo instance:
* ********************************************
* import Echo from 'laravel-echo';
*
* const EchoInstance = new Echo({
* broadcaster: 'socket.io',
* host: window.location.hostname + ':6001',
* namespace: 'App.Events',
* });
* Vue.use(VueEcho, EchoInstance);
*/
```
### Using Echo
Once vue-echo is registered, every vue instance is able to subscribe to channels and listen to events through the `this.$echo` property on the connection you specified earlier.
```js
var vm = new Vue({
mounted() {
// Listen for the 'NewBlogPost' event in the 'team.1' private channel
this.$echo.private('team.1').listen('NewBlogPost', (payload) => {
console.log(payload);
});
}
});
```
### Subscribe your Vue instance to a single channel
You can subscribe a vue instance to a single standard channel if needed and define your events.
```js
var vm = new Vue({
channel: 'blog',
echo: {
'BlogPostCreated': (payload) => {
console.log('blog post created', payload);
},
'BlogPostDeleted': (payload) => {
console.log('blog post deleted', payload);
}
}
});
```
You can feel free to use `this` inside Your methods.
#### Subscribing to channels
Laravel Echo allows you to subscribe to: normal, private and presence channels.
In the example above, we subscribed to a standard channel.
##### Private channel
If you would like to subscribe to a private channel instead, prefix your channel name with `private:`
```js
var vm = new Vue({
channel: 'private:user.1',
echo: {
'BlogPostCreated': (payload) => {
console.log('blog post created', payload);
},
'BlogPostDeleted': (payload) => {
console.log('blog post deleted', payload);
}
}
});
```
If you need to compute channel name, you should pass `channel` as function.
```js
var vm = new Vue({
channel() {
return `private:user.${ this.userId }`
},
echo: {
'BlogPostCreated': (payload) => {
console.log('blog post created', payload);
},
'BlogPostDeleted': (payload) => {
console.log('blog post deleted', payload);
}
},
computed: {
userId() {
return 1;
}
}
});
````
##### Presence channel
If you would like to subscribe to presence channel instead, prefix your channel name with `presence:`
```js
var vm = new Vue({
channel: 'presence:user.1.chat',
echo: {
'NewMessage': (payload) => {
console.log('new message from team', payload);
}
}
});
```
### Manually listening to events
If there's a scenario where you want to listen to events after certain conditions are met, you can do so through `this.channel`:
```js
var vm = new Vue({
channel: 'private:user.1',
echo: {
'BlogPostCreated': (payload) => {
console.log('blog post created', payload);
},
'BlogPostDeleted': (payload) => {
console.log('blog post deleted', payload);
}
},
mounted(){
if(window.user.role == 'admin'){
this.channel.listen('BlogPostEdited', (payload) => {
console.log('As admin I get notified of edits', payload);
});
}
}
});
```
### Acepting PR for Vue Composition API