Vue-Socket.io: Socket.io with Vue.js

Vue-Socket.io

This project is an adaptation of socket.io to Vue.js. It allows its users to use socket's cababilities easy within a Vue project.

Socket.IO enables real-time bidirectional event-based communication. It works on every platform, browser or device, focusing equally on reliability and speed.

Usage example:

Install

  npm install vue-socket.io --save

for Vue 1.0

  npm install vue-socket.io@1.0.2 --save

Usage

import VueSocketio from 'vue-socket.io';

Vue.use(VueSocketio, 'http://socketserver.com:1923'); // Automaticly socket connect from url string

/*
  import socketio from 'socket.io-client';

  var ioInstance = socketio('http://socketserver.com:1923');

  Vue.use(VueSocketio, ioInstance); // bind custom socketio instance
*/

var vm = new Vue({
  sockets:{
    connect: function(){
      console.log('socket connected')
    },
    customEmit: function(val){
      console.log('this method fired by socket server. eg: io.emit("customEmit", data)')
    }
  },
  methods: {
    clickButton: function(val){
        // $socket is socket.io-client instance
        this.$socket.emit('emit_method', val);
    }
  }
})

Watch a live example, and visit its GitHub page.