[CI Skip] 0.28.4

This commit is contained in:
Travis CI committed 2019-02-27 10:22:45 +00:00
1 parent 28b991d61d
commit b74f8de6ff
202 files changed
+6646 -8

No files matched your search

+21
View File
@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Hierarchy | polkadot-js/ui</title>
<meta name="description" content="UI libraries and utilities in-use accross @polkadot projects">
<link rel="preload" href="/ui/assets/css/0.styles.f5c7dbec.css" as="style"><link rel="preload" href="/ui/assets/js/app.73634ed0.js" as="script"><link rel="preload" href="/ui/assets/js/2.f00ab508.js" as="script"><link rel="preload" href="/ui/assets/js/37.decf506d.js" as="script"><link rel="prefetch" href="/ui/assets/js/10.feee2fb6.js"><link rel="prefetch" href="/ui/assets/js/11.4431186e.js"><link rel="prefetch" href="/ui/assets/js/12.60cde7c6.js"><link rel="prefetch" href="/ui/assets/js/13.e8f9b929.js"><link rel="prefetch" href="/ui/assets/js/14.edf23a0c.js"><link rel="prefetch" href="/ui/assets/js/15.6e140e5c.js"><link rel="prefetch" href="/ui/assets/js/16.814a59b4.js"><link rel="prefetch" href="/ui/assets/js/17.4319f57a.js"><link rel="prefetch" href="/ui/assets/js/18.00707b98.js"><link rel="prefetch" href="/ui/assets/js/19.0353e250.js"><link rel="prefetch" href="/ui/assets/js/20.f2154956.js"><link rel="prefetch" href="/ui/assets/js/21.d98322fa.js"><link rel="prefetch" href="/ui/assets/js/22.11f02f68.js"><link rel="prefetch" href="/ui/assets/js/23.7e342d4b.js"><link rel="prefetch" href="/ui/assets/js/24.09820451.js"><link rel="prefetch" href="/ui/assets/js/25.1bd9b377.js"><link rel="prefetch" href="/ui/assets/js/26.7b3990eb.js"><link rel="prefetch" href="/ui/assets/js/27.dd6dd743.js"><link rel="prefetch" href="/ui/assets/js/28.233b0f0a.js"><link rel="prefetch" href="/ui/assets/js/29.a6937576.js"><link rel="prefetch" href="/ui/assets/js/3.59687fa1.js"><link rel="prefetch" href="/ui/assets/js/30.328e9c48.js"><link rel="prefetch" href="/ui/assets/js/31.cb7914e9.js"><link rel="prefetch" href="/ui/assets/js/32.665882f2.js"><link rel="prefetch" href="/ui/assets/js/33.df108508.js"><link rel="prefetch" href="/ui/assets/js/34.b3c60c46.js"><link rel="prefetch" href="/ui/assets/js/35.29dac2f1.js"><link rel="prefetch" href="/ui/assets/js/36.21d292ef.js"><link rel="prefetch" href="/ui/assets/js/38.fa65c92d.js"><link rel="prefetch" href="/ui/assets/js/39.b67bc959.js"><link rel="prefetch" href="/ui/assets/js/4.7bd9f4a3.js"><link rel="prefetch" href="/ui/assets/js/40.eb2643d2.js"><link rel="prefetch" href="/ui/assets/js/41.9d7f2b1e.js"><link rel="prefetch" href="/ui/assets/js/42.ce9853f2.js"><link rel="prefetch" href="/ui/assets/js/43.ef18b427.js"><link rel="prefetch" href="/ui/assets/js/44.e0ccc5ab.js"><link rel="prefetch" href="/ui/assets/js/45.3b567ceb.js"><link rel="prefetch" href="/ui/assets/js/46.4d5b3c30.js"><link rel="prefetch" href="/ui/assets/js/47.887b39e7.js"><link rel="prefetch" href="/ui/assets/js/48.a3d06fb4.js"><link rel="prefetch" href="/ui/assets/js/49.7627fee6.js"><link rel="prefetch" href="/ui/assets/js/5.483bab38.js"><link rel="prefetch" href="/ui/assets/js/50.abd05e11.js"><link rel="prefetch" href="/ui/assets/js/51.3ec61dab.js"><link rel="prefetch" href="/ui/assets/js/52.2afa38a5.js"><link rel="prefetch" href="/ui/assets/js/53.f77215a0.js"><link rel="prefetch" href="/ui/assets/js/54.683fae75.js"><link rel="prefetch" href="/ui/assets/js/55.8b987b3e.js"><link rel="prefetch" href="/ui/assets/js/56.3403573d.js"><link rel="prefetch" href="/ui/assets/js/57.3a215b4a.js"><link rel="prefetch" href="/ui/assets/js/58.43ef2d75.js"><link rel="prefetch" href="/ui/assets/js/59.dc6b692e.js"><link rel="prefetch" href="/ui/assets/js/6.1cf8dc02.js"><link rel="prefetch" href="/ui/assets/js/60.9121e16b.js"><link rel="prefetch" href="/ui/assets/js/61.fdb5b478.js"><link rel="prefetch" href="/ui/assets/js/62.3852ca62.js"><link rel="prefetch" href="/ui/assets/js/63.17c6de51.js"><link rel="prefetch" href="/ui/assets/js/64.53931fa1.js"><link rel="prefetch" href="/ui/assets/js/65.4a396d1b.js"><link rel="prefetch" href="/ui/assets/js/66.bdab91ca.js"><link rel="prefetch" href="/ui/assets/js/67.c5fc00e6.js"><link rel="prefetch" href="/ui/assets/js/68.8152528b.js"><link rel="prefetch" href="/ui/assets/js/7.b58d6c7e.js"><link rel="prefetch" href="/ui/assets/js/8.24fc59de.js"><link rel="prefetch" href="/ui/assets/js/9.0d2a08b3.js">
<link rel="stylesheet" href="/ui/assets/css/0.styles.f5c7dbec.css">
</head>
<body>
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/ui/" class="home-link router-link-active"><!----> <span class="site-name">polkadot-js/ui</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="https://github.com/polkadot-js/ui" target="_blank" rel="noopener noreferrer" class="nav-link external">
GitHub
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="https://github.com/polkadot-js/ui" target="_blank" rel="noopener noreferrer" class="nav-link external">
GitHub
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav> <ul class="sidebar-links"><li><a href="/ui/ui-identicon/" class="sidebar-link">@polkadot/ui-identicon</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ui/ui-identicon/#usage-examples" class="sidebar-link">Usage Examples</a></li></ul></li><li><a href="/ui/ui-keyring/" class="sidebar-link">@polkadot/ui-keyring</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ui/ui-keyring/#usage-examples" class="sidebar-link">Usage Examples</a></li><li class="sidebar-sub-header"><a href="/ui/ui-keyring/#observables" class="sidebar-link">Observables</a></li><li class="sidebar-sub-header"><a href="/ui/ui-keyring/#faq" class="sidebar-link">FAQ</a></li><li class="sidebar-sub-header"><a href="/ui/ui-keyring/#users" class="sidebar-link">Users</a></li></ul></li><li><a href="/ui/ui-settings/" class="sidebar-link">@polkadot/ui-settings</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ui/ui-settings/#usage-examples" class="sidebar-link">Usage Examples</a></li><li class="sidebar-sub-header"><a href="/ui/ui-settings/#used-by" class="sidebar-link">Used by</a></li></ul></li><li><a href="/ui/ui-util/" class="sidebar-link">@polkadot/ui-util</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ui/ui-util/#formatbalance" class="sidebar-link">formatBalance</a></li><li class="sidebar-sub-header"><a href="/ui/ui-util/#calcsi" class="sidebar-link">calcSi</a></li></ul></li><li><a href="/ui/CONTRIBUTING.html" class="sidebar-link">Contributing</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ui/CONTRIBUTING.html#what" class="sidebar-link">What?</a></li><li class="sidebar-sub-header"><a href="/ui/CONTRIBUTING.html#rules" class="sidebar-link">Rules</a></li><li class="sidebar-sub-header"><a href="/ui/CONTRIBUTING.html#releases" class="sidebar-link">Releases</a></li><li class="sidebar-sub-header"><a href="/ui/CONTRIBUTING.html#changes-to-this-arrangement" class="sidebar-link">Changes to this arrangement</a></li><li class="sidebar-sub-header"><a href="/ui/CONTRIBUTING.html#heritage" class="sidebar-link">Heritage</a></li></ul></li></ul> </aside> <main class="page"> <div class="content default"><h1 id="hierarchy"><a href="#hierarchy" aria-hidden="true" class="header-anchor">#</a> Hierarchy</h1> <p><strong>Base</strong></p> <p>↳ <a href="/ui/ui-keyring/classes/_keyring_.keyring.html">Keyring</a></p> <h1 id="constructors"><a href="#constructors" aria-hidden="true" class="header-anchor">#</a> Constructors</h1> <p><a id="constructor"></a></p> <h2 id="constructor"><a href="#constructor" aria-hidden="true" class="header-anchor">#</a> constructor</h2> <p>⊕ <strong>new Base</strong>(): <a href="/ui/ui-keyring/classes/_base_.base.html" class="router-link-exact-active router-link-active">Base</a></p> <p><em>Defined in <a href="https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L22" target="_blank" rel="noopener noreferrer">Base.ts:22<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></em></p> <p><strong>Returns:</strong> <a href="/ui/ui-keyring/classes/_base_.base.html" class="router-link-exact-active router-link-active">Base</a></p> <hr> <h1 id="accessors"><a href="#accessors" aria-hidden="true" class="header-anchor">#</a> Accessors</h1> <p><a id="accounts"></a></p> <h2 id="accounts"><a href="#accounts" aria-hidden="true" class="header-anchor">#</a> accounts</h2> <p><strong>get accounts</strong>(): <code>object</code></p> <p><em>Defined in <a href="https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L30" target="_blank" rel="noopener noreferrer">Base.ts:30<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></em></p> <p><strong>Returns:</strong> <Line truncated
<script src="/ui/assets/js/app.73634ed0.js" defer></script><script src="/ui/assets/js/2.f00ab508.js" defer></script><script src="/ui/assets/js/37.decf506d.js" defer></script>
</body>
</html>
+191
View File
@@ -0,0 +1,191 @@
# Hierarchy
**Base**
↳ [Keyring](_keyring_.keyring.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Base**(): [Base](_base_.base.md)
*Defined in [Base.ts:22](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L22)*
**Returns:** [Base](_base_.base.md)
___
# Accessors
<a id="accounts"></a>
## accounts
**get accounts**(): `object`
*Defined in [Base.ts:30](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L30)*
**Returns:** `object`
___
<a id="addresses"></a>
## addresses
**get addresses**(): `object`
*Defined in [Base.ts:34](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L34)*
**Returns:** `object`
___
<a id="keyring"></a>
## keyring
**get keyring**(): `KeyringInstance`
*Defined in [Base.ts:38](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L38)*
**Returns:** `KeyringInstance`
___
# Methods
<a id="decodeaddress"></a>
## decodeAddress
▸ **decodeAddress**(key: *`string` \| `Uint8Array`*): `Uint8Array`
*Defined in [Base.ts:46](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L46)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| key | `string` \| `Uint8Array` |
**Returns:** `Uint8Array`
___
<a id="encodeaddress"></a>
## encodeAddress
▸ **encodeAddress**(key: *`string` \| `Uint8Array`*): `string`
*Defined in [Base.ts:50](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L50)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| key | `string` \| `Uint8Array` |
**Returns:** `string`
___
<a id="getpair"></a>
## getPair
▸ **getPair**(address: *`string` \| `Uint8Array`*): `KeyringPair`
*Defined in [Base.ts:54](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L54)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| address | `string` \| `Uint8Array` |
**Returns:** `KeyringPair`
___
<a id="getpairs"></a>
## getPairs
▸ **getPairs**(): `Array`<`KeyringPair`>
*Defined in [Base.ts:58](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L58)*
**Returns:** `Array`<`KeyringPair`>
___
<a id="isavailable"></a>
## isAvailable
▸ **isAvailable**(_address: *`Uint8Array` \| `string`*): `boolean`
*Defined in [Base.ts:64](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L64)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| _address | `Uint8Array` \| `string` |
**Returns:** `boolean`
___
<a id="ispassvalid"></a>
## isPassValid
▸ **isPassValid**(password: *`string`*): `boolean`
*Defined in [Base.ts:74](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L74)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| password | `string` |
**Returns:** `boolean`
___
<a id="setaddressprefix"></a>
## setAddressPrefix
▸ **setAddressPrefix**(prefix: *`number`*): `void`
*Defined in [Base.ts:78](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L78)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| prefix | `number` |
**Returns:** `void`
___
<a id="setdevmode"></a>
## setDevMode
▸ **setDevMode**(isDevelopment: *`boolean`*): `void`
*Defined in [Base.ts:82](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L82)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| isDevelopment | `boolean` |
**Returns:** `void`
___
@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Hierarchy | polkadot-js/ui</title>
<meta name="description" content="UI libraries and utilities in-use accross @polkadot projects">
<link rel="preload" href="/ui/assets/css/0.styles.f5c7dbec.css" as="style"><link rel="preload" href="/ui/assets/js/app.73634ed0.js" as="script"><link rel="preload" href="/ui/assets/js/2.f00ab508.js" as="script"><link rel="preload" href="/ui/assets/js/38.fa65c92d.js" as="script"><link rel="prefetch" href="/ui/assets/js/10.feee2fb6.js"><link rel="prefetch" href="/ui/assets/js/11.4431186e.js"><link rel="prefetch" href="/ui/assets/js/12.60cde7c6.js"><link rel="prefetch" href="/ui/assets/js/13.e8f9b929.js"><link rel="prefetch" href="/ui/assets/js/14.edf23a0c.js"><link rel="prefetch" href="/ui/assets/js/15.6e140e5c.js"><link rel="prefetch" href="/ui/assets/js/16.814a59b4.js"><link rel="prefetch" href="/ui/assets/js/17.4319f57a.js"><link rel="prefetch" href="/ui/assets/js/18.00707b98.js"><link rel="prefetch" href="/ui/assets/js/19.0353e250.js"><link rel="prefetch" href="/ui/assets/js/20.f2154956.js"><link rel="prefetch" href="/ui/assets/js/21.d98322fa.js"><link rel="prefetch" href="/ui/assets/js/22.11f02f68.js"><link rel="prefetch" href="/ui/assets/js/23.7e342d4b.js"><link rel="prefetch" href="/ui/assets/js/24.09820451.js"><link rel="prefetch" href="/ui/assets/js/25.1bd9b377.js"><link rel="prefetch" href="/ui/assets/js/26.7b3990eb.js"><link rel="prefetch" href="/ui/assets/js/27.dd6dd743.js"><link rel="prefetch" href="/ui/assets/js/28.233b0f0a.js"><link rel="prefetch" href="/ui/assets/js/29.a6937576.js"><link rel="prefetch" href="/ui/assets/js/3.59687fa1.js"><link rel="prefetch" href="/ui/assets/js/30.328e9c48.js"><link rel="prefetch" href="/ui/assets/js/31.cb7914e9.js"><link rel="prefetch" href="/ui/assets/js/32.665882f2.js"><link rel="prefetch" href="/ui/assets/js/33.df108508.js"><link rel="prefetch" href="/ui/assets/js/34.b3c60c46.js"><link rel="prefetch" href="/ui/assets/js/35.29dac2f1.js"><link rel="prefetch" href="/ui/assets/js/36.21d292ef.js"><link rel="prefetch" href="/ui/assets/js/37.decf506d.js"><link rel="prefetch" href="/ui/assets/js/39.b67bc959.js"><link rel="prefetch" href="/ui/assets/js/4.7bd9f4a3.js"><link rel="prefetch" href="/ui/assets/js/40.eb2643d2.js"><link rel="prefetch" href="/ui/assets/js/41.9d7f2b1e.js"><link rel="prefetch" href="/ui/assets/js/42.ce9853f2.js"><link rel="prefetch" href="/ui/assets/js/43.ef18b427.js"><link rel="prefetch" href="/ui/assets/js/44.e0ccc5ab.js"><link rel="prefetch" href="/ui/assets/js/45.3b567ceb.js"><link rel="prefetch" href="/ui/assets/js/46.4d5b3c30.js"><link rel="prefetch" href="/ui/assets/js/47.887b39e7.js"><link rel="prefetch" href="/ui/assets/js/48.a3d06fb4.js"><link rel="prefetch" href="/ui/assets/js/49.7627fee6.js"><link rel="prefetch" href="/ui/assets/js/5.483bab38.js"><link rel="prefetch" href="/ui/assets/js/50.abd05e11.js"><link rel="prefetch" href="/ui/assets/js/51.3ec61dab.js"><link rel="prefetch" href="/ui/assets/js/52.2afa38a5.js"><link rel="prefetch" href="/ui/assets/js/53.f77215a0.js"><link rel="prefetch" href="/ui/assets/js/54.683fae75.js"><link rel="prefetch" href="/ui/assets/js/55.8b987b3e.js"><link rel="prefetch" href="/ui/assets/js/56.3403573d.js"><link rel="prefetch" href="/ui/assets/js/57.3a215b4a.js"><link rel="prefetch" href="/ui/assets/js/58.43ef2d75.js"><link rel="prefetch" href="/ui/assets/js/59.dc6b692e.js"><link rel="prefetch" href="/ui/assets/js/6.1cf8dc02.js"><link rel="prefetch" href="/ui/assets/js/60.9121e16b.js"><link rel="prefetch" href="/ui/assets/js/61.fdb5b478.js"><link rel="prefetch" href="/ui/assets/js/62.3852ca62.js"><link rel="prefetch" href="/ui/assets/js/63.17c6de51.js"><link rel="prefetch" href="/ui/assets/js/64.53931fa1.js"><link rel="prefetch" href="/ui/assets/js/65.4a396d1b.js"><link rel="prefetch" href="/ui/assets/js/66.bdab91ca.js"><link rel="prefetch" href="/ui/assets/js/67.c5fc00e6.js"><link rel="prefetch" href="/ui/assets/js/68.8152528b.js"><link rel="prefetch" href="/ui/assets/js/7.b58d6c7e.js"><link rel="prefetch" href="/ui/assets/js/8.24fc59de.js"><link rel="prefetch" href="/ui/assets/js/9.0d2a08b3.js">
<link rel="stylesheet" href="/ui/assets/css/0.styles.f5c7dbec.css">
</head>
<body>
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/ui/" class="home-link router-link-active"><!----> <span class="site-name">polkadot-js/ui</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="https://github.com/polkadot-js/ui" target="_blank" rel="noopener noreferrer" class="nav-link external">
GitHub
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="https://github.com/polkadot-js/ui" target="_blank" rel="noopener noreferrer" class="nav-link external">
GitHub
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav> <ul class="sidebar-links"><li><a href="/ui/ui-identicon/" class="sidebar-link">@polkadot/ui-identicon</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ui/ui-identicon/#usage-examples" class="sidebar-link">Usage Examples</a></li></ul></li><li><a href="/ui/ui-keyring/" class="sidebar-link">@polkadot/ui-keyring</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ui/ui-keyring/#usage-examples" class="sidebar-link">Usage Examples</a></li><li class="sidebar-sub-header"><a href="/ui/ui-keyring/#observables" class="sidebar-link">Observables</a></li><li class="sidebar-sub-header"><a href="/ui/ui-keyring/#faq" class="sidebar-link">FAQ</a></li><li class="sidebar-sub-header"><a href="/ui/ui-keyring/#users" class="sidebar-link">Users</a></li></ul></li><li><a href="/ui/ui-settings/" class="sidebar-link">@polkadot/ui-settings</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ui/ui-settings/#usage-examples" class="sidebar-link">Usage Examples</a></li><li class="sidebar-sub-header"><a href="/ui/ui-settings/#used-by" class="sidebar-link">Used by</a></li></ul></li><li><a href="/ui/ui-util/" class="sidebar-link">@polkadot/ui-util</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ui/ui-util/#formatbalance" class="sidebar-link">formatBalance</a></li><li class="sidebar-sub-header"><a href="/ui/ui-util/#calcsi" class="sidebar-link">calcSi</a></li></ul></li><li><a href="/ui/CONTRIBUTING.html" class="sidebar-link">Contributing</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ui/CONTRIBUTING.html#what" class="sidebar-link">What?</a></li><li class="sidebar-sub-header"><a href="/ui/CONTRIBUTING.html#rules" class="sidebar-link">Rules</a></li><li class="sidebar-sub-header"><a href="/ui/CONTRIBUTING.html#releases" class="sidebar-link">Releases</a></li><li class="sidebar-sub-header"><a href="/ui/CONTRIBUTING.html#changes-to-this-arrangement" class="sidebar-link">Changes to this arrangement</a></li><li class="sidebar-sub-header"><a href="/ui/CONTRIBUTING.html#heritage" class="sidebar-link">Heritage</a></li></ul></li></ul> </aside> <main class="page"> <div class="content default"><h1 id="hierarchy"><a href="#hierarchy" aria-hidden="true" class="header-anchor">#</a> Hierarchy</h1> <p><a href="/ui/ui-keyring/classes/_base_.base.html">Base</a></p> <p><strong>↳ Keyring</strong></p> <h1 id="implements"><a href="#implements" aria-hidden="true" class="header-anchor">#</a> Implements</h1> <ul><li><a href="/ui/ui-keyring/interfaces/_types_.keyringstruct.html">KeyringStruct</a></li></ul> <h1 id="constructors"><a href="#constructors" aria-hidden="true" class="header-anchor">#</a> Constructors</h1> <p><a id="constructor"></a></p> <h2 id="constructor"><a href="#constructor" aria-hidden="true" class="header-anchor">#</a> constructor</h2> <p>⊕ <strong>new Keyring</strong>(): <a href="/ui/ui-keyring/classes/_keyring_.keyring.html" class="router-link-exact-active router-link-active">Keyring</a></p> <p><em>Inherited from <a href="/ui/ui-keyring/classes/_base_.base.html">Base</a>.<a href="/ui/ui-keyring/classes/_base_.base.html#constructor">constructor</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L22" target="_blank" rel="noopener noreferrer">Base.ts:22<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></em></p> <p><strong>Returns:</strong> <a href="/ui/ui-keyring/classes/_keyring_.keyring.html" class="router-link-exact-active router-link-active">Keyring</a></p> <hr> <h1 id="accessors"><a href="#accessors" aria-hidden="true" class="header-anchor">#</a> Accessors</h1> <p><a id="accounts"></a></p> <h2 id="accounts"><a href="#accounts" aria-hidden="true" class="header-anchor">#</a> accounts</h2> <p><strong>get accounts</strong>(): <code>object</code></p> <p><em>Inherited from <a href="/ui/ui-keyring/classes/_base_.base.html">Base</a>.<a href="/ui/ui-keyring/classes/_base_.base.html#accounts">accounts</a></em></p> <p><em>Defined in <a href="https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/BaLine truncated
<script src="/ui/assets/js/app.73634ed0.js" defer></script><script src="/ui/assets/js/2.f00ab508.js" defer></script><script src="/ui/assets/js/38.fa65c92d.js" defer></script>
</body>
</html>
@@ -0,0 +1,526 @@
# Hierarchy
[Base](_base_.base.md)
**↳ Keyring**
# Implements
* [KeyringStruct](../interfaces/_types_.keyringstruct.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Keyring**(): [Keyring](_keyring_.keyring.md)
*Inherited from [Base](_base_.base.md).[constructor](_base_.base.md#constructor)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L22)*
**Returns:** [Keyring](_keyring_.keyring.md)
___
# Accessors
<a id="accounts"></a>
## accounts
**get accounts**(): `object`
*Inherited from [Base](_base_.base.md).[accounts](_base_.base.md#accounts)*
*Defined in [Base.ts:30](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L30)*
**Returns:** `object`
___
<a id="addresses"></a>
## addresses
**get addresses**(): `object`
*Inherited from [Base](_base_.base.md).[addresses](_base_.base.md#addresses)*
*Defined in [Base.ts:34](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L34)*
**Returns:** `object`
___
<a id="keyring"></a>
## keyring
**get keyring**(): `KeyringInstance`
*Inherited from [Base](_base_.base.md).[keyring](_base_.base.md#keyring)*
*Defined in [Base.ts:38](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L38)*
**Returns:** `KeyringInstance`
___
# Methods
<a id="addaccountpair"></a>
## addAccountPair
▸ **addAccountPair**(pair: *`KeyringPair`*, password: *`string`*): `KeyringPair`
*Defined in [Keyring.ts:22](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L22)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| pair | `KeyringPair` |
| password | `string` |
**Returns:** `KeyringPair`
___
<a id="backupaccount"></a>
## backupAccount
▸ **backupAccount**(pair: *`KeyringPair`*, password: *`string`*): `KeyringPair$Json`
*Defined in [Keyring.ts:29](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L29)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| pair | `KeyringPair` |
| password | `string` |
**Returns:** `KeyringPair$Json`
___
<a id="createaccount"></a>
## createAccount
▸ **createAccount**(seed: *`Uint8Array`*, password?: *`undefined` \| `string`*, meta?: *`KeyringPair$Meta`*): `KeyringPair`
*Defined in [Keyring.ts:39](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L39)*
**Parameters:**
| Name | Type | Default value |
| ------ | ------ | ------ |
| seed | `Uint8Array` | - |
| `Optional` password | `undefined` \| `string` | - |
| `Default value` meta | `KeyringPair$Meta` | {} |
**Returns:** `KeyringPair`
___
<a id="createaccountexternal"></a>
## createAccountExternal
▸ **createAccountExternal**(publicKey: *`Uint8Array`*, meta?: *`KeyringPair$Meta`*): `KeyringPair`
*Defined in [Keyring.ts:47](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L47)*
**Parameters:**
| Name | Type | Default value |
| ------ | ------ | ------ |
| publicKey | `Uint8Array` | - |
| `Default value` meta | `KeyringPair$Meta` | {} |
**Returns:** `KeyringPair`
___
<a id="createaccountmnemonic"></a>
## createAccountMnemonic
▸ **createAccountMnemonic**(seed: *`string`*, password?: *`undefined` \| `string`*, meta?: *`KeyringPair$Meta`*): `KeyringPair`
*Defined in [Keyring.ts:55](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L55)*
**Parameters:**
| Name | Type | Default value |
| ------ | ------ | ------ |
| seed | `string` | - |
| `Optional` password | `undefined` \| `string` | - |
| `Default value` meta | `KeyringPair$Meta` | {} |
**Returns:** `KeyringPair`
___
<a id="decodeaddress"></a>
## decodeAddress
▸ **decodeAddress**(key: *`string` \| `Uint8Array`*): `Uint8Array`
*Inherited from [Base](_base_.base.md).[decodeAddress](_base_.base.md#decodeaddress)*
*Defined in [Base.ts:46](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L46)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| key | `string` \| `Uint8Array` |
**Returns:** `Uint8Array`
___
<a id="encodeaddress"></a>
## encodeAddress
▸ **encodeAddress**(key: *`string` \| `Uint8Array`*): `string`
*Inherited from [Base](_base_.base.md).[encodeAddress](_base_.base.md#encodeaddress)*
*Defined in [Base.ts:50](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L50)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| key | `string` \| `Uint8Array` |
**Returns:** `string`
___
<a id="encryptaccount"></a>
## encryptAccount
▸ **encryptAccount**(pair: *`KeyringPair`*, password: *`string`*): `void`
*Defined in [Keyring.ts:63](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L63)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| pair | `KeyringPair` |
| password | `string` |
**Returns:** `void`
___
<a id="forgetaccount"></a>
## forgetAccount
▸ **forgetAccount**(address: *`string`*): `void`
*Defined in [Keyring.ts:72](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L72)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| address | `string` |
**Returns:** `void`
___
<a id="forgetaddress"></a>
## forgetAddress
▸ **forgetAddress**(address: *`string`*): `void`
*Defined in [Keyring.ts:77](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L77)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| address | `string` |
**Returns:** `void`
___
<a id="getaccount"></a>
## getAccount
▸ **getAccount**(address: *`string` \| `Uint8Array`*): [KeyringAddress](../modules/_types_.md#keyringaddress)
*Defined in [Keyring.ts:81](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L81)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| address | `string` \| `Uint8Array` |
**Returns:** [KeyringAddress](../modules/_types_.md#keyringaddress)
___
<a id="getaccounts"></a>
## getAccounts
▸ **getAccounts**(): `Array`<[KeyringAddress](../modules/_types_.md#keyringaddress)>
*Defined in [Keyring.ts:85](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L85)*
**Returns:** `Array`<[KeyringAddress](../modules/_types_.md#keyringaddress)>
___
<a id="getaddress"></a>
## getAddress
▸ **getAddress**(_address: *`string` \| `Uint8Array`*, type?: *"account" \| "address"*): [KeyringAddress](../modules/_types_.md#keyringaddress)
*Defined in [Keyring.ts:94](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L94)*
**Parameters:**
| Name | Type | Default value |
| ------ | ------ | ------ |
| _address | `string` \| `Uint8Array` | - |
| `Default value` type | "account" \| "address" | &quot;address&quot; |
**Returns:** [KeyringAddress](../modules/_types_.md#keyringaddress)
___
<a id="getaddresses"></a>
## getAddresses
▸ **getAddresses**(): `Array`<[KeyringAddress](../modules/_types_.md#keyringaddress)>
*Defined in [Keyring.ts:115](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L115)*
**Returns:** `Array`<[KeyringAddress](../modules/_types_.md#keyringaddress)>
___
<a id="getpair"></a>
## getPair
▸ **getPair**(address: *`string` \| `Uint8Array`*): `KeyringPair`
*Inherited from [Base](_base_.base.md).[getPair](_base_.base.md#getpair)*
*Defined in [Base.ts:54](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L54)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| address | `string` \| `Uint8Array` |
**Returns:** `KeyringPair`
___
<a id="getpairs"></a>
## getPairs
▸ **getPairs**(): `Array`<`KeyringPair`>
*Inherited from [Base](_base_.base.md).[getPairs](_base_.base.md#getpairs)*
*Defined in [Base.ts:58](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L58)*
**Returns:** `Array`<`KeyringPair`>
___
<a id="isavailable"></a>
## isAvailable
▸ **isAvailable**(_address: *`Uint8Array` \| `string`*): `boolean`
*Inherited from [Base](_base_.base.md).[isAvailable](_base_.base.md#isavailable)*
*Defined in [Base.ts:64](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L64)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| _address | `Uint8Array` \| `string` |
**Returns:** `boolean`
___
<a id="ispassvalid"></a>
## isPassValid
▸ **isPassValid**(password: *`string`*): `boolean`
*Inherited from [Base](_base_.base.md).[isPassValid](_base_.base.md#ispassvalid)*
*Defined in [Base.ts:74](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L74)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| password | `string` |
**Returns:** `boolean`
___
<a id="loadall"></a>
## loadAll
▸ **loadAll**(options: *[KeyringOptions](../modules/_types_.md#keyringoptions)*): `void`
*Defined in [Keyring.ts:156](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L156)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| options | [KeyringOptions](../modules/_types_.md#keyringoptions) |
**Returns:** `void`
___
<a id="restoreaccount"></a>
## restoreAccount
▸ **restoreAccount**(json: *`KeyringPair$Json`*, password: *`string`*): `KeyringPair`
*Defined in [Keyring.ts:170](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L170)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| json | `KeyringPair$Json` |
| password | `string` |
**Returns:** `KeyringPair`
___
<a id="saveaccount"></a>
## saveAccount
▸ **saveAccount**(pair: *`KeyringPair`*, password?: *`undefined` \| `string`*): `void`
*Defined in [Keyring.ts:188](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L188)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| pair | `KeyringPair` |
| `Optional` password | `undefined` \| `string` |
**Returns:** `void`
___
<a id="saveaccountmeta"></a>
## saveAccountMeta
▸ **saveAccountMeta**(pair: *`KeyringPair`*, meta: *`KeyringPair$Meta`*): `void`
*Defined in [Keyring.ts:197](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L197)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| pair | `KeyringPair` |
| meta | `KeyringPair$Meta` |
**Returns:** `void`
___
<a id="saveaddress"></a>
## saveAddress
▸ **saveAddress**(address: *`string`*, meta: *`KeyringPair$Meta`*): `void`
*Defined in [Keyring.ts:207](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L207)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| address | `string` |
| meta | `KeyringPair$Meta` |
**Returns:** `void`
___
<a id="saverecent"></a>
## saveRecent
▸ **saveRecent**(address: *`string`*): [SingleAddress](../modules/_observable_types_.md#singleaddress)
*Defined in [Keyring.ts:227](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L227)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| address | `string` |
**Returns:** [SingleAddress](../modules/_observable_types_.md#singleaddress)
___
<a id="setaddressprefix"></a>
## setAddressPrefix
▸ **setAddressPrefix**(prefix: *`number`*): `void`
*Inherited from [Base](_base_.base.md).[setAddressPrefix](_base_.base.md#setaddressprefix)*
*Defined in [Base.ts:78](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L78)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| prefix | `number` |
**Returns:** `void`
___
<a id="setdevmode"></a>
## setDevMode
▸ **setDevMode**(isDevelopment: *`boolean`*): `void`
*Inherited from [Base](_base_.base.md).[setDevMode](_base_.base.md#setdevmode)*
*Defined in [Base.ts:82](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L82)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| isDevelopment | `boolean` |
**Returns:** `void`
___
@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Type parameters | polkadot-js/ui</title>
<meta name="description" content="UI libraries and utilities in-use accross @polkadot projects">
<link rel="preload" href="/ui/assets/css/0.styles.f5c7dbec.css" as="style"><link rel="preload" href="/ui/assets/js/app.73634ed0.js" as="script"><link rel="preload" href="/ui/assets/js/2.f00ab508.js" as="script"><link rel="preload" href="/ui/assets/js/39.b67bc959.js" as="script"><link rel="prefetch" href="/ui/assets/js/10.feee2fb6.js"><link rel="prefetch" href="/ui/assets/js/11.4431186e.js"><link rel="prefetch" href="/ui/assets/js/12.60cde7c6.js"><link rel="prefetch" href="/ui/assets/js/13.e8f9b929.js"><link rel="prefetch" href="/ui/assets/js/14.edf23a0c.js"><link rel="prefetch" href="/ui/assets/js/15.6e140e5c.js"><link rel="prefetch" href="/ui/assets/js/16.814a59b4.js"><link rel="prefetch" href="/ui/assets/js/17.4319f57a.js"><link rel="prefetch" href="/ui/assets/js/18.00707b98.js"><link rel="prefetch" href="/ui/assets/js/19.0353e250.js"><link rel="prefetch" href="/ui/assets/js/20.f2154956.js"><link rel="prefetch" href="/ui/assets/js/21.d98322fa.js"><link rel="prefetch" href="/ui/assets/js/22.11f02f68.js"><link rel="prefetch" href="/ui/assets/js/23.7e342d4b.js"><link rel="prefetch" href="/ui/assets/js/24.09820451.js"><link rel="prefetch" href="/ui/assets/js/25.1bd9b377.js"><link rel="prefetch" href="/ui/assets/js/26.7b3990eb.js"><link rel="prefetch" href="/ui/assets/js/27.dd6dd743.js"><link rel="prefetch" href="/ui/assets/js/28.233b0f0a.js"><link rel="prefetch" href="/ui/assets/js/29.a6937576.js"><link rel="prefetch" href="/ui/assets/js/3.59687fa1.js"><link rel="prefetch" href="/ui/assets/js/30.328e9c48.js"><link rel="prefetch" href="/ui/assets/js/31.cb7914e9.js"><link rel="prefetch" href="/ui/assets/js/32.665882f2.js"><link rel="prefetch" href="/ui/assets/js/33.df108508.js"><link rel="prefetch" href="/ui/assets/js/34.b3c60c46.js"><link rel="prefetch" href="/ui/assets/js/35.29dac2f1.js"><link rel="prefetch" href="/ui/assets/js/36.21d292ef.js"><link rel="prefetch" href="/ui/assets/js/37.decf506d.js"><link rel="prefetch" href="/ui/assets/js/38.fa65c92d.js"><link rel="prefetch" href="/ui/assets/js/4.7bd9f4a3.js"><link rel="prefetch" href="/ui/assets/js/40.eb2643d2.js"><link rel="prefetch" href="/ui/assets/js/41.9d7f2b1e.js"><link rel="prefetch" href="/ui/assets/js/42.ce9853f2.js"><link rel="prefetch" href="/ui/assets/js/43.ef18b427.js"><link rel="prefetch" href="/ui/assets/js/44.e0ccc5ab.js"><link rel="prefetch" href="/ui/assets/js/45.3b567ceb.js"><link rel="prefetch" href="/ui/assets/js/46.4d5b3c30.js"><link rel="prefetch" href="/ui/assets/js/47.887b39e7.js"><link rel="prefetch" href="/ui/assets/js/48.a3d06fb4.js"><link rel="prefetch" href="/ui/assets/js/49.7627fee6.js"><link rel="prefetch" href="/ui/assets/js/5.483bab38.js"><link rel="prefetch" href="/ui/assets/js/50.abd05e11.js"><link rel="prefetch" href="/ui/assets/js/51.3ec61dab.js"><link rel="prefetch" href="/ui/assets/js/52.2afa38a5.js"><link rel="prefetch" href="/ui/assets/js/53.f77215a0.js"><link rel="prefetch" href="/ui/assets/js/54.683fae75.js"><link rel="prefetch" href="/ui/assets/js/55.8b987b3e.js"><link rel="prefetch" href="/ui/assets/js/56.3403573d.js"><link rel="prefetch" href="/ui/assets/js/57.3a215b4a.js"><link rel="prefetch" href="/ui/assets/js/58.43ef2d75.js"><link rel="prefetch" href="/ui/assets/js/59.dc6b692e.js"><link rel="prefetch" href="/ui/assets/js/6.1cf8dc02.js"><link rel="prefetch" href="/ui/assets/js/60.9121e16b.js"><link rel="prefetch" href="/ui/assets/js/61.fdb5b478.js"><link rel="prefetch" href="/ui/assets/js/62.3852ca62.js"><link rel="prefetch" href="/ui/assets/js/63.17c6de51.js"><link rel="prefetch" href="/ui/assets/js/64.53931fa1.js"><link rel="prefetch" href="/ui/assets/js/65.4a396d1b.js"><link rel="prefetch" href="/ui/assets/js/66.bdab91ca.js"><link rel="prefetch" href="/ui/assets/js/67.c5fc00e6.js"><link rel="prefetch" href="/ui/assets/js/68.8152528b.js"><link rel="prefetch" href="/ui/assets/js/7.b58d6c7e.js"><link rel="prefetch" href="/ui/assets/js/8.24fc59de.js"><link rel="prefetch" href="/ui/assets/js/9.0d2a08b3.js">
<link rel="stylesheet" href="/ui/assets/css/0.styles.f5c7dbec.css">
</head>
<body>
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/ui/" class="home-link router-link-active"><!----> <span class="site-name">polkadot-js/ui</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="https://github.com/polkadot-js/ui" target="_blank" rel="noopener noreferrer" class="nav-link external">
GitHub
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="https://github.com/polkadot-js/ui" target="_blank" rel="noopener noreferrer" class="nav-link external">
GitHub
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav> <ul class="sidebar-links"><li><a href="/ui/ui-identicon/" class="sidebar-link">@polkadot/ui-identicon</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ui/ui-identicon/#usage-examples" class="sidebar-link">Usage Examples</a></li></ul></li><li><a href="/ui/ui-keyring/" class="sidebar-link">@polkadot/ui-keyring</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ui/ui-keyring/#usage-examples" class="sidebar-link">Usage Examples</a></li><li class="sidebar-sub-header"><a href="/ui/ui-keyring/#observables" class="sidebar-link">Observables</a></li><li class="sidebar-sub-header"><a href="/ui/ui-keyring/#faq" class="sidebar-link">FAQ</a></li><li class="sidebar-sub-header"><a href="/ui/ui-keyring/#users" class="sidebar-link">Users</a></li></ul></li><li><a href="/ui/ui-settings/" class="sidebar-link">@polkadot/ui-settings</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ui/ui-settings/#usage-examples" class="sidebar-link">Usage Examples</a></li><li class="sidebar-sub-header"><a href="/ui/ui-settings/#used-by" class="sidebar-link">Used by</a></li></ul></li><li><a href="/ui/ui-util/" class="sidebar-link">@polkadot/ui-util</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ui/ui-util/#formatbalance" class="sidebar-link">formatBalance</a></li><li class="sidebar-sub-header"><a href="/ui/ui-util/#calcsi" class="sidebar-link">calcSi</a></li></ul></li><li><a href="/ui/CONTRIBUTING.html" class="sidebar-link">Contributing</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ui/CONTRIBUTING.html#what" class="sidebar-link">What?</a></li><li class="sidebar-sub-header"><a href="/ui/CONTRIBUTING.html#rules" class="sidebar-link">Rules</a></li><li class="sidebar-sub-header"><a href="/ui/CONTRIBUTING.html#releases" class="sidebar-link">Releases</a></li><li class="sidebar-sub-header"><a href="/ui/CONTRIBUTING.html#changes-to-this-arrangement" class="sidebar-link">Changes to this arrangement</a></li><li class="sidebar-sub-header"><a href="/ui/CONTRIBUTING.html#heritage" class="sidebar-link">Heritage</a></li></ul></li></ul> </aside> <main class="page"> <div class="content default"><h1 id="type-parameters"><a href="#type-parameters" aria-hidden="true" class="header-anchor">#</a> Type parameters</h1> <h4 id="s"><a href="#s" aria-hidden="true" class="header-anchor">#</a> S</h4> <h4 id="ss"><a href="#ss" aria-hidden="true" class="header-anchor">#</a> SS</h4> <h1 id="hierarchy"><a href="#hierarchy" aria-hidden="true" class="header-anchor">#</a> Hierarchy</h1> <p><code>PureComponent</code>&lt;<code>Props</code>&gt;</p> <p><strong>↳ KeyPair</strong></p> <h1 id="methods"><a href="#methods" aria-hidden="true" class="header-anchor">#</a> Methods</h1> <p><a id="unsafe_componentwillmount"></a></p> <h2 id="optional-unsafe-componentwillmount"><a href="#optional-unsafe-componentwillmount" aria-hidden="true" class="header-anchor">#</a> <code>&lt;Optional&gt;</code> UNSAFE_componentWillMount</h2> <p>▸ <strong>UNSAFE_componentWillMount</strong>(): <code>void</code></p> <p><em>Inherited from DeprecatedLifecycle.UNSAFE_componentWillMount</em></p> <p><em>Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:613</em></p> <p>Called immediately before mounting occurs, and before <code>Component#render</code>. Avoid introducing any side-effects or subscriptions in this method.</p> <p>This method will not stop working in React 17.</p> <p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.</p> <p><em><strong>deprecated</strong></em>: 16.3, use componentDidMount or the constructor instead</p> <p><em><strong>see</strong></em>: <a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state" target="_blank" rel="noopener noreferrer">https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></p> <p><em><strong>see</strong></em>: <a href="https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gLine truncated
<script src="/ui/assets/js/app.73634ed0.js" defer></script><script src="/ui/assets/js/2.f00ab508.js" defer></script><script src="/ui/assets/js/39.b67bc959.js" defer></script>
</body>
</html>
@@ -0,0 +1,335 @@
# Type parameters
#### S
#### SS
# Hierarchy
`PureComponent`<`Props`>
**↳ KeyPair**
# Methods
<a id="unsafe_componentwillmount"></a>
## `<Optional>` UNSAFE_componentWillMount
▸ **UNSAFE_componentWillMount**(): `void`
*Inherited from DeprecatedLifecycle.UNSAFE_componentWillMount*
*Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:613*
Called immediately before mounting occurs, and before `Component#render`. Avoid introducing any side-effects or subscriptions in this method.
This method will not stop working in React 17.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
*__deprecated__*: 16.3, use componentDidMount or the constructor instead
*__see__*: [https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state](https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state)
*__see__*: [https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path](https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path)
**Returns:** `void`
___
<a id="unsafe_componentwillreceiveprops"></a>
## `<Optional>` UNSAFE_componentWillReceiveProps
▸ **UNSAFE_componentWillReceiveProps**(nextProps: *`Readonly`<`Props`>*, nextContext: *`any`*): `void`
*Inherited from DeprecatedLifecycle.UNSAFE_componentWillReceiveProps*
*Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:645*
Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.
Calling `Component#setState` generally does not trigger this method.
This method will not stop working in React 17.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
*__deprecated__*: 16.3, use static getDerivedStateFromProps instead
*__see__*: [https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props](https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props)
*__see__*: [https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path](https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path)
**Parameters:**
| Name | Type |
| ------ | ------ |
| nextProps | `Readonly`<`Props`> |
| nextContext | `any` |
**Returns:** `void`
___
<a id="unsafe_componentwillupdate"></a>
## `<Optional>` UNSAFE_componentWillUpdate
▸ **UNSAFE_componentWillUpdate**(nextProps: *`Readonly`<`Props`>*, nextState: *`Readonly`<`S`>*, nextContext: *`any`*): `void`
*Inherited from DeprecatedLifecycle.UNSAFE_componentWillUpdate*
*Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:673*
Called immediately before rendering when new props or state is received. Not called for the initial render.
Note: You cannot call `Component#setState` here.
This method will not stop working in React 17.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
*__deprecated__*: 16.3, use getSnapshotBeforeUpdate instead
*__see__*: [https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update](https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update)
*__see__*: [https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path](https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path)
**Parameters:**
| Name | Type |
| ------ | ------ |
| nextProps | `Readonly`<`Props`> |
| nextState | `Readonly`<`S`> |
| nextContext | `any` |
**Returns:** `void`
___
<a id="componentdidcatch"></a>
## `<Optional>` componentDidCatch
▸ **componentDidCatch**(error: *`Error`*, errorInfo: *`ErrorInfo`*): `void`
*Inherited from ComponentLifecycle.componentDidCatch*
*Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:542*
Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.
**Parameters:**
| Name | Type |
| ------ | ------ |
| error | `Error` |
| errorInfo | `ErrorInfo` |
**Returns:** `void`
___
<a id="componentdidmount"></a>
## `<Optional>` componentDidMount
▸ **componentDidMount**(): `void`
*Inherited from ComponentLifecycle.componentDidMount*
*Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:521*
Called immediately after a component is mounted. Setting state here will trigger re-rendering.
**Returns:** `void`
___
<a id="componentdidupdate"></a>
## `<Optional>` componentDidUpdate
▸ **componentDidUpdate**(prevProps: *`Readonly`<`Props`>*, prevState: *`Readonly`<`S`>*, snapshot?: *[SS]()*): `void`
*Inherited from NewLifecycle.componentDidUpdate*
*Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:584*
Called immediately after updating occurs. Not called for the initial render.
The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.
**Parameters:**
| Name | Type |
| ------ | ------ |
| prevProps | `Readonly`<`Props`> |
| prevState | `Readonly`<`S`> |
| `Optional` snapshot | [SS]() |
**Returns:** `void`
___
<a id="componentwillmount"></a>
## `<Optional>` componentWillMount
▸ **componentWillMount**(): `void`
*Inherited from DeprecatedLifecycle.componentWillMount*
*Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:599*
Called immediately before mounting occurs, and before `Component#render`. Avoid introducing any side-effects or subscriptions in this method.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
*__deprecated__*: 16.3, use componentDidMount or the constructor instead; will stop working in React 17
*__see__*: [https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state](https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state)
*__see__*: [https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path](https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path)
**Returns:** `void`
___
<a id="componentwillreceiveprops"></a>
## `<Optional>` componentWillReceiveProps
▸ **componentWillReceiveProps**(nextProps: *`Readonly`<`Props`>*, nextContext: *`any`*): `void`
*Inherited from DeprecatedLifecycle.componentWillReceiveProps*
*Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:628*
Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.
Calling `Component#setState` generally does not trigger this method.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
*__deprecated__*: 16.3, use static getDerivedStateFromProps instead; will stop working in React 17
*__see__*: [https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props](https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props)
*__see__*: [https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path](https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path)
**Parameters:**
| Name | Type |
| ------ | ------ |
| nextProps | `Readonly`<`Props`> |
| nextContext | `any` |
**Returns:** `void`
___
<a id="componentwillunmount"></a>
## `<Optional>` componentWillUnmount
▸ **componentWillUnmount**(): `void`
*Inherited from ComponentLifecycle.componentWillUnmount*
*Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:537*
Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in `componentDidMount`.
**Returns:** `void`
___
<a id="componentwillupdate"></a>
## `<Optional>` componentWillUpdate
▸ **componentWillUpdate**(nextProps: *`Readonly`<`Props`>*, nextState: *`Readonly`<`S`>*, nextContext: *`any`*): `void`
*Inherited from DeprecatedLifecycle.componentWillUpdate*
*Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:658*
Called immediately before rendering when new props or state is received. Not called for the initial render.
Note: You cannot call `Component#setState` here.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
*__deprecated__*: 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17
*__see__*: [https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update](https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update)
*__see__*: [https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path](https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path)
**Parameters:**
| Name | Type |
| ------ | ------ |
| nextProps | `Readonly`<`Props`> |
| nextState | `Readonly`<`S`> |
| nextContext | `any` |
**Returns:** `void`
___
<a id="getsnapshotbeforeupdate"></a>
## `<Optional>` getSnapshotBeforeUpdate
▸ **getSnapshotBeforeUpdate**(prevProps: *`Readonly`<`Props`>*, prevState: *`Readonly`<`S`>*): `SS` \| `null`
*Inherited from NewLifecycle.getSnapshotBeforeUpdate*
*Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:578*
Runs before React applies the result of `render` to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before `render` causes changes to it.
Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.
**Parameters:**
| Name | Type |
| ------ | ------ |
| prevProps | `Readonly`<`Props`> |
| prevState | `Readonly`<`S`> |
**Returns:** `SS` \| `null`
___
<a id="render"></a>
## render
▸ **render**(): `Element`
*Defined in [options/KeyPair.tsx:53](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/options/KeyPair.tsx#L53)*
**Returns:** `Element`
___
<a id="shouldcomponentupdate"></a>
## `<Optional>` shouldComponentUpdate
▸ **shouldComponentUpdate**(nextProps: *`Readonly`<`Props`>*, nextState: *`Readonly`<`S`>*, nextContext: *`any`*): `boolean`
*Inherited from ComponentLifecycle.shouldComponentUpdate*
*Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:532*
Called to determine whether the change in props and state should trigger a re-render.
`Component` always returns true. `PureComponent` implements a shallow comparison on props and state and returns true if any props or states have changed.
If false is returned, `Component#render`, `componentWillUpdate` and `componentDidUpdate` will not be called.
**Parameters:**
| Name | Type |
| ------ | ------ |
| nextProps | `Readonly`<`Props`> |
| nextState | `Readonly`<`S`> |
| nextContext | `any` |
**Returns:** `boolean`
___