Giter Club home page Giter Club logo

react-socket's Introduction

react-socket

Build Status Dependency Status NPM version

A React wrapper for Socket.IO

Usage

Just mount a socket on one of your components:

var React  = require('react'),
	Socket = require('react-socket').Socket;

module.exports = module.exports = React.createClass({
	render: function () {

		return (
			<div>
				<Socket url="your-socket-endpoint:port?"/>
			</div>
		);
	}
});

and then start listening to it:

var React       = require('react'),
	SocketEvent = require('react-socket').Event;

module.exports = module.exports = React.createClass({
	onSocketMessage: function (message) {

		...
	},
	render: function () {

		return (
			<div>
				<SocketEvent name="your-socket-event" callback={ this.onSocketMessage }/>
			</div>
		);
	}
});

Use the name property to mount more than one socket:

var React  = require('react'),
	Socket = require('react-socket');

module.exports = module.exports = React.createClass({
	render: function () {

		return (
			<div>
				<Socket.Socket url="/a" name="a"/>
				<Socket.Socket url="/b" name="b"/>
				<Socket.Event socket="a" name="foo" callback={ this.onA }/>
				<Socket.Event socket="b" name="foo" callback={ this.onB }/>
			</div>
		);
	}
});

Every mounted socket gets disconnect before its component gets unmounted and the same goes to the events.

react-socket's People

Contributors

coma avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.