ghost-portal/packages/ui-react-rx
Jaco Greeff 3fb85094a6
Example & tutorial (#127)
* Add tutorial step 001

* Update LICENSE header

* Query storage via HOC

* Tut 003, read proposals

* Tut 004 replacing HOC

* Pull Intentions & Proposals together

* Add final image

* Cleanup unused methods

* Source links

* Remove unused var
2018-07-09 13:38:31 +02:00
..
src Example & tutorial (#127) 2018-07-09 13:38:31 +02:00
test Copyright project authors (#95) 2018-06-13 22:32:49 +02:00
index.html Include ui-* packages in repo (development speed) (#65) 2018-05-29 17:33:29 +02:00
LICENSE Copyright project authors (#95) 2018-06-13 22:32:49 +02:00
package.json [CI Skip] 0.18.9 2018-07-05 13:31:10 +00:00
README.md Include ui-* packages in repo (development speed) (#65) 2018-05-29 17:33:29 +02:00
webpack.config.js Support enumerable accounts (#102) 2018-06-25 18:02:47 +02:00

polkadotjs isc style npm travis maintainability coverage dependency devDependency

@polkadot/ui-react-rx

A collection of RxJS enabled React components that operate with the @polkadot/api-rx library. It automatically manages subscriptions on behalf of the developer, providing a number of unstyled components that can be used to construct UIs.

usage

Basic usage entails creating a ContextProvider and just using the components. For instance, to display the current node time,

import React from 'react';
import ReactDOM from 'react-dom';

import { Api, NodeTime } from '@polkadot/ui-react-rx';

...
ReactDOM.render(
  <Api>
    <NodeTime />
  </Api>,
  document.querySelector('#container')
);
...

All components are provided unstyled making no assumptions on the actual use, however they all support (optionally) the label, className and style attributes, that can be used to style to component.

...
ReactDOM.render(
  <Api>
    <NodeTime className='rx-time' label='current node time:' />
  </Api>,
  document.querySelector('#container')
);
...