Update README.md

pull/36/head
Fl0pZz 7 years ago committed by GitHub
parent 8de127066d
commit 3de1086696

@ -27,12 +27,18 @@ Bind custom socket.io-client instance
Vue.use(VueSocketio, socketio('http://socketserver.com:1923'));
```
Enable Vuex integration
Enable Vuex integration (use mutations)
``` js
import store from './yourstore'
Vue.use(VueSocketio, socketio('http://socketserver.com:1923'), store);
```
Enable Vuex integration (use actoins)
``` js
import store from './yourstore'
Vue.use(VueSocketio, socketio('http://socketserver.com:1923'), store, true);
```
#### On Vuejs instance usage
``` js
var vm = new Vue({
@ -94,6 +100,51 @@ export default new Vuex.Store({
})
```
Example store, socket actions always have "socket" prefix
``` js
import Vue from 'vue'
import Vuex from 'vuex'
const someModule = {
// ...
mutations: {
SOME_MUTATION: (state, payload) => {
// do something
}
}
}
const socketModule = {
state: {
connect: false,
message: null
},
mutations:{
CONNECT: (state, status ) => {
state.connect = true;
},
USER_MESSAGE: (state, message) => {
state.message = message;
}
},
actions: {
socketUserMessage: ({ commit, dispatch, state }, message) => {
commit(USER_MESSAGE, message);
commit(SOME_MUTATION, message);
}
}
}
Vue.use(Vuex);
export default new Vuex.Store({
modules: {
someModule,
socketModule
}
})
```
## Example
[Realtime Car Tracker System](http://metinseylan.com/)

Loading…
Cancel
Save