mirror of
https://github.com/pezkuwichain/pezkuwi-ui.git
synced 2026-04-22 21:58:02 +00:00
Jaco Greeff
c58835059d
* Docs update, getting started * Typos * Cleanups, linking * Update with additional packages
35 lines
2.6 KiB
Markdown
35 lines
2.6 KiB
Markdown
[](https://polkadot.js.org)
|
|
|
|
[](https://www.npmjs.com/package/@polkadot/react-identicon)
|
|
[](https://www.npmjs.com/package/@polkadot/react-identicon)
|
|
[](https://codeclimate.com/github/polkadot-js/ui)
|
|
[](https://codeclimate.com/github/polkadot-js/ui)
|
|
|
|
# @polkadot/ui
|
|
|
|
Basic browser and framework agnostic UI components for creating apps using the polkadot{.js} libraries
|
|
|
|
## overview
|
|
|
|
The following UI components are currently available -
|
|
|
|
- [react-identicon](packages/react-identicon/) React identity icon generator with address as input
|
|
- [reactnative-identicon](packages/reactnative-identicon/) React Native identity icon generator with address as input
|
|
- [vue-identicon](packages/vue-identicon/) Vue identity icon generator with address as input
|
|
- [react-qr](packages/react-qr/) QR code generator/reader for [uos](https://github.com/maciejhirsz/uos) (Substrate/Polkadot only)
|
|
|
|
Additionally some shared libraries, that is not dependent on any framework -
|
|
|
|
- [ui-assets](packages/ui-assets/) Static assets, images and others, shared accross projects
|
|
- [ui-keyring](packages/ui-keyring/) A browser-specific wrapper around the base [@polkadot/util-keyring](https://github.com/polkadot-js/util/) library
|
|
- [ui-settings](packages/ui-settings/) A browser local storage wrapper for app settings & configuration
|
|
- [ui-shared](packages/ui-shared) Shared logic that is used accross UI components, e.g. for icon generation
|
|
|
|
## examples
|
|
|
|
In addition to the above packages, there are examples available for intergation of `ui-keyring`, `ui-settings` & the relevant `*-identicon` package. These are
|
|
|
|
- [example-react](packages/example-react) - start with `yarn example:react` and view on `http://localhost:8080`
|
|
- [example-reactnative](packages/exampleReactNative) - start with `yarn example:rn:packager` to start the packager service and then either `yarn example:rn:android` or `yarn example:rn:ios` in another terminal
|
|
- [example-vue](packages/example-vue) - start with `yarn example:vue` and view on `http://localhost:8080`
|