ghost-portal/packages/ui-api
Jaco Greeff bc0c9bfe43
Inject keyring only on dev chains (#717)
* Inject keyring only on dev chains

* Remove useless deconstruct
2019-02-14 17:23:55 +01:00
..
src Inject keyring only on dev chains (#717) 2019-02-14 17:23:55 +01:00
test Split ui-api, update API version (#589) 2019-01-12 09:38:07 +01:00
LICENSE Split ui-api, update API version (#589) 2019-01-12 09:38:07 +01:00
package.json [CI Skip] 0.23.26 2019-02-14 12:31:36 +00:00
README.md Split ui-api, update API version (#589) 2019-01-12 09:38:07 +01:00
webpack.config.js Split ui-api, update API version (#589) 2019-01-12 09:38:07 +01:00

@polkadot/ui-reactive

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-reactive';

...
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')
);
...