mirror of
https://github.com/pezkuwichain/pezkuwi-apps.git
synced 2026-04-22 08:58:00 +00:00
pezkuwichain
d21bfb1320
Rebranded terminology: - Polkadot → Pezkuwi - Kusama → Dicle - Westend → Zagros - Rococo → PezkuwiChain - Substrate → Bizinikiwi - parachain → teyrchain Custom logos with Kurdistan brand colors (#e6007a → #86e62a): - bizinikiwi-hexagon.svg - sora-bizinikiwi.svg - hezscanner.svg - heztreasury.svg - pezkuwiscan.svg - pezkuwistats.svg - pezkuwiassembly.svg - pezkuwiholic.svg
43 lines
1.4 KiB
Markdown
43 lines
1.4 KiB
Markdown
# @pezkuwi/react-query
|
|
|
|
WARNING: This is an internal package to [pezkuwi-js/apps](https://github.com/pezkuwi-js/apps) so is not intended (yet) for broad use. Since these are generic components, they will move to the [pezkuwi-js/ui](https://github.com/pezkuwi-js/ui) repo once deemed stable and usable.
|
|
|
|
For the existing sharable components usable in external React-based projects, take a look at the [pezkuwi-js/ui documentation](https://pezkuwi.js.org/ui/)
|
|
|
|
## Overview
|
|
|
|
A collection of RxJS enabled React components that operate with the [@pezkuwi/api-rx](https://github.com/pezkuwi-js/api) 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,
|
|
|
|
```js
|
|
import React from 'react';
|
|
import ReactDOM from 'react-dom';
|
|
|
|
import { Api, NodeTime } from '@pezkuwi/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.
|
|
|
|
```js
|
|
...
|
|
ReactDOM.render(
|
|
<Api>
|
|
<NodeTime className='rx-time' label='current node time:' />
|
|
</Api>,
|
|
document.querySelector('#container')
|
|
);
|
|
...
|
|
```
|