[![NPM version](https://img.shields.io/npm/v/vue-socket-io.svg)](https://www.npmjs.com/package/vue-socket-io)
![VueJS v1.x compatible](https://img.shields.io/badge/vue%201.x-compatible-green.svg)
![VueJS v2.x compatible](https://img.shields.io/badge/vue%202.x-compatible-green.svg)

Vue-Socket-io (socket.io) plugin for VueJS.
This is a fork of Vue-Websocket by icebob

## Install
### NPM
You can install it via [NPM](http://npmjs.org/).
```
$ npm install vue-socket-io
```

## Usage
Register the plugin, it will connect to `/`
```js
import VueSocketIO from "vue-socket-io";
Vue.use(VueSocketIO);
```
or connect to other address:
```js
Vue.use(VueSocketIO, "ws://otherserver:8080");
```
You can pass options too:
```js
Vue.use(VueSocketIO, "ws://otherserver:8080", {
	reconnection: false
});
```


Use it in your components:
```html
<script>
	export default {
		
		methods: {
			add() {
		  		// Emit the server side
		  		this.$socket.emit("add", { a: 5, b: 3 });    
			},
			
			get() {
		  		this.$socket.emit("get", { id: 12 }, (response) => {
					...
				});    
			}
		},

		socket: {
			// Prefix for event names
			// prefix: "/counter/",
			
			// If you set `namespace`, it will create a new socket connection to the namespace instead of `/`
			// namespace: "/counter",

			events: {

				// Similar as this.$socket.on("changed", (msg) => { ... });
				// If you set `prefix` to `/counter/`, the event name will be `/counter/changed`
				//
				changed(msg) {
					console.log("Something changed: " + msg);
				}
				
				/* common socket.io events
				connect() {
					console.log("Websocket connected to " + this.$socket.nsp);
				},

				disconnect() {
					console.log("Websocket disconnected from " + this.$socket.nsp);
				},

				error(err) {
					console.error("Websocket error!", err);
				}
				*/

			}
		}
	};

</script>
```

## Build
This command will build a distributable version in the `dist` directory.
```bash
npm run build
```

## Test
```bash
npm test
```

## Contribution
Please send pull requests improving the usage and fixing bugs, improving documentation and providing better examples, or providing some testing, because these things are important.

## License
vue-socket-io is available under the [MIT license](https://tldrlegal.com/license/mit-license).

## Contact

Copyright (C) 2017 Daksh

[![@dakshmiglani](https://img.shields.io/badge/github-DakshMiglani-green.svg)](https://github.com/DakshMiglani)