Git Product home page Git Product logo

socket-react-client's Introduction

socket-react-client

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

Installation

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

Usage

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>
    );
  }
}

#SocketProvider

props: socket(Socket), [uri(String)]

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

#SocketEmit

props: emit(String), [with(any)]

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

child props: emit(func)

  • emit: Callback to emit message

#SocketOn

props: name(String), [callback(func)]

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

Running in Development

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

Testing

npm test

Contributing

  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

Contributors

License

MIT

socket-react-client's People

Contributors

chengsieuly avatar deancode avatar msotkin avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  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.