mirror of
https://github.com/MetinSeylan/Vue-Socket.io.git
synced 2025-04-16 15:21:28 +02:00
component level usage added
This commit is contained in:
parent
36870b3d31
commit
63235b346c
1 changed files with 26 additions and 5 deletions
23
README.md
23
README.md
|
@ -44,7 +44,7 @@ new Vue({
|
||||||
router,
|
router,
|
||||||
store,
|
store,
|
||||||
render: h => h(App)
|
render: h => h(App)
|
||||||
}).$mount('#app');
|
}).$mount('#app')
|
||||||
```
|
```
|
||||||
|
|
||||||
**Parameters**|**Type's**|**Default**|**Required**|**Description**
|
**Parameters**|**Type's**|**Default**|**Required**|**Description**
|
||||||
|
@ -54,3 +54,24 @@ connection|String/Socket.io-client|`null`|Required|Websocket server url or socke
|
||||||
vuex.store|Vuex|`null`|Optional|Vuex store instance
|
vuex.store|Vuex|`null`|Optional|Vuex store instance
|
||||||
vuex.actionPrefix|String|`null`|Optional|Prefix for emitting server side vuex actions
|
vuex.actionPrefix|String|`null`|Optional|Prefix for emitting server side vuex actions
|
||||||
vuex.mutationPrefix|String |`null`|Optional|Prefix for emitting server side vuex mutations
|
vuex.mutationPrefix|String |`null`|Optional|Prefix for emitting server side vuex mutations
|
||||||
|
|
||||||
|
#### 🌈 Component Level Usage
|
||||||
|
|
||||||
|
``` javascript
|
||||||
|
new Vue({
|
||||||
|
sockets: {
|
||||||
|
connect: function () {
|
||||||
|
console.log('socket connected')
|
||||||
|
},
|
||||||
|
customEmit: function (data) {
|
||||||
|
console.log('this method was fired by the socket server. eg: io.emit("customEmit", data)')
|
||||||
|
}
|
||||||
|
},
|
||||||
|
methods: {
|
||||||
|
clickButton: function (val) {
|
||||||
|
// $socket is socket.io-client instance
|
||||||
|
this.$socket.emit('emit_method', val);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
```
|
Loading…
Add table
Reference in a new issue