react-native-websocket

WebSocket API wrapped as a component for React Native

Built with ❤︎ by Tiaan and contributors

Table of Contents

Table of Contents

About

Install

Usage

Contribute

License

About

This module provides a simple component wrapper around the the WebSocket API. It provides a declarative way of handling a WebSocket connection.

Install

$ npm install --save react-native-websocket
# OR
$ yarn add react-native-websocket

Usage

import React, { Component } from 'react'
import { AppRegistry, View } from 'react-native'
import WS from 'react-native-websocket'

export default class Example extends Component {

  render () {
    return (
      <View style={{flex: 1}}>
        <WS
          ref={ref => {this.ws = ref}}
          url="wss://echo.websocket.org/"
          onOpen={() => {
            console.log('Open!')
            this.ws.send('Hello')
          }}
          onMessage={console.log}
          onError={console.log}
          onClose={console.log}
          reconnect // Will try to reconnect onClose
        />
      </View>
    )
  }
}

Contribute

Contributions are welcome. Please open up an issue or create PR if you would like to help out.

Note: If editing the README, please conform to the standard-readme specification.

License

Licensed under the MIT License.