History

Albert 2215541cd9 Apply Nunito fonts globally (#3882 ) * Add nunito fonts * Apply Nunito fonts globally * Remove Nunito fonts (600,800) * Add fontFamily to themes * Unify font-weight and font-family across app * Fix linting * Use Monospace font from theme where required * Add font-family from theme to buttons * Revert font-family change in Claim * Provide enough vertical space for rendering of an account name with verified identity * Use theme font in transfer and search inputs Co-authored-by: Jaco Greeff <jacogr@gmail.com> Co-authored-by: Krzysztof Jelski <krzysztof@ethworks.io>		2020-11-04 14:35:49 +01:00
..
src	Apply Nunito fonts globally (#3882 )	2020-11-04 14:35:49 +01:00
.skip-build	Skip npm	2020-02-27 22:18:23 +01:00
.skip-npm	Skip npm	2020-02-27 22:18:23 +01:00
index.html	Rename ui-* -> react-* (#1495 )	2019-08-12 13:12:05 +02:00
LICENSE	Rename ui-* -> react-* (#1495 )	2019-08-12 13:12:05 +02:00
package.json	[CI Skip] release/beta 0.65.2-2	2020-11-03 19:03:05 +00:00
README.md	Rename ui-* -> react-* (#1495 )	2019-08-12 13:12:05 +02:00
webpack.config.js	SPDX (#3705 )	2020-09-17 16:46:46 +02:00

README.md

@polkadot/react-query

WARNING: This is an internal package to polkadot-js/apps so is not inteded (yet) for broad use. Since these are generic components, they will move to the polkadot-js/ui repo once deemed stable and usable.

For the existing sharable components usable in external React-based projects, take a look at the polkadot-js/ui documentation

Overview

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/react-query';

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