ghost-portal/packages/ui-api
Jaco Greeff 612b5d0f45
API update (metadata v1), fragment support (#652)
* Use fragments instead of [] returns

* Frament part 2

* Update API

* Update Creator.tsx

* Review cleanups
2019-01-26 17:27:13 +01:00
..
src Don't make storage queries with missing params (#631) 2019-01-21 15:05:09 +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 API update (metadata v1), fragment support (#652) 2019-01-26 17:27:13 +01: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')
);
...