Giter VIP home page Giter VIP logo

phoenix-react-socket-provider's Introduction

Socket Spike

Components

SocketProvider

To be used once at the top level of the app similar to Redux Provider ex:

 <SocketProvider wsUrl='ws:0.0.0.0:4000/socket', options={{token: '<token>'}}>
   <App />
 </SocketProvider>

SocketChannel

The SocketChannel is rendered inside of your components to respond to and send messages over the specified channel.

1 - Used as a self-closing component to respond to messages, doesnt affect markup ex:

 render() {
   // .. jsx ...
   <SocketChannel
     channel='myChannel'
     onMessage={this.handleBroadcast}
    />
   // ... more jsx ...
 }

the onMessage callback is invoked with { event: 'eventName', payload: {foo: 'bar'} } when any message is broadcast over the specified channel. Call setState or dispatch an action to redux here.

2 - Used to broadcast messages to the channel. All children are injected with channel prop ex:

render() {
  // ... jsx ...
  <SocketChannel
    channel='myChannel'
    onMessage={this.handleBroadcast}
   >
    <MyButton />
  <SocketChannel />
  // ... more jsx ...
}

const MyButton = ({ channel }) => (
  <button onClick={() => channel.push('some_message', 'some_payload')} />
)

phoenix-react-socket-provider's People

Contributors

alexgriff avatar

Watchers

James Cloos 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.