gustavoaires/react-stomp

React websocket component for STOMP protocol over SockJs

react-stomp

React component for SockJS-client with STOMP messaging protocol.

Installation

npm install --save react-stomp

Example Usage

import React from 'react';
import SockJsClient from 'react-stomp';

class SampleComponent extends React.Component {
  constructor(props) {
    super(props);
  }

  sendMessage = (msg) => {
    this.clientRef.sendMessage('/topics/all', msg);
  }

  render() {
    return (
      <div>
        <SockJsClient url='http://localhost:8080/ws' topics={['/topics/all']}
            onMessage={(msg) => { console.log(msg); }}
            ref={ (client) => { this.clientRef = client }} />
      </div>
    );
  }
}

A working implementation using Spring Boot and react-talk can be found at https://github.com/lahsivjar/spring-websocket-template/tree/master/with-sockjs

Parameters

• url: HTTP URL of the websocket endpoint to connect
• topics: An array of topics to subscribe
• onMessage: Callback when a message is recieved
• onConnect: Callback after connection is established
• onDisconnect: Callback after connection is lost
• getRetryInterval: Function property which takes a number parameter indicating the retry count for a particular disconnection and returns another number specifying the interval for next retry (will be ignored if auto reconnect is false, defaults to retryCount seconds)
• headers: Headers that will be passed to the server or broker with connection request
• autoReconnect: boolean indicating if retry should be attempted in an event of loosing connection (defaults to true)
• debug: Enable debugging mode (defaults to false)

API

• sendMessage(topic, msg, opt_headers): Send message to the specified topic

Issues

Report any issues or bugs to https://github.com/lahsivjar/react-stomp/issues

License

This project is licensed under the MIT License - see the LICENSE file for details