ghost-portal/packages/ui-react-rx
Jaco Greeff fb9c0f7f0b
Format stakingBalance as votingBalance + nominatingBalance (#204)
* Format stakingBalance as votingBalance + nominatingBalance

* Fix version number change (revert)

* Bump api 0.15.x: rxjs 6 & class-ified providers

* API bump

* Type cleanup

* Update version of packages

* RxJs 6 style Observable imports

* Remove ZERO const
2018-08-08 02:12:30 +02:00
..
src Format stakingBalance as votingBalance + nominatingBalance (#204) 2018-08-08 02:12:30 +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 Format stakingBalance as votingBalance + nominatingBalance (#204) 2018-08-08 02:12:30 +02: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')
);
...