Repository files navigation

Unopinionated, lightweight React components for managing socket.io events on the client.

1. Fork fromhttps://github.com/socket-react-client/socket-react-client
2. npm install

Three components are made available, SocketProvider, SocketEmit, SocketOn.

To use these, simply import the component/components you want to your file.

import { SocketProvider, SocketEmit, SocketOn } from 'socket-react-client'; const Button = ({ emit }) => {  return <button onClick={emit}>Click me</button>;}class App extends Component {  constructor() {    super();    this.update = this.update.bind(this);    this.state = { bool: false }  }  update() {    this.setState({ bool: !this.state.bool });  }  render() {    return (      <div>        <SocketEmit emit='hello' with={{ hello: 'world' }}>          <Button />          <Button />        </SocketEmit>        <SocketOn on='world' do={this.update} />      </div>    );  }}

• socket: The Socket object provided upon instantiation
• uri: The uri in which the socket connection is made

• emit: The name of the event to emit
• with: The data to pass to listeners

• emit: Callback to emit message

• on: The name of the event to listen to
• do: The function to run upon receiving event

npm start will start a webpack developement server with pre-built starter code

npm test

1. Fork it!
2. Create your feature branch:git checkout -b my-new-feature
3. Commit your changes:git commit -am 'Add some feature'
4. Push to the branch:git push origin my-new-feature
5. Submit a pull request :D

• Michael Sotkin
• Dean Edwards
• Cheng Ly

MIT