https://github.com/jollen/react-websocket-view
A React polyfill that enables elements' Websocket
https://github.com/jollen/react-websocket-view
Last synced: 11 months ago
JSON representation
A React polyfill that enables elements' Websocket
- Host: GitHub
- URL: https://github.com/jollen/react-websocket-view
- Owner: jollen
- License: mit
- Created: 2016-08-11T09:53:19.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-08-11T15:21:05.000Z (almost 10 years ago)
- Last Synced: 2025-06-22T22:17:48.362Z (12 months ago)
- Language: JavaScript
- Homepage:
- Size: 292 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
A React polyfill that enables elements' Websocket
## Install
To setup the package.
```
npm install react-websocket-view --save
```
## Usage
1. Import ```WebsocketView``` from ```react-websocket-view```
2. Use `````` as the parent component, and put Websocket server URI to ```server``` props.
3. Add ```onMessage``` callback to your elements.
## Quickstart
The following sample connects to ```wss://wot.city/object/testman/viewer```, and ```
``` will receive real-time data with ```onMessage``` callback.
```
import React from 'react';
import { render } from 'react-dom';
import { WebsocketView } from 'react-websocket-view';
render(
,
document.getElementById('content')
);
```
## Examples
* Two ```
``` elements receive real-time data from the same server.
```
```
* Two ```
``` elements receive real-time data from different servers.
```
```
## License
The [MIT License](http://www.opensource.org/licenses/MIT) (MIT). See [LICENSE.md](LICENSE.md).