diff --git a/docs/404.html b/docs/404.html new file mode 100644 index 00000000..39b422cf --- /dev/null +++ b/docs/404.html @@ -0,0 +1,17 @@ + + + + + + polkadot-js/ui + + + + + + + +

404

How did we get here?
Take me home.
+ + + diff --git a/docs/CONTRIBUTING.html b/docs/CONTRIBUTING.html new file mode 100644 index 00000000..e361ddcb --- /dev/null +++ b/docs/CONTRIBUTING.html @@ -0,0 +1,26 @@ + + + + + + Contributing | polkadot-js/ui + + + + + + + +
polkadot-js/ui

Contributing

What?

Individuals making significant and valuable contributions are given commit-access to a project to contribute as they see fit. +A project is more like an open wiki than a standard guarded open source project.

Rules

There are a few basic ground-rules for contributors (including the maintainer(s) of the project):

  1. No --force pushes or modifying the Git history in any way. If you need to rebase, ensure you do it in your own repo.
  2. Non-master branches, prefixed with a short name moniker (e.g. <initials>-<feature>) must be used for ongoing work.
  3. All modifications must be made in a pull-request to solicit feedback from other contributors.
  4. A pull-request must not be merged until CI has finished successfully.

Merging pull requests once CI is successful:

  • A pull request with no large change to logic that is an urgent fix may be merged after a non-author contributor has reviewed it well.
  • No PR should be merged until all reviews' comments are addressed.

Reviewing pull requests:

When reviewing a pull request, the end-goal is to suggest useful changes to the author. Reviews should finish with approval unless there are issues that would result in:

  • Buggy behaviour.
  • Undue maintenance burden.
  • Breaking with house coding style.
  • Pessimisation (i.e. reduction of speed as measured in the projects benchmarks).
  • Feature reduction (i.e. it removes some aspect of functionality that a significant minority of users rely on).
  • Uselessness (i.e. it does not strictly add a feature or fix a known issue).

Reviews may not be used as an effective veto for a PR because:

  • There exists a somewhat cleaner/better/faster way of accomplishing the same feature/fix.
  • It does not fit well with some other contributors' longer-term vision for the project.

Releases

Declaring formal releases remains the prerogative of the project maintainer(s).

Changes to this arrangement

This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change.

Heritage

These contributing guidelines are modified from the "OPEN Open Source Project" guidelines for the Level project: https://github.com/Level/community/blob/master/CONTRIBUTING.md

Last Updated: 2/27/2019, 10:18:35 AM

+ ← +

+ + + diff --git a/docs/assets/css/0.styles.f5c7dbec.css b/docs/assets/css/0.styles.f5c7dbec.css new file mode 100644 index 00000000..10894da5 --- /dev/null +++ b/docs/assets/css/0.styles.f5c7dbec.css @@ -0,0 +1 @@ +#nprogress{pointer-events:none}#nprogress .bar{background:#fd8824;position:fixed;z-index:1031;top:0;left:0;width:100%;height:2px}#nprogress .peg{display:block;position:absolute;right:0;width:100px;height:100%;-webkit-box-shadow:0 0 10px #fd8824,0 0 5px #fd8824;box-shadow:0 0 10px #fd8824,0 0 5px #fd8824;opacity:1;-webkit-transform:rotate(3deg) translateY(-4px);transform:rotate(3deg) translateY(-4px)}#nprogress .spinner{display:block;position:fixed;z-index:1031;top:15px;right:15px}#nprogress .spinner-icon{width:18px;height:18px;-webkit-box-sizing:border-box;box-sizing:border-box;border:2px solid transparent;border-top-color:#fd8824;border-left-color:#fd8824;border-radius:50%;-webkit-animation:nprogress-spinner .4s linear infinite;animation:nprogress-spinner .4s linear infinite}.nprogress-custom-parent{overflow:hidden;position:relative}.nprogress-custom-parent #nprogress .bar,.nprogress-custom-parent #nprogress .spinner{position:absolute}@-webkit-keyframes nprogress-spinner{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(1turn);transform:rotate(1turn)}}@keyframes nprogress-spinner{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(1turn);transform:rotate(1turn)}}.icon.outbound{color:#aaa;display:inline-block}.home{padding:3.6rem 2rem 0;max-width:960px;margin:0 auto;display:block}.home .hero{text-align:center}.home .hero img{max-width:100%;max-height:280px;display:block;margin:3rem auto 1.5rem}.home .hero h1{font-size:3rem}.home .hero .action,.home .hero .description,.home .hero h1{margin:1.8rem auto}.home .hero .description{max-width:35rem;font-size:1.6rem;line-height:1.3;color:#6a8bad}.home .hero .action-button{display:inline-block;font-size:1.2rem;color:#fff;background-color:#fd8824;padding:.8rem 1.6rem;border-radius:4px;-webkit-transition:background-color .1s ease;transition:background-color .1s ease;-webkit-box-sizing:border-box;box-sizing:border-box;border-bottom:1px solid #fd7807}.home .hero .action-button:hover{background-color:#fd943a}.home .features{border-top:1px solid #eaecef;padding:1.2rem 0;margin-top:2.5rem;display:-webkit-box;display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;-webkit-box-align:start;-ms-flex-align:start;align-items:flex-start;-ms-flex-line-pack:stretch;align-content:stretch;-webkit-box-pack:justify;-ms-flex-pack:justify;justify-content:space-between}.home .feature{-webkit-box-flex:1;-ms-flex-positive:1;flex-grow:1;-ms-flex-preferred-size:30%;flex-basis:30%;max-width:30%}.home .feature h2{font-size:1.4rem;font-weight:500;border-bottom:none;padding-bottom:0;color:#3a5169}.home .feature p{color:#4e6e8e}.home .footer{padding:2.5rem;border-top:1px solid #eaecef;text-align:center;color:#4e6e8e}@media (max-width:719px){.home .features{-webkit-box-orient:vertical;-webkit-box-direction:normal;-ms-flex-direction:column;flex-direction:column}.home .feature{max-width:100%;padding:0 2.5rem}}@media (max-width:419px){.home{padding-left:1.5rem;padding-right:1.5rem}.home .hero img{max-height:210px;margin:2rem auto 1.2rem}.home .hero h1{font-size:2rem}.home .hero .action,.home .hero .description,.home .hero h1{margin:1.2rem auto}.home .hero .description{font-size:1.2rem}.home .hero .action-button{font-size:1rem;padding:.6rem 1.2rem}.home .feature h2{font-size:1.25rem}}.sidebar-button{cursor:pointer;display:none;width:1.25rem;height:1.25rem;position:absolute;padding:.6rem;top:.6rem;left:1rem}.sidebar-button .icon{display:block;width:1.25rem;height:1.25rem}@media (max-width:719px){.sidebar-button{display:block}}.search-box{display:inline-block;position:relative;margin-right:1rem}.search-box input{cursor:text;width:10rem;height:2rem;color:#4e6e8e;display:inline-block;border:1px solid #cfd4db;border-radius:2rem;font-size:.9rem;line-height:2rem;padding:0 .5rem 0 2rem;outline:none;-webkit-transition:all .2s ease;transition:all .2s ease;background:#fff url(/ui/assets/img/search.83621669.svg) .6rem .5rem no-repeat;background-size:1rem}.search-box input:focus{cursor:auto;border-color:#fd8824}.search-box .suggestions{background:#fff;width:20rem;position:absolute;top:1.5rem;border:1px solid #cfd4db;border-radius:6px;padding:.4rem;list-style-type:none}.search-box .suggestions.align-right{right:0}.search-box .suggestion{line-height:1.4;padding:.4rem .6rem;border-radius:4px;cursor:pointer}.search-box .suggestion a{white-space:normal;color:#5d82a6}.search-box .suggestion a .page-title{font-weight:600}.search-box .suggestion a .header{font-size:.9em;margin-left:.25em}.search-box .suggestion.focused{background-color:#f3f4f5}.search-box .suggestion.focused a{color:#fd8824}@media (max-width:959px){.search-box input{cursor:pointer;width:0;border-color:transparent;position:relative}.search-box input:focus{cursor:text;left:0;width:10rem}}@media (-ms-high-contrast:none){.search-box input{height:2rem}}@media (max-width:959px) and (min-width:719px){.search-box .suggestions{left:0}}@media (max-width:719px){.search-box{margin-right:0}.search-box input{left:1rem}.search-box .suggestions{right:0}}@media (max-width:419px){.search-box .suggestions{width:calc(100vw - 4rem)}.search-box input:focus{width:8rem}}.dropdown-enter,.dropdown-leave-to{height:0!important}.dropdown-wrapper{cursor:pointer}.dropdown-wrapper .dropdown-title{display:block}.dropdown-wrapper .dropdown-title:hover{border-color:transparent}.dropdown-wrapper .dropdown-title .arrow{vertical-align:middle;margin-top:-1px;margin-left:.4rem}.dropdown-wrapper .nav-dropdown .dropdown-item{color:inherit;line-height:1.7rem}.dropdown-wrapper .nav-dropdown .dropdown-item h4{margin:.45rem 0 0;border-top:1px solid #eee;padding:.45rem 1.5rem 0 1.25rem}.dropdown-wrapper .nav-dropdown .dropdown-item .dropdown-subitem-wrapper{padding:0;list-style:none}.dropdown-wrapper .nav-dropdown .dropdown-item .dropdown-subitem-wrapper .dropdown-subitem{font-size:.9em}.dropdown-wrapper .nav-dropdown .dropdown-item a{display:block;line-height:1.7rem;position:relative;border-bottom:none;font-weight:400;margin-bottom:0;padding:0 1.5rem 0 1.25rem}.dropdown-wrapper .nav-dropdown .dropdown-item a.router-link-active,.dropdown-wrapper .nav-dropdown .dropdown-item a:hover{color:#fd8824}.dropdown-wrapper .nav-dropdown .dropdown-item a.router-link-active:after{content:"";width:0;height:0;border-left:5px solid #fd8824;border-top:3px solid transparent;border-bottom:3px solid transparent;position:absolute;top:calc(50% - 2px);left:9px}.dropdown-wrapper .nav-dropdown .dropdown-item:first-child h4{margin-top:0;padding-top:0;border-top:0}@media (max-width:719px){.dropdown-wrapper.open .dropdown-title{margin-bottom:.5rem}.dropdown-wrapper .nav-dropdown{-webkit-transition:height .1s ease-out;transition:height .1s ease-out;overflow:hidden}.dropdown-wrapper .nav-dropdown .dropdown-item h4{border-top:0;margin-top:0;padding-top:0}.dropdown-wrapper .nav-dropdown .dropdown-item>a,.dropdown-wrapper .nav-dropdown .dropdown-item h4{font-size:15px;line-height:2rem}.dropdown-wrapper .nav-dropdown .dropdown-item .dropdown-subitem{font-size:14px;padding-left:1rem}}@media (min-width:719px){.dropdown-wrapper{height:1.8rem}.dropdown-wrapper:hover .nav-dropdown{display:block!important}.dropdown-wrapper .dropdown-title .arrow{border-left:4px solid transparent;border-right:4px solid transparent;border-top:6px solid #ccc;border-bottom:0}.dropdown-wrapper .nav-dropdown{display:none;height:auto!important;-webkit-box-sizing:border-box;box-sizing:border-box;max-height:calc(100vh - 2.7rem);overflow-y:auto;position:absolute;top:100%;right:0;background-color:#fff;padding:.6rem 0;border:1px solid #ddd;border-bottom-color:#ccc;text-align:left;border-radius:.25rem;white-space:nowrap;margin:0}}.nav-links{display:inline-block}.nav-links a{line-height:1.4rem;color:inherit}.nav-links a.router-link-active,.nav-links a:hover{color:#fd8824}.nav-links .nav-item{position:relative;display:inline-block;margin-left:1.5rem;line-height:2rem}.nav-links .nav-item:first-child{margin-left:0}.nav-links .repo-link{margin-left:1.5rem}@media (max-width:719px){.nav-links .nav-item,.nav-links .repo-link{margin-left:0}}@media (min-width:719px){.nav-links a.router-link-active,.nav-links a:hover{color:#2c3e50}.nav-item>a:not(.external).router-link-active,.nav-item>a:not(.external):hover{margin-bottom:-2px;border-bottom:2px solid #fd9236}}.navbar{padding:.7rem 1.5rem;line-height:2.2rem}.navbar a,.navbar img,.navbar span{display:inline-block}.navbar .logo{height:2.2rem;min-width:2.2rem;margin-right:.8rem;vertical-align:top}.navbar .site-name{font-size:1.3rem;font-weight:600;color:#2c3e50;position:relative}.navbar .links{padding-left:1.5rem;-webkit-box-sizing:border-box;box-sizing:border-box;background-color:#fff;white-space:nowrap;font-size:.9rem;position:absolute;right:1.5rem;top:.7rem;display:-webkit-box;display:-ms-flexbox;display:flex}.navbar .links .search-box{-webkit-box-flex:0;-ms-flex:0 0 auto;flex:0 0 auto;vertical-align:top}@media (max-width:719px){.navbar{padding-left:4rem}.navbar .can-hide{display:none}.navbar .links{padding-left:1.5rem}}.page-edit,.page-nav{max-width:740px;margin:0 auto;padding:2rem 2.5rem}@media (max-width:959px){.page-edit,.page-nav{padding:2rem}}@media (max-width:419px){.page-edit,.page-nav{padding:1.5rem}}.page{padding-bottom:2rem;display:block}.page-edit{padding-top:1rem;padding-bottom:1rem;overflow:auto}.page-edit .edit-link{display:inline-block}.page-edit .edit-link a{color:#4e6e8e;margin-right:.25rem}.page-edit .last-updated{float:right;font-size:.9em}.page-edit .last-updated .prefix{font-weight:500;color:#4e6e8e}.page-edit .last-updated .time{font-weight:400;color:#aaa}.page-nav{padding-top:1rem;padding-bottom:0}.page-nav .inner{min-height:2rem;margin-top:0;border-top:1px solid #eaecef;padding-top:1rem;overflow:auto}.page-nav .next{float:right}@media (max-width:719px){.page-edit .edit-link{margin-bottom:.5rem}.page-edit .last-updated{font-size:.8em;float:none;text-align:left}}.sidebar-group .sidebar-group{padding-left:.5em}.sidebar-group:not(.collapsable) .sidebar-heading:not(.clickable){cursor:auto;color:inherit}.sidebar-group.is-sub-group{padding-left:0}.sidebar-group.is-sub-group>.sidebar-heading{font-size:.95em;line-height:1.4;font-weight:400;padding-left:2rem}.sidebar-group.is-sub-group>.sidebar-heading:not(.clickable){opacity:.5}.sidebar-group.is-sub-group>.sidebar-group-items{padding-left:1rem}.sidebar-group.is-sub-group>.sidebar-group-items>li>.sidebar-link{font-size:.95em;border-left:none}.sidebar-group.depth-2>.sidebar-heading{border-left:none}.sidebar-heading{color:#2c3e50;-webkit-transition:color .15s ease;transition:color .15s ease;cursor:pointer;font-size:1.1em;font-weight:700;padding:.35rem 1.5rem .35rem 1.25rem;width:100%;-webkit-box-sizing:border-box;box-sizing:border-box;margin:0;border-left:.25rem solid transparent}.sidebar-heading.open,.sidebar-heading:hover{color:inherit}.sidebar-heading .arrow{position:relative;top:-.12em;left:.5em}.sidebar-heading.clickable.active{font-weight:600;color:#fd8824;border-left-color:#fd8824}.sidebar-heading.clickable:hover{color:#fd8824}.sidebar-group-items{-webkit-transition:height .1s ease-out;transition:height .1s ease-out;font-size:.95em;overflow:hidden}.sidebar .sidebar-sub-headers{padding-left:1rem;font-size:.95em}a.sidebar-link{font-size:1em;font-weight:400;display:inline-block;color:#2c3e50;border-left:.25rem solid transparent;padding:.35rem 1rem .35rem 1.25rem;line-height:1.4;width:100%;-webkit-box-sizing:border-box;box-sizing:border-box}a.sidebar-link:hover{color:#fd8824}a.sidebar-link.active{font-weight:600;color:#fd8824;border-left-color:#fd8824}.sidebar-group a.sidebar-link{padding-left:2rem}.sidebar-sub-headers a.sidebar-link{padding-top:.25rem;padding-bottom:.25rem;border-left:none}.sidebar-sub-headers a.sidebar-link.active{font-weight:500}.sidebar ul{padding:0;margin:0;list-style-type:none}.sidebar a{display:inline-block}.sidebar .nav-links{display:none;border-bottom:1px solid #eaecef;padding:.5rem 0 .75rem 0}.sidebar .nav-links a{font-weight:600}.sidebar .nav-links .nav-item,.sidebar .nav-links .repo-link{display:block;line-height:1.25rem;font-size:1.1em;padding:.5rem 0 .5rem 1.5rem}.sidebar>.sidebar-links{padding:1.5rem 0}.sidebar>.sidebar-links>li>a.sidebar-link{font-size:1.1em;line-height:1.7;font-weight:700}.sidebar>.sidebar-links>li:not(:first-child){margin-top:.75rem}@media (max-width:719px){.sidebar .nav-links{display:block}.sidebar .nav-links .dropdown-wrapper .nav-dropdown .dropdown-item a.router-link-active:after{top:calc(1rem - 2px)}.sidebar>.sidebar-links{padding:1rem 0}}code[class*=language-],pre[class*=language-]{color:#ccc;background:none;font-family:Consolas,Monaco,Andale Mono,Ubuntu Mono,monospace;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-ms-hyphens:none;hyphens:none}pre[class*=language-]{padding:1em;margin:.5em 0;overflow:auto}:not(pre)>code[class*=language-],pre[class*=language-]{background:#2d2d2d}:not(pre)>code[class*=language-]{padding:.1em;border-radius:.3em;white-space:normal}.token.block-comment,.token.cdata,.token.comment,.token.doctype,.token.prolog{color:#999}.token.punctuation{color:#ccc}.token.attr-name,.token.deleted,.token.namespace,.token.tag{color:#e2777a}.token.function-name{color:#6196cc}.token.boolean,.token.function,.token.number{color:#f08d49}.token.class-name,.token.constant,.token.property,.token.symbol{color:#f8c555}.token.atrule,.token.builtin,.token.important,.token.keyword,.token.selector{color:#cc99cd}.token.attr-value,.token.char,.token.regex,.token.string,.token.variable{color:#7ec699}.token.entity,.token.operator,.token.url{color:#67cdcc}.token.bold,.token.important{font-weight:700}.token.italic{font-style:italic}.token.entity{cursor:help}.token.inserted{color:green}.content code{color:#476582;padding:.25rem .5rem;margin:0;font-size:.85em;background-color:rgba(27,31,35,.05);border-radius:3px}.content code .token.deleted{color:#ec5975}.content code .token.inserted{color:#fd8824}.content pre,.content pre[class*=language-]{line-height:1.4;padding:1.25rem 1.5rem;margin:.85rem 0;background-color:#282c34;border-radius:6px;overflow:auto}.content pre[class*=language-] code,.content pre code{color:#fff;padding:0;background-color:transparent;border-radius:0}div[class*=language-]{position:relative;background-color:#282c34;border-radius:6px}div[class*=language-] .highlight-lines{-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;padding-top:1.3rem;position:absolute;top:0;left:0;width:100%;line-height:1.4}div[class*=language-] .highlight-lines .highlighted{background-color:rgba(0,0,0,.66)}div[class*=language-] pre,div[class*=language-] pre[class*=language-]{background:transparent;position:relative;z-index:1}div[class*=language-]:before{position:absolute;z-index:3;top:.8em;right:1em;font-size:.75rem;color:hsla(0,0%,100%,.4)}div[class*=language-]:not(.line-numbers-mode) .line-numbers-wrapper{display:none}div[class*=language-].line-numbers-mode .highlight-lines .highlighted{position:relative}div[class*=language-].line-numbers-mode .highlight-lines .highlighted:before{content:" ";position:absolute;z-index:3;left:0;top:0;display:block;width:3.5rem;height:100%;background-color:rgba(0,0,0,.66)}div[class*=language-].line-numbers-mode pre{padding-left:4.5rem;vertical-align:middle}div[class*=language-].line-numbers-mode .line-numbers-wrapper{position:absolute;top:0;width:3.5rem;text-align:center;color:hsla(0,0%,100%,.3);padding:1.25rem 0;line-height:1.4}div[class*=language-].line-numbers-mode .line-numbers-wrapper .line-number,div[class*=language-].line-numbers-mode .line-numbers-wrapper br{-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}div[class*=language-].line-numbers-mode .line-numbers-wrapper .line-number{position:relative;z-index:4;font-size:.85em}div[class*=language-].line-numbers-mode:after{content:"";position:absolute;z-index:2;top:0;left:0;width:3.5rem;height:100%;border-radius:6px 0 0 6px;border-right:1px solid rgba(0,0,0,.66);background-color:#282c34}div[class~=language-js]:before{content:"js"}div[class~=language-ts]:before{content:"ts"}div[class~=language-html]:before{content:"html"}div[class~=language-md]:before{content:"md"}div[class~=language-vue]:before{content:"vue"}div[class~=language-css]:before{content:"css"}div[class~=language-sass]:before{content:"sass"}div[class~=language-scss]:before{content:"scss"}div[class~=language-less]:before{content:"less"}div[class~=language-stylus]:before{content:"stylus"}div[class~=language-go]:before{content:"go"}div[class~=language-java]:before{content:"java"}div[class~=language-c]:before{content:"c"}div[class~=language-sh]:before{content:"sh"}div[class~=language-yaml]:before{content:"yaml"}div[class~=language-py]:before{content:"py"}div[class~=language-docker]:before{content:"docker"}div[class~=language-dockerfile]:before{content:"dockerfile"}div[class~=language-makefile]:before{content:"makefile"}div[class~=language-javascript]:before{content:"js"}div[class~=language-typescript]:before{content:"ts"}div[class~=language-markup]:before{content:"html"}div[class~=language-markdown]:before{content:"md"}div[class~=language-json]:before{content:"json"}div[class~=language-ruby]:before{content:"rb"}div[class~=language-python]:before{content:"py"}div[class~=language-bash]:before{content:"sh"}div[class~=language-php]:before{content:"php"}.custom-block .custom-block-title{font-weight:600;margin-bottom:-.4rem}.custom-block.danger,.custom-block.tip,.custom-block.warning{padding:.1rem 1.5rem;border-left-width:.5rem;border-left-style:solid;margin:1rem 0}.custom-block.tip{background-color:#f3f5f7;border-color:#42b983}.custom-block.warning{background-color:rgba(255,229,100,.3);border-color:#e7c000;color:#6b5900}.custom-block.warning .custom-block-title{color:#b29400}.custom-block.warning a{color:#2c3e50}.custom-block.danger{background-color:#ffe6e6;border-color:#c00;color:#4d0000}.custom-block.danger .custom-block-title{color:#900}.custom-block.danger a{color:#2c3e50}pre.vue-container{border-left-width:.5rem;border-left-style:solid;border-color:#42b983;border-radius:0}pre.vue-container>code{font-size:14px!important}pre.vue-container>code>p{margin:-5px 0 -20px 0}pre.vue-container>code code{background-color:#42b983!important;padding:3px 5px;border-radius:3px;color:#000}pre.vue-container>code em{color:gray;font-weight:light}.arrow{display:inline-block;width:0;height:0}.arrow.up{border-bottom:6px solid #ccc}.arrow.down,.arrow.up{border-left:4px solid transparent;border-right:4px solid transparent}.arrow.down{border-top:6px solid #ccc}.arrow.right{border-left:6px solid #ccc}.arrow.left,.arrow.right{border-top:4px solid transparent;border-bottom:4px solid transparent}.arrow.left{border-right:6px solid #ccc}.content:not(.custom){max-width:740px;margin:0 auto;padding:2rem 2.5rem}@media (max-width:959px){.content:not(.custom){padding:2rem}}@media (max-width:419px){.content:not(.custom){padding:1.5rem}}.table-of-contents .badge{vertical-align:middle}body,html{padding:0;margin:0;background-color:#fff}body{font-family:-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Fira Sans,Droid Sans,Helvetica Neue,sans-serif;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;font-size:16px;color:#2c3e50}.page{padding-left:20rem}.navbar{z-index:20;right:0;height:3.6rem;background-color:#fff;-webkit-box-sizing:border-box;box-sizing:border-box;border-bottom:1px solid #eaecef}.navbar,.sidebar-mask{position:fixed;top:0;left:0}.sidebar-mask{z-index:9;width:100vw;height:100vh;display:none}.sidebar{font-size:16px;background-color:#fff;width:20rem;position:fixed;z-index:10;margin:0;top:3.6rem;left:0;bottom:0;-webkit-box-sizing:border-box;box-sizing:border-box;border-right:1px solid #eaecef;overflow-y:auto}.content:not(.custom)>:first-child{margin-top:3.6rem}.content:not(.custom) a:hover{text-decoration:underline}.content:not(.custom) p.demo{padding:1rem 1.5rem;border:1px solid #ddd;border-radius:4px}.content:not(.custom) img{max-width:100%}.content.custom{padding:0;margin:0}.content.custom img{max-width:100%}a{font-weight:500;text-decoration:none}a,p a code{color:#fd8824}p a code{font-weight:400}kbd{background:#eee;border:.15rem solid #ddd;border-bottom:.25rem solid #ddd;border-radius:.15rem;padding:0 .15em}blockquote{font-size:.9rem;color:#999;border-left:.5rem solid #dfe2e5;margin:.5rem 0;padding:.25rem 0 .25rem 1rem}blockquote>p{margin:0}ol,ul{padding-left:1.2em}strong{font-weight:600}h1,h2,h3,h4,h5,h6{font-weight:600;line-height:1.25}.content:not(.custom)>h1,.content:not(.custom)>h2,.content:not(.custom)>h3,.content:not(.custom)>h4,.content:not(.custom)>h5,.content:not(.custom)>h6{margin-top:-3.1rem;padding-top:4.6rem;margin-bottom:0}.content:not(.custom)>h1:first-child,.content:not(.custom)>h2:first-child,.content:not(.custom)>h3:first-child,.content:not(.custom)>h4:first-child,.content:not(.custom)>h5:first-child,.content:not(.custom)>h6:first-child{margin-top:-1.5rem;margin-bottom:1rem}.content:not(.custom)>h1:first-child+.custom-block,.content:not(.custom)>h1:first-child+p,.content:not(.custom)>h1:first-child+pre,.content:not(.custom)>h2:first-child+.custom-block,.content:not(.custom)>h2:first-child+p,.content:not(.custom)>h2:first-child+pre,.content:not(.custom)>h3:first-child+.custom-block,.content:not(.custom)>h3:first-child+p,.content:not(.custom)>h3:first-child+pre,.content:not(.custom)>h4:first-child+.custom-block,.content:not(.custom)>h4:first-child+p,.content:not(.custom)>h4:first-child+pre,.content:not(.custom)>h5:first-child+.custom-block,.content:not(.custom)>h5:first-child+p,.content:not(.custom)>h5:first-child+pre,.content:not(.custom)>h6:first-child+.custom-block,.content:not(.custom)>h6:first-child+p,.content:not(.custom)>h6:first-child+pre{margin-top:2rem}h1:hover .header-anchor,h2:hover .header-anchor,h3:hover .header-anchor,h4:hover .header-anchor,h5:hover .header-anchor,h6:hover .header-anchor{opacity:1}h1{font-size:2.2rem}h2{font-size:1.65rem;padding-bottom:.3rem;border-bottom:1px solid #eaecef}h3{font-size:1.35rem}a.header-anchor{font-size:.85em;float:left;margin-left:-.87em;padding-right:.23em;margin-top:.125em;opacity:0}a.header-anchor:hover{text-decoration:none}.line-number,code,kbd{font-family:source-code-pro,Menlo,Monaco,Consolas,Courier New,monospace}ol,p,ul{line-height:1.7}hr{border:0;border-top:1px solid #eaecef}table{border-collapse:collapse;margin:1rem 0;display:block;overflow-x:auto}tr{border-top:1px solid #dfe2e5}tr:nth-child(2n){background-color:#f6f8fa}td,th{border:1px solid #dfe2e5;padding:.6em 1em}.theme-container.sidebar-open .sidebar-mask{display:block}.theme-container.no-navbar .content:not(.custom)>h1,.theme-container.no-navbar h2,.theme-container.no-navbar h3,.theme-container.no-navbar h4,.theme-container.no-navbar h5,.theme-container.no-navbar h6{margin-top:1.5rem;padding-top:0}.theme-container.no-navbar .sidebar{top:0}@media (min-width:720px){.theme-container.no-sidebar .sidebar{display:none}.theme-container.no-sidebar .page{padding-left:0}}@media (max-width:959px){.sidebar{font-size:15px;width:16.4rem}.page{padding-left:16.4rem}}@media (max-width:719px){.sidebar{top:0;padding-top:3.6rem;-webkit-transform:translateX(-100%);transform:translateX(-100%);-webkit-transition:-webkit-transform .2s ease;transition:-webkit-transform .2s ease;transition:transform .2s ease;transition:transform .2s ease,-webkit-transform .2s ease}.page{padding-left:0}.theme-container.sidebar-open .sidebar{-webkit-transform:translateX(0);transform:translateX(0)}.theme-container.no-navbar .sidebar{padding-top:0}}@media (max-width:419px){h1{font-size:1.9rem}.content div[class*=language-]{margin:.85rem -1.5rem;border-radius:0}}.badge[data-v-efceadb8]{display:inline-block;font-size:14px;height:18px;line-height:18px;border-radius:3px;padding:0 6px;color:#fff;margin-right:5px;background-color:#42b983}.badge.middle[data-v-efceadb8]{vertical-align:middle}.badge.top[data-v-efceadb8]{vertical-align:top}.badge.green[data-v-efceadb8],.badge.tip[data-v-efceadb8]{background-color:#42b983}.badge.error[data-v-efceadb8]{background-color:#da5961}.badge.warn[data-v-efceadb8],.badge.warning[data-v-efceadb8],.badge.yellow[data-v-efceadb8]{background-color:#e7c000} \ No newline at end of file diff --git a/docs/assets/img/search.83621669.svg b/docs/assets/img/search.83621669.svg new file mode 100644 index 00000000..03d83913 --- /dev/null +++ b/docs/assets/img/search.83621669.svg @@ -0,0 +1 @@ + diff --git a/docs/assets/js/10.feee2fb6.js b/docs/assets/js/10.feee2fb6.js new file mode 100644 index 00000000..16280d0c --- /dev/null +++ b/docs/assets/js/10.feee2fb6.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[10],{311:function(e,t,o){"use strict";o.r(t);var n=o(46),r=Object(n.a)({},function(){var e=this,t=e.$createElement,o=e._self._c||t;return o("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[o("h1",{attrs:{id:"type-parameters"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),o("h4",{attrs:{id:"p"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#p","aria-hidden":"true"}},[e._v("#")]),e._v(" P")]),e._v(" "),o("h4",{attrs:{id:"s"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#s","aria-hidden":"true"}},[e._v("#")]),e._v(" S")]),e._v(" "),o("h4",{attrs:{id:"ss"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#ss","aria-hidden":"true"}},[e._v("#")]),e._v(" SS")]),e._v(" "),o("h1",{attrs:{id:"hierarchy"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),o("p",[o("code",[e._v("PureComponent")])]),e._v(" "),o("p",[o("strong",[e._v("↳ Demo")])]),e._v(" "),o("h1",{attrs:{id:"methods"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),o("p",[o("a",{attrs:{id:"unsafe_componentwillmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-unsafe-componentwillmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-unsafe-componentwillmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" UNSAFE_componentWillMount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("UNSAFE_componentWillMount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.UNSAFE_componentWillMount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:613")])]),e._v(" "),o("p",[e._v("Called immediately before mounting occurs, and before "),o("code",[e._v("Component#render")]),e._v(". Avoid introducing any side-effects or subscriptions in this method.")]),e._v(" "),o("p",[e._v("This method will not stop working in React 17.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use componentDidMount or the constructor instead")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"unsafe_componentwillreceiveprops"}})]),e._v(" "),o("h2",{attrs:{id:"optional-unsafe-componentwillreceiveprops"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-unsafe-componentwillreceiveprops","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" UNSAFE_componentWillReceiveProps")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("UNSAFE_componentWillReceiveProps")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("P")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.UNSAFE_componentWillReceiveProps")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:645")])]),e._v(" "),o("p",[e._v("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.")]),e._v(" "),o("p",[e._v("Calling "),o("code",[e._v("Component#setState")]),e._v(" generally does not trigger this method.")]),e._v(" "),o("p",[e._v("This method will not stop working in React 17.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use static getDerivedStateFromProps instead")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("P")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"unsafe_componentwillupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-unsafe-componentwillupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-unsafe-componentwillupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" UNSAFE_componentWillUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("UNSAFE_componentWillUpdate")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("P")]),e._v(">")]),e._v(", nextState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.UNSAFE_componentWillUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:673")])]),e._v(" "),o("p",[e._v("Called immediately before rendering when new props or state is received. Not called for the initial render.")]),e._v(" "),o("p",[e._v("Note: You cannot call "),o("code",[e._v("Component#setState")]),e._v(" here.")]),e._v(" "),o("p",[e._v("This method will not stop working in React 17.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use getSnapshotBeforeUpdate instead")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("P")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentdidcatch"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentdidcatch"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentdidcatch","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentDidCatch")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentDidCatch")]),e._v("(error: "),o("em",[o("code",[e._v("Error")])]),e._v(", errorInfo: "),o("em",[o("code",[e._v("ErrorInfo")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.componentDidCatch")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:542")])]),e._v(" "),o("p",[e._v("Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("error")]),e._v(" "),o("td",[o("code",[e._v("Error")])])]),e._v(" "),o("tr",[o("td",[e._v("errorInfo")]),e._v(" "),o("td",[o("code",[e._v("ErrorInfo")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentdidmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentdidmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentdidmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentDidMount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentDidMount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.componentDidMount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:521")])]),e._v(" "),o("p",[e._v("Called immediately after a component is mounted. Setting state here will trigger re-rendering.")]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentdidupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentdidupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentdidupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentDidUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentDidUpdate")]),e._v("(prevProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("P")]),e._v(">")]),e._v(", prevState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", snapshot?: "),o("em",[o("a",{attrs:{href:""}},[e._v("SS")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from NewLifecycle.componentDidUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:584")])]),e._v(" "),o("p",[e._v("Called immediately after updating occurs. Not called for the initial render.")]),e._v(" "),o("p",[e._v("The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("prevProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("P")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("prevState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[o("code",[e._v("Optional")]),e._v(" snapshot")]),e._v(" "),o("td",[o("a",{attrs:{href:""}},[e._v("SS")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillMount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillMount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.componentWillMount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:599")])]),e._v(" "),o("p",[e._v("Called immediately before mounting occurs, and before "),o("code",[e._v("Component#render")]),e._v(". Avoid introducing any side-effects or subscriptions in this method.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use componentDidMount or the constructor instead; will stop working in React 17")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillreceiveprops"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillreceiveprops"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillreceiveprops","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillReceiveProps")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillReceiveProps")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("P")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.componentWillReceiveProps")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:628")])]),e._v(" "),o("p",[e._v("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.")]),e._v(" "),o("p",[e._v("Calling "),o("code",[e._v("Component#setState")]),e._v(" generally does not trigger this method.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use static getDerivedStateFromProps instead; will stop working in React 17")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("P")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillunmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillunmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillunmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillUnmount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillUnmount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.componentWillUnmount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:537")])]),e._v(" "),o("p",[e._v("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 "),o("code",[e._v("componentDidMount")]),e._v(".")]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillUpdate")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("P")]),e._v(">")]),e._v(", nextState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.componentWillUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:658")])]),e._v(" "),o("p",[e._v("Called immediately before rendering when new props or state is received. Not called for the initial render.")]),e._v(" "),o("p",[e._v("Note: You cannot call "),o("code",[e._v("Component#setState")]),e._v(" here.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("P")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"getsnapshotbeforeupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-getsnapshotbeforeupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-getsnapshotbeforeupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" getSnapshotBeforeUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("getSnapshotBeforeUpdate")]),e._v("(prevProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("P")]),e._v(">")]),e._v(", prevState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v("): "),o("code",[e._v("SS")]),e._v(" | "),o("code",[e._v("null")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from NewLifecycle.getSnapshotBeforeUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:578")])]),e._v(" "),o("p",[e._v("Runs before React applies the result of "),o("code",[e._v("render")]),e._v(" to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before "),o("code",[e._v("render")]),e._v(" causes changes to it.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("prevProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("P")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("prevState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("SS")]),e._v(" | "),o("code",[e._v("null")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"render"}})]),e._v(" "),o("h2",{attrs:{id:"render"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#render","aria-hidden":"true"}},[e._v("#")]),e._v(" render")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("render")]),e._v("(): "),o("code",[e._v("Element")]),e._v("[]")]),e._v(" "),o("p",[o("em",[e._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/Demo.tsx#L13",target:"_blank",rel:"noopener noreferrer"}},[e._v("Demo.tsx:13"),o("OutboundLink")],1)])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("Element")]),e._v("[]")]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"shouldcomponentupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-shouldcomponentupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-shouldcomponentupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" shouldComponentUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("shouldComponentUpdate")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("P")]),e._v(">")]),e._v(", nextState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("boolean")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.shouldComponentUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:532")])]),e._v(" "),o("p",[e._v("Called to determine whether the change in props and state should trigger a re-render.")]),e._v(" "),o("p",[o("code",[e._v("Component")]),e._v(" always returns true. "),o("code",[e._v("PureComponent")]),e._v(" implements a shallow comparison on props and state and returns true if any props or states have changed.")]),e._v(" "),o("p",[e._v("If false is returned, "),o("code",[e._v("Component#render")]),e._v(", "),o("code",[e._v("componentWillUpdate")]),e._v(" and "),o("code",[e._v("componentDidUpdate")]),e._v(" will not be called.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("P")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("boolean")])]),e._v(" "),o("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/11.4431186e.js b/docs/assets/js/11.4431186e.js new file mode 100644 index 00000000..9aea52c1 --- /dev/null +++ b/docs/assets/js/11.4431186e.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[11],{310:function(e,t,o){"use strict";o.r(t);var n=o(46),r=Object(n.a)({},function(){var e=this,t=e.$createElement,o=e._self._c||t;return o("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[o("h1",{attrs:{id:"type-parameters"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),o("h4",{attrs:{id:"s"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#s","aria-hidden":"true"}},[e._v("#")]),e._v(" S")]),e._v(" "),o("h4",{attrs:{id:"ss"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#ss","aria-hidden":"true"}},[e._v("#")]),e._v(" SS")]),e._v(" "),o("h1",{attrs:{id:"hierarchy"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),o("p",[o("code",[e._v("PureComponent")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(" "),o("p",[o("strong",[e._v("↳ Beachball")])]),e._v(" "),o("h1",{attrs:{id:"methods"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),o("p",[o("a",{attrs:{id:"unsafe_componentwillmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-unsafe-componentwillmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-unsafe-componentwillmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" UNSAFE_componentWillMount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("UNSAFE_componentWillMount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.UNSAFE_componentWillMount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:613")])]),e._v(" "),o("p",[e._v("Called immediately before mounting occurs, and before "),o("code",[e._v("Component#render")]),e._v(". Avoid introducing any side-effects or subscriptions in this method.")]),e._v(" "),o("p",[e._v("This method will not stop working in React 17.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use componentDidMount or the constructor instead")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"unsafe_componentwillreceiveprops"}})]),e._v(" "),o("h2",{attrs:{id:"optional-unsafe-componentwillreceiveprops"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-unsafe-componentwillreceiveprops","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" UNSAFE_componentWillReceiveProps")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("UNSAFE_componentWillReceiveProps")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.UNSAFE_componentWillReceiveProps")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:645")])]),e._v(" "),o("p",[e._v("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.")]),e._v(" "),o("p",[e._v("Calling "),o("code",[e._v("Component#setState")]),e._v(" generally does not trigger this method.")]),e._v(" "),o("p",[e._v("This method will not stop working in React 17.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use static getDerivedStateFromProps instead")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"unsafe_componentwillupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-unsafe-componentwillupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-unsafe-componentwillupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" UNSAFE_componentWillUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("UNSAFE_componentWillUpdate")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.UNSAFE_componentWillUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:673")])]),e._v(" "),o("p",[e._v("Called immediately before rendering when new props or state is received. Not called for the initial render.")]),e._v(" "),o("p",[e._v("Note: You cannot call "),o("code",[e._v("Component#setState")]),e._v(" here.")]),e._v(" "),o("p",[e._v("This method will not stop working in React 17.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use getSnapshotBeforeUpdate instead")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentdidcatch"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentdidcatch"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentdidcatch","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentDidCatch")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentDidCatch")]),e._v("(error: "),o("em",[o("code",[e._v("Error")])]),e._v(", errorInfo: "),o("em",[o("code",[e._v("ErrorInfo")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.componentDidCatch")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:542")])]),e._v(" "),o("p",[e._v("Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("error")]),e._v(" "),o("td",[o("code",[e._v("Error")])])]),e._v(" "),o("tr",[o("td",[e._v("errorInfo")]),e._v(" "),o("td",[o("code",[e._v("ErrorInfo")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentdidmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentdidmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentdidmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentDidMount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentDidMount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.componentDidMount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:521")])]),e._v(" "),o("p",[e._v("Called immediately after a component is mounted. Setting state here will trigger re-rendering.")]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentdidupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentdidupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentdidupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentDidUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentDidUpdate")]),e._v("(prevProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", prevState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", snapshot?: "),o("em",[o("a",{attrs:{href:""}},[e._v("SS")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from NewLifecycle.componentDidUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:584")])]),e._v(" "),o("p",[e._v("Called immediately after updating occurs. Not called for the initial render.")]),e._v(" "),o("p",[e._v("The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("prevProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("prevState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[o("code",[e._v("Optional")]),e._v(" snapshot")]),e._v(" "),o("td",[o("a",{attrs:{href:""}},[e._v("SS")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillMount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillMount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.componentWillMount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:599")])]),e._v(" "),o("p",[e._v("Called immediately before mounting occurs, and before "),o("code",[e._v("Component#render")]),e._v(". Avoid introducing any side-effects or subscriptions in this method.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use componentDidMount or the constructor instead; will stop working in React 17")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillreceiveprops"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillreceiveprops"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillreceiveprops","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillReceiveProps")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillReceiveProps")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.componentWillReceiveProps")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:628")])]),e._v(" "),o("p",[e._v("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.")]),e._v(" "),o("p",[e._v("Calling "),o("code",[e._v("Component#setState")]),e._v(" generally does not trigger this method.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use static getDerivedStateFromProps instead; will stop working in React 17")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillunmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillunmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillunmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillUnmount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillUnmount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.componentWillUnmount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:537")])]),e._v(" "),o("p",[e._v("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 "),o("code",[e._v("componentDidMount")]),e._v(".")]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillUpdate")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.componentWillUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:658")])]),e._v(" "),o("p",[e._v("Called immediately before rendering when new props or state is received. Not called for the initial render.")]),e._v(" "),o("p",[e._v("Note: You cannot call "),o("code",[e._v("Component#setState")]),e._v(" here.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"getsnapshotbeforeupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-getsnapshotbeforeupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-getsnapshotbeforeupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" getSnapshotBeforeUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("getSnapshotBeforeUpdate")]),e._v("(prevProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", prevState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v("): "),o("code",[e._v("SS")]),e._v(" | "),o("code",[e._v("null")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from NewLifecycle.getSnapshotBeforeUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:578")])]),e._v(" "),o("p",[e._v("Runs before React applies the result of "),o("code",[e._v("render")]),e._v(" to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before "),o("code",[e._v("render")]),e._v(" causes changes to it.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("prevProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("prevState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("SS")]),e._v(" | "),o("code",[e._v("null")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"render"}})]),e._v(" "),o("h2",{attrs:{id:"render"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#render","aria-hidden":"true"}},[e._v("#")]),e._v(" render")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("render")]),e._v("(): "),o("code",[e._v("Element")])]),e._v(" "),o("p",[o("em",[e._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/icons/Beachball.tsx#L12",target:"_blank",rel:"noopener noreferrer"}},[e._v("icons/Beachball.tsx:12"),o("OutboundLink")],1)])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("Element")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"shouldcomponentupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-shouldcomponentupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-shouldcomponentupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" shouldComponentUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("shouldComponentUpdate")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("boolean")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.shouldComponentUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:532")])]),e._v(" "),o("p",[e._v("Called to determine whether the change in props and state should trigger a re-render.")]),e._v(" "),o("p",[o("code",[e._v("Component")]),e._v(" always returns true. "),o("code",[e._v("PureComponent")]),e._v(" implements a shallow comparison on props and state and returns true if any props or states have changed.")]),e._v(" "),o("p",[e._v("If false is returned, "),o("code",[e._v("Component#render")]),e._v(", "),o("code",[e._v("componentWillUpdate")]),e._v(" and "),o("code",[e._v("componentDidUpdate")]),e._v(" will not be called.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("boolean")])]),e._v(" "),o("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/12.60cde7c6.js b/docs/assets/js/12.60cde7c6.js new file mode 100644 index 00000000..ea965b20 --- /dev/null +++ b/docs/assets/js/12.60cde7c6.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[12],{309:function(e,t,o){"use strict";o.r(t);var n=o(46),r=Object(n.a)({},function(){var e=this,t=e.$createElement,o=e._self._c||t;return o("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[o("h1",{attrs:{id:"type-parameters"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),o("h4",{attrs:{id:"s"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#s","aria-hidden":"true"}},[e._v("#")]),e._v(" S")]),e._v(" "),o("h4",{attrs:{id:"ss"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#ss","aria-hidden":"true"}},[e._v("#")]),e._v(" SS")]),e._v(" "),o("h1",{attrs:{id:"hierarchy"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),o("p",[o("code",[e._v("PureComponent")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(" "),o("p",[o("strong",[e._v("↳ Empty")])]),e._v(" "),o("h1",{attrs:{id:"methods"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),o("p",[o("a",{attrs:{id:"unsafe_componentwillmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-unsafe-componentwillmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-unsafe-componentwillmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" UNSAFE_componentWillMount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("UNSAFE_componentWillMount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.UNSAFE_componentWillMount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:613")])]),e._v(" "),o("p",[e._v("Called immediately before mounting occurs, and before "),o("code",[e._v("Component#render")]),e._v(". Avoid introducing any side-effects or subscriptions in this method.")]),e._v(" "),o("p",[e._v("This method will not stop working in React 17.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use componentDidMount or the constructor instead")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"unsafe_componentwillreceiveprops"}})]),e._v(" "),o("h2",{attrs:{id:"optional-unsafe-componentwillreceiveprops"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-unsafe-componentwillreceiveprops","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" UNSAFE_componentWillReceiveProps")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("UNSAFE_componentWillReceiveProps")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.UNSAFE_componentWillReceiveProps")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:645")])]),e._v(" "),o("p",[e._v("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.")]),e._v(" "),o("p",[e._v("Calling "),o("code",[e._v("Component#setState")]),e._v(" generally does not trigger this method.")]),e._v(" "),o("p",[e._v("This method will not stop working in React 17.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use static getDerivedStateFromProps instead")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"unsafe_componentwillupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-unsafe-componentwillupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-unsafe-componentwillupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" UNSAFE_componentWillUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("UNSAFE_componentWillUpdate")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.UNSAFE_componentWillUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:673")])]),e._v(" "),o("p",[e._v("Called immediately before rendering when new props or state is received. Not called for the initial render.")]),e._v(" "),o("p",[e._v("Note: You cannot call "),o("code",[e._v("Component#setState")]),e._v(" here.")]),e._v(" "),o("p",[e._v("This method will not stop working in React 17.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use getSnapshotBeforeUpdate instead")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentdidcatch"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentdidcatch"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentdidcatch","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentDidCatch")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentDidCatch")]),e._v("(error: "),o("em",[o("code",[e._v("Error")])]),e._v(", errorInfo: "),o("em",[o("code",[e._v("ErrorInfo")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.componentDidCatch")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:542")])]),e._v(" "),o("p",[e._v("Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("error")]),e._v(" "),o("td",[o("code",[e._v("Error")])])]),e._v(" "),o("tr",[o("td",[e._v("errorInfo")]),e._v(" "),o("td",[o("code",[e._v("ErrorInfo")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentdidmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentdidmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentdidmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentDidMount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentDidMount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.componentDidMount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:521")])]),e._v(" "),o("p",[e._v("Called immediately after a component is mounted. Setting state here will trigger re-rendering.")]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentdidupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentdidupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentdidupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentDidUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentDidUpdate")]),e._v("(prevProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", prevState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", snapshot?: "),o("em",[o("a",{attrs:{href:""}},[e._v("SS")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from NewLifecycle.componentDidUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:584")])]),e._v(" "),o("p",[e._v("Called immediately after updating occurs. Not called for the initial render.")]),e._v(" "),o("p",[e._v("The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("prevProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("prevState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[o("code",[e._v("Optional")]),e._v(" snapshot")]),e._v(" "),o("td",[o("a",{attrs:{href:""}},[e._v("SS")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillMount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillMount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.componentWillMount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:599")])]),e._v(" "),o("p",[e._v("Called immediately before mounting occurs, and before "),o("code",[e._v("Component#render")]),e._v(". Avoid introducing any side-effects or subscriptions in this method.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use componentDidMount or the constructor instead; will stop working in React 17")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillreceiveprops"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillreceiveprops"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillreceiveprops","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillReceiveProps")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillReceiveProps")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.componentWillReceiveProps")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:628")])]),e._v(" "),o("p",[e._v("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.")]),e._v(" "),o("p",[e._v("Calling "),o("code",[e._v("Component#setState")]),e._v(" generally does not trigger this method.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use static getDerivedStateFromProps instead; will stop working in React 17")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillunmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillunmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillunmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillUnmount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillUnmount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.componentWillUnmount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:537")])]),e._v(" "),o("p",[e._v("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 "),o("code",[e._v("componentDidMount")]),e._v(".")]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillUpdate")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.componentWillUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:658")])]),e._v(" "),o("p",[e._v("Called immediately before rendering when new props or state is received. Not called for the initial render.")]),e._v(" "),o("p",[e._v("Note: You cannot call "),o("code",[e._v("Component#setState")]),e._v(" here.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"getsnapshotbeforeupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-getsnapshotbeforeupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-getsnapshotbeforeupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" getSnapshotBeforeUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("getSnapshotBeforeUpdate")]),e._v("(prevProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", prevState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v("): "),o("code",[e._v("SS")]),e._v(" | "),o("code",[e._v("null")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from NewLifecycle.getSnapshotBeforeUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:578")])]),e._v(" "),o("p",[e._v("Runs before React applies the result of "),o("code",[e._v("render")]),e._v(" to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before "),o("code",[e._v("render")]),e._v(" causes changes to it.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("prevProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("prevState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("SS")]),e._v(" | "),o("code",[e._v("null")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"render"}})]),e._v(" "),o("h2",{attrs:{id:"render"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#render","aria-hidden":"true"}},[e._v("#")]),e._v(" render")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("render")]),e._v("(): "),o("code",[e._v("Element")])]),e._v(" "),o("p",[o("em",[e._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/icons/Empty.tsx#L10",target:"_blank",rel:"noopener noreferrer"}},[e._v("icons/Empty.tsx:10"),o("OutboundLink")],1)])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("Element")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"shouldcomponentupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-shouldcomponentupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-shouldcomponentupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" shouldComponentUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("shouldComponentUpdate")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("boolean")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.shouldComponentUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:532")])]),e._v(" "),o("p",[e._v("Called to determine whether the change in props and state should trigger a re-render.")]),e._v(" "),o("p",[o("code",[e._v("Component")]),e._v(" always returns true. "),o("code",[e._v("PureComponent")]),e._v(" implements a shallow comparison on props and state and returns true if any props or states have changed.")]),e._v(" "),o("p",[e._v("If false is returned, "),o("code",[e._v("Component#render")]),e._v(", "),o("code",[e._v("componentWillUpdate")]),e._v(" and "),o("code",[e._v("componentDidUpdate")]),e._v(" will not be called.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("boolean")])]),e._v(" "),o("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/13.e8f9b929.js b/docs/assets/js/13.e8f9b929.js new file mode 100644 index 00000000..82556297 --- /dev/null +++ b/docs/assets/js/13.e8f9b929.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[13],{363:function(e,t,o){"use strict";o.r(t);var n=o(46),r=Object(n.a)({},function(){var e=this,t=e.$createElement,o=e._self._c||t;return o("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[o("h1",{attrs:{id:"type-parameters"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),o("h4",{attrs:{id:"s"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#s","aria-hidden":"true"}},[e._v("#")]),e._v(" S")]),e._v(" "),o("h4",{attrs:{id:"ss"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#ss","aria-hidden":"true"}},[e._v("#")]),e._v(" SS")]),e._v(" "),o("h1",{attrs:{id:"hierarchy"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),o("p",[o("code",[e._v("PureComponent")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(" "),o("p",[o("strong",[e._v("↳ Jdenticon")])]),e._v(" "),o("h1",{attrs:{id:"methods"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),o("p",[o("a",{attrs:{id:"unsafe_componentwillmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-unsafe-componentwillmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-unsafe-componentwillmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" UNSAFE_componentWillMount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("UNSAFE_componentWillMount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.UNSAFE_componentWillMount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:613")])]),e._v(" "),o("p",[e._v("Called immediately before mounting occurs, and before "),o("code",[e._v("Component#render")]),e._v(". Avoid introducing any side-effects or subscriptions in this method.")]),e._v(" "),o("p",[e._v("This method will not stop working in React 17.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use componentDidMount or the constructor instead")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"unsafe_componentwillreceiveprops"}})]),e._v(" "),o("h2",{attrs:{id:"optional-unsafe-componentwillreceiveprops"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-unsafe-componentwillreceiveprops","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" UNSAFE_componentWillReceiveProps")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("UNSAFE_componentWillReceiveProps")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.UNSAFE_componentWillReceiveProps")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:645")])]),e._v(" "),o("p",[e._v("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.")]),e._v(" "),o("p",[e._v("Calling "),o("code",[e._v("Component#setState")]),e._v(" generally does not trigger this method.")]),e._v(" "),o("p",[e._v("This method will not stop working in React 17.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use static getDerivedStateFromProps instead")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"unsafe_componentwillupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-unsafe-componentwillupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-unsafe-componentwillupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" UNSAFE_componentWillUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("UNSAFE_componentWillUpdate")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.UNSAFE_componentWillUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:673")])]),e._v(" "),o("p",[e._v("Called immediately before rendering when new props or state is received. Not called for the initial render.")]),e._v(" "),o("p",[e._v("Note: You cannot call "),o("code",[e._v("Component#setState")]),e._v(" here.")]),e._v(" "),o("p",[e._v("This method will not stop working in React 17.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use getSnapshotBeforeUpdate instead")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentdidcatch"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentdidcatch"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentdidcatch","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentDidCatch")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentDidCatch")]),e._v("(error: "),o("em",[o("code",[e._v("Error")])]),e._v(", errorInfo: "),o("em",[o("code",[e._v("ErrorInfo")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.componentDidCatch")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:542")])]),e._v(" "),o("p",[e._v("Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("error")]),e._v(" "),o("td",[o("code",[e._v("Error")])])]),e._v(" "),o("tr",[o("td",[e._v("errorInfo")]),e._v(" "),o("td",[o("code",[e._v("ErrorInfo")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentdidmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentdidmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentdidmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentDidMount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentDidMount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.componentDidMount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:521")])]),e._v(" "),o("p",[e._v("Called immediately after a component is mounted. Setting state here will trigger re-rendering.")]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentdidupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentdidupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentdidupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentDidUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentDidUpdate")]),e._v("(prevProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", prevState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", snapshot?: "),o("em",[o("a",{attrs:{href:""}},[e._v("SS")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from NewLifecycle.componentDidUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:584")])]),e._v(" "),o("p",[e._v("Called immediately after updating occurs. Not called for the initial render.")]),e._v(" "),o("p",[e._v("The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("prevProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("prevState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[o("code",[e._v("Optional")]),e._v(" snapshot")]),e._v(" "),o("td",[o("a",{attrs:{href:""}},[e._v("SS")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillMount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillMount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.componentWillMount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:599")])]),e._v(" "),o("p",[e._v("Called immediately before mounting occurs, and before "),o("code",[e._v("Component#render")]),e._v(". Avoid introducing any side-effects or subscriptions in this method.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use componentDidMount or the constructor instead; will stop working in React 17")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillreceiveprops"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillreceiveprops"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillreceiveprops","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillReceiveProps")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillReceiveProps")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.componentWillReceiveProps")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:628")])]),e._v(" "),o("p",[e._v("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.")]),e._v(" "),o("p",[e._v("Calling "),o("code",[e._v("Component#setState")]),e._v(" generally does not trigger this method.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use static getDerivedStateFromProps instead; will stop working in React 17")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillunmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillunmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillunmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillUnmount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillUnmount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.componentWillUnmount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:537")])]),e._v(" "),o("p",[e._v("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 "),o("code",[e._v("componentDidMount")]),e._v(".")]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillUpdate")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.componentWillUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:658")])]),e._v(" "),o("p",[e._v("Called immediately before rendering when new props or state is received. Not called for the initial render.")]),e._v(" "),o("p",[e._v("Note: You cannot call "),o("code",[e._v("Component#setState")]),e._v(" here.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"getsnapshotbeforeupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-getsnapshotbeforeupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-getsnapshotbeforeupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" getSnapshotBeforeUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("getSnapshotBeforeUpdate")]),e._v("(prevProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", prevState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v("): "),o("code",[e._v("SS")]),e._v(" | "),o("code",[e._v("null")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from NewLifecycle.getSnapshotBeforeUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:578")])]),e._v(" "),o("p",[e._v("Runs before React applies the result of "),o("code",[e._v("render")]),e._v(" to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before "),o("code",[e._v("render")]),e._v(" causes changes to it.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("prevProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("prevState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("SS")]),e._v(" | "),o("code",[e._v("null")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"render"}})]),e._v(" "),o("h2",{attrs:{id:"render"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#render","aria-hidden":"true"}},[e._v("#")]),e._v(" render")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("render")]),e._v("(): "),o("code",[e._v("Element")])]),e._v(" "),o("p",[o("em",[e._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/icons/Jdenticon.tsx#L11",target:"_blank",rel:"noopener noreferrer"}},[e._v("icons/Jdenticon.tsx:11"),o("OutboundLink")],1)])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("Element")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"shouldcomponentupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-shouldcomponentupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-shouldcomponentupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" shouldComponentUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("shouldComponentUpdate")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("boolean")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.shouldComponentUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:532")])]),e._v(" "),o("p",[e._v("Called to determine whether the change in props and state should trigger a re-render.")]),e._v(" "),o("p",[o("code",[e._v("Component")]),e._v(" always returns true. "),o("code",[e._v("PureComponent")]),e._v(" implements a shallow comparison on props and state and returns true if any props or states have changed.")]),e._v(" "),o("p",[e._v("If false is returned, "),o("code",[e._v("Component#render")]),e._v(", "),o("code",[e._v("componentWillUpdate")]),e._v(" and "),o("code",[e._v("componentDidUpdate")]),e._v(" will not be called.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("boolean")])]),e._v(" "),o("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/14.edf23a0c.js b/docs/assets/js/14.edf23a0c.js new file mode 100644 index 00000000..e3f62ab1 --- /dev/null +++ b/docs/assets/js/14.edf23a0c.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[14],{308:function(e,t,o){"use strict";o.r(t);var n=o(46),r=Object(n.a)({},function(){var e=this,t=e.$createElement,o=e._self._c||t;return o("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[o("h1",{attrs:{id:"type-parameters"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),o("h4",{attrs:{id:"s"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#s","aria-hidden":"true"}},[e._v("#")]),e._v(" S")]),e._v(" "),o("h4",{attrs:{id:"ss"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#ss","aria-hidden":"true"}},[e._v("#")]),e._v(" SS")]),e._v(" "),o("h1",{attrs:{id:"hierarchy"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),o("p",[o("code",[e._v("PureComponent")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(" "),o("p",[o("strong",[e._v("↳ Identicon")])]),e._v(" "),o("h1",{attrs:{id:"methods"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),o("p",[o("a",{attrs:{id:"unsafe_componentwillmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-unsafe-componentwillmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-unsafe-componentwillmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" UNSAFE_componentWillMount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("UNSAFE_componentWillMount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.UNSAFE_componentWillMount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:613")])]),e._v(" "),o("p",[e._v("Called immediately before mounting occurs, and before "),o("code",[e._v("Component#render")]),e._v(". Avoid introducing any side-effects or subscriptions in this method.")]),e._v(" "),o("p",[e._v("This method will not stop working in React 17.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use componentDidMount or the constructor instead")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"unsafe_componentwillreceiveprops"}})]),e._v(" "),o("h2",{attrs:{id:"optional-unsafe-componentwillreceiveprops"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-unsafe-componentwillreceiveprops","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" UNSAFE_componentWillReceiveProps")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("UNSAFE_componentWillReceiveProps")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.UNSAFE_componentWillReceiveProps")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:645")])]),e._v(" "),o("p",[e._v("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.")]),e._v(" "),o("p",[e._v("Calling "),o("code",[e._v("Component#setState")]),e._v(" generally does not trigger this method.")]),e._v(" "),o("p",[e._v("This method will not stop working in React 17.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use static getDerivedStateFromProps instead")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"unsafe_componentwillupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-unsafe-componentwillupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-unsafe-componentwillupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" UNSAFE_componentWillUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("UNSAFE_componentWillUpdate")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.UNSAFE_componentWillUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:673")])]),e._v(" "),o("p",[e._v("Called immediately before rendering when new props or state is received. Not called for the initial render.")]),e._v(" "),o("p",[e._v("Note: You cannot call "),o("code",[e._v("Component#setState")]),e._v(" here.")]),e._v(" "),o("p",[e._v("This method will not stop working in React 17.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use getSnapshotBeforeUpdate instead")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentdidcatch"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentdidcatch"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentdidcatch","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentDidCatch")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentDidCatch")]),e._v("(error: "),o("em",[o("code",[e._v("Error")])]),e._v(", errorInfo: "),o("em",[o("code",[e._v("ErrorInfo")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.componentDidCatch")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:542")])]),e._v(" "),o("p",[e._v("Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("error")]),e._v(" "),o("td",[o("code",[e._v("Error")])])]),e._v(" "),o("tr",[o("td",[e._v("errorInfo")]),e._v(" "),o("td",[o("code",[e._v("ErrorInfo")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentdidmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentdidmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentdidmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentDidMount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentDidMount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.componentDidMount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:521")])]),e._v(" "),o("p",[e._v("Called immediately after a component is mounted. Setting state here will trigger re-rendering.")]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentdidupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentdidupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentdidupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentDidUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentDidUpdate")]),e._v("(prevProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", prevState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", snapshot?: "),o("em",[o("a",{attrs:{href:""}},[e._v("SS")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from NewLifecycle.componentDidUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:584")])]),e._v(" "),o("p",[e._v("Called immediately after updating occurs. Not called for the initial render.")]),e._v(" "),o("p",[e._v("The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("prevProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("prevState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[o("code",[e._v("Optional")]),e._v(" snapshot")]),e._v(" "),o("td",[o("a",{attrs:{href:""}},[e._v("SS")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillMount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillMount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.componentWillMount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:599")])]),e._v(" "),o("p",[e._v("Called immediately before mounting occurs, and before "),o("code",[e._v("Component#render")]),e._v(". Avoid introducing any side-effects or subscriptions in this method.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use componentDidMount or the constructor instead; will stop working in React 17")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillreceiveprops"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillreceiveprops"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillreceiveprops","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillReceiveProps")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillReceiveProps")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.componentWillReceiveProps")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:628")])]),e._v(" "),o("p",[e._v("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.")]),e._v(" "),o("p",[e._v("Calling "),o("code",[e._v("Component#setState")]),e._v(" generally does not trigger this method.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use static getDerivedStateFromProps instead; will stop working in React 17")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillunmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillunmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillunmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillUnmount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillUnmount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.componentWillUnmount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:537")])]),e._v(" "),o("p",[e._v("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 "),o("code",[e._v("componentDidMount")]),e._v(".")]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillUpdate")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.componentWillUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:658")])]),e._v(" "),o("p",[e._v("Called immediately before rendering when new props or state is received. Not called for the initial render.")]),e._v(" "),o("p",[e._v("Note: You cannot call "),o("code",[e._v("Component#setState")]),e._v(" here.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"getsnapshotbeforeupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-getsnapshotbeforeupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-getsnapshotbeforeupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" getSnapshotBeforeUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("getSnapshotBeforeUpdate")]),e._v("(prevProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", prevState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v("): "),o("code",[e._v("SS")]),e._v(" | "),o("code",[e._v("null")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from NewLifecycle.getSnapshotBeforeUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:578")])]),e._v(" "),o("p",[e._v("Runs before React applies the result of "),o("code",[e._v("render")]),e._v(" to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before "),o("code",[e._v("render")]),e._v(" causes changes to it.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("prevProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("prevState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("SS")]),e._v(" | "),o("code",[e._v("null")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"render"}})]),e._v(" "),o("h2",{attrs:{id:"render"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#render","aria-hidden":"true"}},[e._v("#")]),e._v(" render")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("render")]),e._v("(): "),o("code",[e._v("Element")])]),e._v(" "),o("p",[o("em",[e._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/icons/Polkadot.tsx#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("icons/Polkadot.tsx:50"),o("OutboundLink")],1)])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("Element")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"shouldcomponentupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-shouldcomponentupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-shouldcomponentupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" shouldComponentUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("shouldComponentUpdate")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("boolean")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.shouldComponentUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:532")])]),e._v(" "),o("p",[e._v("Called to determine whether the change in props and state should trigger a re-render.")]),e._v(" "),o("p",[o("code",[e._v("Component")]),e._v(" always returns true. "),o("code",[e._v("PureComponent")]),e._v(" implements a shallow comparison on props and state and returns true if any props or states have changed.")]),e._v(" "),o("p",[e._v("If false is returned, "),o("code",[e._v("Component#render")]),e._v(", "),o("code",[e._v("componentWillUpdate")]),e._v(" and "),o("code",[e._v("componentDidUpdate")]),e._v(" will not be called.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("boolean")])]),e._v(" "),o("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/15.6e140e5c.js b/docs/assets/js/15.6e140e5c.js new file mode 100644 index 00000000..069f0ef6 --- /dev/null +++ b/docs/assets/js/15.6e140e5c.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[15],{307:function(e,t,o){"use strict";o.r(t);var r=o(46),n=Object(r.a)({},function(){var e=this,t=e.$createElement,o=e._self._c||t;return o("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[o("h1",{attrs:{id:"type-parameters"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),o("h4",{attrs:{id:"ss"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#ss","aria-hidden":"true"}},[e._v("#")]),e._v(" SS")]),e._v(" "),o("h1",{attrs:{id:"hierarchy"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),o("p",[o("code",[e._v("PureComponent")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(", "),o("code",[e._v("State")]),e._v(">")],1),e._v(" "),o("p",[o("strong",[e._v("↳ IdentityIcon")])]),e._v(" "),o("h1",{attrs:{id:"methods"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),o("p",[o("a",{attrs:{id:"unsafe_componentwillmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-unsafe-componentwillmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-unsafe-componentwillmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" UNSAFE_componentWillMount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("UNSAFE_componentWillMount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.UNSAFE_componentWillMount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:613")])]),e._v(" "),o("p",[e._v("Called immediately before mounting occurs, and before "),o("code",[e._v("Component#render")]),e._v(". Avoid introducing any side-effects or subscriptions in this method.")]),e._v(" "),o("p",[e._v("This method will not stop working in React 17.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use componentDidMount or the constructor instead")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"unsafe_componentwillreceiveprops"}})]),e._v(" "),o("h2",{attrs:{id:"optional-unsafe-componentwillreceiveprops"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-unsafe-componentwillreceiveprops","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" UNSAFE_componentWillReceiveProps")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("UNSAFE_componentWillReceiveProps")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.UNSAFE_componentWillReceiveProps")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:645")])]),e._v(" "),o("p",[e._v("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.")]),e._v(" "),o("p",[e._v("Calling "),o("code",[e._v("Component#setState")]),e._v(" generally does not trigger this method.")]),e._v(" "),o("p",[e._v("This method will not stop working in React 17.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use static getDerivedStateFromProps instead")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"unsafe_componentwillupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-unsafe-componentwillupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-unsafe-componentwillupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" UNSAFE_componentWillUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("UNSAFE_componentWillUpdate")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("State")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.UNSAFE_componentWillUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:673")])]),e._v(" "),o("p",[e._v("Called immediately before rendering when new props or state is received. Not called for the initial render.")]),e._v(" "),o("p",[e._v("Note: You cannot call "),o("code",[e._v("Component#setState")]),e._v(" here.")]),e._v(" "),o("p",[e._v("This method will not stop working in React 17.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use getSnapshotBeforeUpdate instead")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("State")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentdidcatch"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentdidcatch"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentdidcatch","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentDidCatch")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentDidCatch")]),e._v("(error: "),o("em",[o("code",[e._v("Error")])]),e._v(", errorInfo: "),o("em",[o("code",[e._v("ErrorInfo")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.componentDidCatch")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:542")])]),e._v(" "),o("p",[e._v("Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("error")]),e._v(" "),o("td",[o("code",[e._v("Error")])])]),e._v(" "),o("tr",[o("td",[e._v("errorInfo")]),e._v(" "),o("td",[o("code",[e._v("ErrorInfo")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentdidmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentdidmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentdidmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentDidMount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentDidMount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.componentDidMount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:521")])]),e._v(" "),o("p",[e._v("Called immediately after a component is mounted. Setting state here will trigger re-rendering.")]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentdidupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentdidupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentdidupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentDidUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentDidUpdate")]),e._v("(prevProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", prevState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("State")]),e._v(">")]),e._v(", snapshot?: "),o("em",[o("a",{attrs:{href:""}},[e._v("SS")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from NewLifecycle.componentDidUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:584")])]),e._v(" "),o("p",[e._v("Called immediately after updating occurs. Not called for the initial render.")]),e._v(" "),o("p",[e._v("The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("prevProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("prevState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("State")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[o("code",[e._v("Optional")]),e._v(" snapshot")]),e._v(" "),o("td",[o("a",{attrs:{href:""}},[e._v("SS")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillMount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillMount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.componentWillMount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:599")])]),e._v(" "),o("p",[e._v("Called immediately before mounting occurs, and before "),o("code",[e._v("Component#render")]),e._v(". Avoid introducing any side-effects or subscriptions in this method.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use componentDidMount or the constructor instead; will stop working in React 17")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillreceiveprops"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillreceiveprops"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillreceiveprops","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillReceiveProps")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillReceiveProps")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.componentWillReceiveProps")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:628")])]),e._v(" "),o("p",[e._v("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.")]),e._v(" "),o("p",[e._v("Calling "),o("code",[e._v("Component#setState")]),e._v(" generally does not trigger this method.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use static getDerivedStateFromProps instead; will stop working in React 17")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillunmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillunmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillunmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillUnmount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillUnmount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.componentWillUnmount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:537")])]),e._v(" "),o("p",[e._v("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 "),o("code",[e._v("componentDidMount")]),e._v(".")]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillUpdate")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("State")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.componentWillUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:658")])]),e._v(" "),o("p",[e._v("Called immediately before rendering when new props or state is received. Not called for the initial render.")]),e._v(" "),o("p",[e._v("Note: You cannot call "),o("code",[e._v("Component#setState")]),e._v(" here.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("State")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"getsnapshotbeforeupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-getsnapshotbeforeupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-getsnapshotbeforeupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" getSnapshotBeforeUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("getSnapshotBeforeUpdate")]),e._v("(prevProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", prevState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("State")]),e._v(">")]),e._v("): "),o("code",[e._v("SS")]),e._v(" | "),o("code",[e._v("null")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from NewLifecycle.getSnapshotBeforeUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:578")])]),e._v(" "),o("p",[e._v("Runs before React applies the result of "),o("code",[e._v("render")]),e._v(" to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before "),o("code",[e._v("render")]),e._v(" causes changes to it.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("prevProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("prevState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("State")]),e._v(">")])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("SS")]),e._v(" | "),o("code",[e._v("null")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"render"}})]),e._v(" "),o("h2",{attrs:{id:"render"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#render","aria-hidden":"true"}},[e._v("#")]),e._v(" render")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("render")]),e._v("(): "),o("code",[e._v("Element")])]),e._v(" "),o("p",[o("em",[e._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/Identicon.tsx#L91",target:"_blank",rel:"noopener noreferrer"}},[e._v("Identicon.tsx:91"),o("OutboundLink")],1)])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("Element")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"shouldcomponentupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-shouldcomponentupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-shouldcomponentupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" shouldComponentUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("shouldComponentUpdate")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1),e._v(", nextState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("State")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("boolean")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.shouldComponentUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:532")])]),e._v(" "),o("p",[e._v("Called to determine whether the change in props and state should trigger a re-render.")]),e._v(" "),o("p",[o("code",[e._v("Component")]),e._v(" always returns true. "),o("code",[e._v("PureComponent")]),e._v(" implements a shallow comparison on props and state and returns true if any props or states have changed.")]),e._v(" "),o("p",[e._v("If false is returned, "),o("code",[e._v("Component#render")]),e._v(", "),o("code",[e._v("componentWillUpdate")]),e._v(" and "),o("code",[e._v("componentDidUpdate")]),e._v(" will not be called.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#props"}},[e._v("Props")]),e._v(">")],1)]),e._v(" "),o("tr",[o("td",[e._v("nextState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("State")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("boolean")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"getderivedstatefromprops"}})]),e._v(" "),o("h2",{attrs:{id:"static-getderivedstatefromprops"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#static-getderivedstatefromprops","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" getDerivedStateFromProps")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("getDerivedStateFromProps")]),e._v("(__namedParameters: "),o("em",[o("code",[e._v("object")])]),e._v(", prevState: "),o("em",[o("code",[e._v("State")])]),e._v("): "),o("code",[e._v("State")]),e._v(" | "),o("code",[e._v("null")])]),e._v(" "),o("p",[o("em",[e._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/Identicon.tsx#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("Identicon.tsx:71"),o("OutboundLink")],1)])]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("__namedParameters")]),e._v(" "),o("td",[o("code",[e._v("object")])])]),e._v(" "),o("tr",[o("td",[e._v("prevState")]),e._v(" "),o("td",[o("code",[e._v("State")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("State")]),e._v(" | "),o("code",[e._v("null")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"setdefaultprefix"}})]),e._v(" "),o("h2",{attrs:{id:"static-setdefaultprefix"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#static-setdefaultprefix","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" setDefaultPrefix")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("setDefaultPrefix")]),e._v("(prefix: "),o("em",[o("code",[e._v("Prefix")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/Identicon.tsx#L67",target:"_blank",rel:"noopener noreferrer"}},[e._v("Identicon.tsx:67"),o("OutboundLink")],1)])]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("prefix")]),e._v(" "),o("td",[o("code",[e._v("Prefix")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("h1",{attrs:{id:"object-literals"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#object-literals","aria-hidden":"true"}},[e._v("#")]),e._v(" Object literals")]),e._v(" "),o("p",[o("a",{attrs:{id:"state"}})]),e._v(" "),o("h2",{attrs:{id:"state"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#state","aria-hidden":"true"}},[e._v("#")]),e._v(" state")]),e._v(" "),o("p",[o("strong",[e._v("state")]),e._v(": "),o("em",[o("code",[e._v("object")])])]),e._v(" "),o("p",[o("em",[e._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/Identicon.tsx#L61",target:"_blank",rel:"noopener noreferrer"}},[e._v("Identicon.tsx:61"),o("OutboundLink")],1)])]),e._v(" "),o("p",[o("a",{attrs:{id:"state.address"}})]),e._v(" "),o("h3",{attrs:{id:"address"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#address","aria-hidden":"true"}},[e._v("#")]),e._v(" address")]),e._v(" "),o("p",[o("strong",[e._v("● address")]),e._v(": "),o("em",[o("code",[e._v("null")])]),e._v(" = null")]),e._v(" "),o("p",[o("em",[e._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/Identicon.tsx#L62",target:"_blank",rel:"noopener noreferrer"}},[e._v("Identicon.tsx:62"),o("OutboundLink")],1)])]),e._v(" "),o("hr"),e._v(" "),o("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/16.814a59b4.js b/docs/assets/js/16.814a59b4.js new file mode 100644 index 00000000..eb135a96 --- /dev/null +++ b/docs/assets/js/16.814a59b4.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[16],{339:function(t,e,r){"use strict";r.r(e);var o=r(46),s=Object(o.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"colors"}})]),t._v(" "),r("h2",{attrs:{id:"colors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#colors","aria-hidden":"true"}},[t._v("#")]),t._v(" colors")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("colors")]),t._v("(seeder: "),r("em",[r("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_types_.html#seeder"}},[t._v("Seeder")])],1),t._v("): "),r("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_types_.html#colorgen"}},[t._v("ColorGen")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/colors.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("beachball/colors.ts:14"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("seeder")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_types_.html#seeder"}},[t._v("Seeder")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_types_.html#colorgen"}},[t._v("ColorGen")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/17.4319f57a.js b/docs/assets/js/17.4319f57a.js new file mode 100644 index 00000000..4a5f16fa --- /dev/null +++ b/docs/assets/js/17.4319f57a.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[17],{341:function(t,e,a){"use strict";a.r(e);var v=a(46),_=Object(v.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"container"}})]),t._v(" "),a("h2",{attrs:{id:"container"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#container","aria-hidden":"true"}},[t._v("#")]),t._v(" container")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("container")]),t._v("(diameter: "),a("em",[a("code",[t._v("number")])]),t._v(", background?: "),a("em",[a("code",[t._v("string")])]),t._v(", className?: "),a("em",[a("code",[t._v("string")])]),t._v(", _style?: "),a("em",[a("code",[t._v("object")])]),t._v("): "),a("code",[t._v("HTMLElement")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/container.ts#L6",target:"_blank",rel:"noopener noreferrer"}},[t._v("beachball/container.ts:6"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("diameter")]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[t._v("-")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" background")]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[t._v('"white"')])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" className")]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[t._v('""')])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" _style")]),t._v(" "),a("td",[a("code",[t._v("object")])]),t._v(" "),a("td",[t._v("{}")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("HTMLElement")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/18.00707b98.js b/docs/assets/js/18.00707b98.js new file mode 100644 index 00000000..300cc1c0 --- /dev/null +++ b/docs/assets/js/18.00707b98.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[18],{342:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/19.0353e250.js b/docs/assets/js/19.0353e250.js new file mode 100644 index 00000000..4c676833 --- /dev/null +++ b/docs/assets/js/19.0353e250.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[19],{344:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/2.f00ab508.js b/docs/assets/js/2.f00ab508.js new file mode 100644 index 00000000..4726c5e4 --- /dev/null +++ b/docs/assets/js/2.f00ab508.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[2],{248:function(t,e,n){"use strict";n.d(e,"d",function(){return i}),n.d(e,"a",function(){return r}),n.d(e,"j",function(){return a}),n.d(e,"i",function(){return o}),n.d(e,"f",function(){return u}),n.d(e,"g",function(){return c}),n.d(e,"h",function(){return l}),n.d(e,"b",function(){return h}),n.d(e,"e",function(){return p}),n.d(e,"l",function(){return f}),n.d(e,"m",function(){return d}),n.d(e,"c",function(){return g}),n.d(e,"k",function(){return v});const i=/#.*$/,s=/\.(md|html)$/,r=/\/$/,a=/^(https?:|mailto:|tel:)/;function o(t){return decodeURI(t).replace(i,"").replace(s,"")}function u(t){return a.test(t)}function c(t){return/^mailto:/.test(t)}function l(t){return/^tel:/.test(t)}function h(t){if(u(t))return t;const e=t.match(i),n=e?e[0]:"",s=o(t);return r.test(s)?t:s+".html"+n}function p(t,e){const n=t.hash,s=function(t){const e=t.match(i);if(e)return e[0]}(e);return(!s||n===s)&&o(t.path)===o(e)}function f(t,e,n){n&&(e=function(t,e,n){const i=t.charAt(0);if("/"===i)return t;if("?"===i||"#"===i)return e+t;const s=e.split("/");n&&s[s.length-1]||s.pop();const r=t.replace(/^\//,"").split("/");for(let t=0;t({type:"auto",title:e.title,basePath:t.path,path:t.path+"#"+e.slug,children:e.children||[]}))}]}(t);const o=a.sidebar||r.sidebar;if(o){const{base:t,config:n}=function(t,e){if(Array.isArray(e))return{base:"/",config:e};for(const i in e)if(0===(n=t,/(\.html|\/)$/.test(n)?n:n+"/").indexOf(i))return{base:i,config:e[i]};var n;return{}}(e,o);return n?n.map(e=>(function t(e,n,i,s=1){if("string"==typeof e)return f(n,e,i);if(Array.isArray(e))return Object.assign(f(n,e[0],i),{title:e[1]});{s>3&&console.error("[vuepress] detected a too deep nested sidebar group.");const r=e.children||[];return 0===r.length&&e.path?Object.assign(f(n,e.path,i),{title:e.title}):{type:"group",path:e.path,title:e.title,sidebarDepth:e.sidebarDepth,children:r.map(e=>t(e,n,i,s+1)),collapsable:!1!==e.collapsable}}})(e,s,t)):[]}return[]}function g(t){let e;return(t=t.map(t=>Object.assign({},t))).forEach(t=>{2===t.level?e=t:e&&(e.children||(e.children=[])).push(t)}),t.filter(t=>2===t.level)}function v(t){return Object.assign(t,{type:t.items&&t.items.length?"links":"link"})}},249:function(t,e,n){"use strict";var i=n(8),s=n(66)(3);i(i.P+i.F*!n(47)([].some,!0),"Array",{some:function(t){return s(this,t,arguments[1])}})},251:function(t,e,n){},252:function(t,e,n){},253:function(t,e,n){},254:function(t,e,n){},255:function(t,e,n){},256:function(t,e,n){},257:function(t,e,n){},258:function(t,e,n){},259:function(t,e,n){},260:function(t,e,n){},261:function(t,e,n){},262:function(t,e,n){},263:function(t,e,n){},265:function(t,e){t.exports="\t\n\v\f\r   ᠎             　\u2028\u2029\ufeff"},266:function(t,e,n){"use strict";var i=n(11),s=n(22),r=n(143),a=n(144);n(145)("match",1,function(t,e,n,o){return[function(n){var i=t(this),s=null==n?void 0:n[e];return void 0!==s?s.call(n,i):new RegExp(n)[e](String(i))},function(t){var e=o(n,t,this);if(e.done)return e.value;var u=i(t),c=String(this);if(!u.global)return a(u,c);var l=u.unicode;u.lastIndex=0;for(var h,p=[],f=0;null!==(h=a(u,c));){var d=String(h[0]);p[f]=d,""===d&&(u.lastIndex=r(c,s(u.lastIndex),l)),f++}return 0===f?null:p}]})},267:function(t,e,n){"use strict";n.r(e);n(249);var i=n(248),s={name:"SidebarGroup",props:["item","open","collapsable","depth"],components:{DropdownTransition:n(268).a},beforeCreate:function(){this.$options.components.SidebarLinks=n(267).default},methods:{isActive:i.e}},r=(n(294),n(46)),a=Object(r.a)(s,function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("section",{staticClass:"sidebar-group",class:[{collapsable:t.collapsable,"is-sub-group":0!==t.depth},"depth-"+t.depth]},[t.item.path?n("router-link",{staticClass:"sidebar-heading clickable",class:{open:t.open,active:t.isActive(t.$route,t.item.path)},attrs:{to:t.item.path},nativeOn:{click:function(e){return t.$emit("toggle")}}},[n("span",[t._v(t._s(t.item.title))]),t._v(" "),t.collapsable?n("span",{staticClass:"arrow",class:t.open?"down":"right"}):t._e()]):n("p",{staticClass:"sidebar-heading",class:{open:t.open},on:{click:function(e){return t.$emit("toggle")}}},[n("span",[t._v(t._s(t.item.title))]),t._v(" "),t.collapsable?n("span",{staticClass:"arrow",class:t.open?"down":"right"}):t._e()]),t._v(" "),n("DropdownTransition",[t.open||!t.collapsable?n("SidebarLinks",{staticClass:"sidebar-group-items",attrs:{items:t.item.children,sidebarDepth:t.item.sidebarDepth,depth:t.depth+1}}):t._e()],1)],1)},[],!1,null,null,null).exports;n(64);function o(t,e,n,i){return t("router-link",{props:{to:e,activeClass:"",exactActiveClass:""},class:{active:i,"sidebar-link":!0}},n)}function u(t,e,n,s,r){var a=arguments.length>5&&void 0!==arguments[5]?arguments[5]:1;return!e||a>r?null:t("ul",{class:"sidebar-sub-headers"},e.map(function(e){var c=Object(i.e)(s,n+"#"+e.slug);return t("li",{class:"sidebar-sub-header"},[o(t,n+"#"+e.slug,e.title,c),u(t,e.children,n,s,r,a+1)])}))}var c={functional:!0,props:["item","sidebarDepth"],render:function(t,e){var n=e.parent,s=n.$page,r=(n.$site,n.$route),a=n.$themeConfig,c=n.$themeLocaleConfig,l=e.props,h=l.item,p=l.sidebarDepth,f=Object(i.e)(r,h.path),d="auto"===h.type?f||h.children.some(function(t){return Object(i.e)(r,h.basePath+"#"+t.slug)}):f,g=o(t,h.path,h.title||h.path,d),v=s.frontmatter.sidebarDepth||p||c.sidebarDepth||a.sidebarDepth,m=null==v?1:v,b=c.displayAllHeaders||a.displayAllHeaders;return"auto"===h.type?[g,u(t,h.children,h.basePath,r,m)]:(d||b)&&h.headers&&!i.d.test(h.path)?[g,u(t,Object(i.c)(h.headers),h.path,r,m)]:g}};n(295);var l={name:"SidebarLinks",components:{SidebarGroup:a,SidebarLink:Object(r.a)(c,void 0,void 0,!1,null,null,null).exports},props:["items","depth","sidebarDepth"],data:function(){return{openGroupIndex:0}},created:function(){this.refreshIndex()},watch:{$route:function(){this.refreshIndex()}},methods:{refreshIndex:function(){var t=function(t,e){for(var n=0;n-1&&(this.openGroupIndex=t)},toggleGroup:function(t){this.openGroupIndex=t===this.openGroupIndex?-1:t},isActive:function(t){return Object(i.e)(this.$route,t.regularPath)}}},h=Object(r.a)(l,function(){var t=this,e=t.$createElement,n=t._self._c||e;return t.items.length?n("ul",{staticClass:"sidebar-links"},t._l(t.items,function(e,i){return n("li",{key:i},["group"===e.type?n("SidebarGroup",{attrs:{item:e,open:i===t.openGroupIndex,collapsable:e.collapsable||e.collapsible,depth:t.depth},on:{toggle:function(e){return t.toggleGroup(i)}}}):n("SidebarLink",{attrs:{sidebarDepth:t.sidebarDepth,item:e}})],1)}),0):t._e()},[],!1,null,null,null);e.default=h.exports},268:function(t,e,n){"use strict";var i={name:"DropdownTransition",methods:{setHeight:function(t){t.style.height=t.scrollHeight+"px"},unsetHeight:function(t){t.style.height=""}}},s=(n(289),n(46)),r=Object(s.a)(i,function(){var t=this.$createElement;return(this._self._c||t)("transition",{attrs:{name:"dropdown"},on:{enter:this.setHeight,"after-enter":this.unsetHeight,"before-leave":this.setHeight}},[this._t("default")],2)},[],!1,null,null,null);e.a=r.exports},270:function(t,e,n){"use strict";n(271)("link",function(t){return function(e){return t(this,"a","href",e)}})},271:function(t,e,n){var i=n(8),s=n(27),r=n(28),a=/"/g,o=function(t,e,n,i){var s=String(r(t)),o="<"+e;return""!==n&&(o+=" "+n+'="'+String(i).replace(a,""")+'"'),o+">"+s+""};t.exports=function(t,e){var n={};n[t]=e(o),i(i.P+i.F*s(function(){var e=""[t]('"');return e!==e.toLowerCase()||e.split('"').length>3}),"String",n)}},272:function(t,e,n){"use strict";var i=n(251);n.n(i).a},273:function(t,e,n){t.exports=n(274)},274:function(t,e,n){n(275),t.exports=n(0).parseInt},275:function(t,e,n){var i=n(1),s=n(276);i(i.G+i.F*(parseInt!=s),{parseInt:s})},276:function(t,e,n){var i=n(3).parseInt,s=n(277).trim,r=n(265),a=/^[-+]?0[xX]/;t.exports=8!==i(r+"08")||22!==i(r+"0x16")?function(t,e){var n=s(String(t),3);return i(n,e>>>0||(a.test(n)?16:10))}:i},277:function(t,e,n){var i=n(1),s=n(67),r=n(16),a=n(265),o="["+a+"]",u=RegExp("^"+o+o+"*"),c=RegExp(o+o+"*$"),l=function(t,e,n){var s={},o=r(function(){return!!a[t]()||"​…"!="​…"[t]()}),u=s[t]=o?e(h):a[t];n&&(s[n]=u),i(i.P+i.F*o,"String",s)},h=l.trim=function(t,e){return t=String(s(t)),1&e&&(t=t.replace(u,"")),2&e&&(t=t.replace(c,"")),t};t.exports=l},278:function(t,e,n){"use strict";var i=n(252);n.n(i).a},279:function(t,e,n){"use strict";var i=n(8),s=n(139)(!1),r=[].indexOf,a=!!r&&1/[1].indexOf(1,-0)<0;i(i.P+i.F*(a||!n(47)(r)),"Array",{indexOf:function(t){return a?r.apply(this,arguments)||0:s(this,t,arguments[1])}})},280:function(t,e,n){"use strict";n(281)("trim",function(t){return function(){return t(this,3)}})},281:function(t,e,n){var i=n(8),s=n(28),r=n(27),a=n(282),o="["+a+"]",u=RegExp("^"+o+o+"*"),c=RegExp(o+o+"*$"),l=function(t,e,n){var s={},o=r(function(){return!!a[t]()||"​…"!="​…"[t]()}),u=s[t]=o?e(h):a[t];n&&(s[n]=u),i(i.P+i.F*o,"String",s)},h=l.trim=function(t,e){return t=String(s(t)),1&e&&(t=t.replace(u,"")),2&e&&(t=t.replace(c,"")),t};t.exports=l},282:function(t,e){t.exports="\t\n\v\f\r   ᠎             　\u2028\u2029\ufeff"},283:function(t,e,n){"use strict";var i=n(253);n.n(i).a},284:function(t,e,n){var i=n(5),s=n(285),r=n(29).f,a=n(288).f,o=n(142),u=n(146),c=i.RegExp,l=c,h=c.prototype,p=/a/g,f=/a/g,d=new c(p)!==p;if(n(21)&&(!d||n(27)(function(){return f[n(2)("match")]=!1,c(p)!=p||c(f)==f||"/a/i"!=c(p,"i")}))){c=function(t,e){var n=this instanceof c,i=o(t),r=void 0===e;return!n&&i&&t.constructor===c&&r?t:s(d?new l(i&&!r?t.source:t,e):l((i=t instanceof c)?t.source:t,i&&r?u.call(t):e),n?this:h,c)};for(var g=function(t){t in c||r(c,t,{configurable:!0,get:function(){return l[t]},set:function(e){l[t]=e}})},v=a(l),m=0;v.length>m;)g(v[m++]);h.constructor=c,c.prototype=h,n(30)(i,"RegExp",c)}n(140)("RegExp")},285:function(t,e,n){var i=n(15),s=n(286).set;t.exports=function(t,e,n){var r,a=e.constructor;return a!==n&&"function"==typeof a&&(r=a.prototype)!==n.prototype&&i(r)&&s&&s(t,r),t}},286:function(t,e,n){var i=n(15),s=n(11),r=function(t,e){if(s(t),!i(e)&&null!==e)throw TypeError(e+": can't set as prototype!")};t.exports={set:Object.setPrototypeOf||("__proto__"in{}?function(t,e,i){try{(i=n(31)(Function.call,n(287).f(Object.prototype,"__proto__").set,2))(t,[]),e=!(t instanceof Array)}catch(t){e=!0}return function(t,n){return r(t,n),e?t.__proto__=n:i(t,n),t}}({},!1):void 0),check:r}},287:function(t,e,n){var i=n(141),s=n(98),r=n(65),a=n(137),o=n(48),u=n(136),c=Object.getOwnPropertyDescriptor;e.f=n(21)?c:function(t,e){if(t=r(t),e=a(e,!0),u)try{return c(t,e)}catch(t){}if(o(t,e))return s(!i.f.call(t,e),t[e])}},288:function(t,e,n){var i=n(138),s=n(99).concat("length","prototype");e.f=Object.getOwnPropertyNames||function(t){return i(t,s)}},289:function(t,e,n){"use strict";var i=n(254);n.n(i).a},290:function(t,e,n){"use strict";var i=n(255);n.n(i).a},291:function(t,e,n){"use strict";var i=n(256);n.n(i).a},292:function(t,e,n){"use strict";var i=n(257);n.n(i).a},293:function(t,e,n){"use strict";var i=n(258);n.n(i).a},294:function(t,e,n){"use strict";var i=n(259);n.n(i).a},295:function(t,e,n){"use strict";var i=n(260);n.n(i).a},296:function(t,e,n){"use strict";var i=n(261);n.n(i).a},297:function(t,e,n){"use strict";var i=n(262);n.n(i).a},298:function(t,e,n){"use strict";var i=n(263);n.n(i).a},300:function(t,e,n){"use strict";n.r(e);var i=n(43),s=n.n(i),r=(n(249),n(270),n(248)),a={props:{item:{required:!0}},computed:{link:function(){return Object(r.b)(this.item.link)},exact:function(){var t=this;return this.$site.locales?s()(this.$site.locales).some(function(e){return e===t.link}):"/"===this.link}},methods:{isExternal:r.f,isMailto:r.g,isTel:r.h}},o=n(46),u=Object(o.a)(a,function(){var t=this,e=t.$createElement,n=t._self._c||e;return t.isExternal(t.link)?n("a",{staticClass:"nav-link external",attrs:{href:t.link,target:t.isMailto(t.link)||t.isTel(t.link)?null:"_blank",rel:t.isMailto(t.link)||t.isTel(t.link)?null:"noopener noreferrer"}},[t._v("\n "+t._s(t.item.text)+"\n "),n("OutboundLink")],1):n("router-link",{staticClass:"nav-link",attrs:{to:t.link,exact:t.exact}},[t._v(t._s(t.item.text))])},[],!1,null,null,null).exports,c={components:{NavLink:u},computed:{data:function(){return this.$page.frontmatter},actionLink:function(){return{link:this.data.actionLink,text:this.data.actionText}}}},l=(n(272),Object(o.a)(c,function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("main",{staticClass:"home",attrs:{"aria-labelledby":"main-title"}},[n("header",{staticClass:"hero"},[t.data.heroImage?n("img",{attrs:{src:t.$withBase(t.data.heroImage),alt:"hero"}}):t._e(),t._v(" "),n("h1",{attrs:{id:"main-title"}},[t._v(t._s(t.data.heroText||t.$title||"Hello"))]),t._v(" "),n("p",{staticClass:"description"},[t._v("\n "+t._s(t.data.tagline||t.$description||"Welcome to your VuePress site")+"\n ")]),t._v(" "),t.data.actionText&&t.data.actionLink?n("p",{staticClass:"action"},[n("NavLink",{staticClass:"action-button",attrs:{item:t.actionLink}})],1):t._e()]),t._v(" "),t.data.features&&t.data.features.length?n("div",{staticClass:"features"},t._l(t.data.features,function(e,i){return n("div",{key:i,staticClass:"feature"},[n("h2",[t._v(t._s(e.title))]),t._v(" "),n("p",[t._v(t._s(e.details))])])}),0):t._e(),t._v(" "),n("Content",{staticClass:"custom"}),t._v(" "),t.data.footer?n("div",{staticClass:"footer"},[t._v("\n "+t._s(t.data.footer)+"\n ")]):t._e()],1)},[],!1,null,null,null).exports),h=n(273),p=n.n(h),f=(n(278),Object(o.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("div",{staticClass:"sidebar-button",on:{click:function(e){return t.$emit("toggle-sidebar")}}},[n("svg",{staticClass:"icon",attrs:{xmlns:"http://www.w3.org/2000/svg","aria-hidden":"true",role:"img",viewBox:"0 0 448 512"}},[n("path",{attrs:{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"}})])])},[],!1,null,null,null).exports),d=(n(266),n(68),n(114)),g=n.n(d),v=n(20),m=n.n(v),b=(n(279),n(280),{data:function(){return{query:"",focused:!1,focusIndex:0}},computed:{showSuggestions:function(){return this.focused&&this.suggestions&&this.suggestions.length},suggestions:function(){var t=this.query.trim().toLowerCase();if(t){for(var e=this.$site.pages,n=this.$localePath,i=function(e){return e.title&&e.title.toLowerCase().indexOf(t)>-1},s=[],r=0;r=5);r++){var a=e[r];if(this.getPageLocalePath(a)===n&&this.isSearchable(a))if(i(a))s.push(a);else if(a.headers)for(var o=0;o=5);o++){var u=a.headers[o];i(u)&&s.push(m()({},a,{path:a.path+"#"+u.slug,header:u}))}}return s}},alignRight:function(){return(this.$site.themeConfig.nav||[]).length+(this.$site.repo?1:0)<=2}},methods:{getPageLocalePath:function(t){for(var e in this.$site.locales||{})if("/"!==e&&0===t.path.indexOf(e))return e;return"/"},isSearchable:function(t){var e=null;return null===e||(e=g()(e)?e:new Array(e)).filter(function(e){return t.path.match(e)}).length>0},onUp:function(){this.showSuggestions&&(this.focusIndex>0?this.focusIndex--:this.focusIndex=this.suggestions.length-1)},onDown:function(){this.showSuggestions&&(this.focusIndex "+t._s(e.header.title))]):t._e()])])}),0):t._e()])},[],!1,null,null,null).exports),k=(n(284),n(61)),x=(n(135),n(64),{components:{NavLink:u,DropdownTransition:n(268).a},data:function(){return{open:!1}},props:{item:{required:!0}},methods:{toggle:function(){this.open=!this.open}}}),$=(n(290),{components:{NavLink:u,DropdownLink:Object(o.a)(x,function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("div",{staticClass:"dropdown-wrapper",class:{open:t.open}},[n("a",{staticClass:"dropdown-title",on:{click:t.toggle}},[n("span",{staticClass:"title"},[t._v(t._s(t.item.text))]),t._v(" "),n("span",{staticClass:"arrow",class:t.open?"down":"right"})]),t._v(" "),n("DropdownTransition",[n("ul",{directives:[{name:"show",rawName:"v-show",value:t.open,expression:"open"}],staticClass:"nav-dropdown"},t._l(t.item.items,function(e,i){return n("li",{key:e.link||i,staticClass:"dropdown-item"},["links"===e.type?n("h4",[t._v(t._s(e.text))]):t._e(),t._v(" "),"links"===e.type?n("ul",{staticClass:"dropdown-subitem-wrapper"},t._l(e.items,function(t){return n("li",{key:t.link,staticClass:"dropdown-subitem"},[n("NavLink",{attrs:{item:t}})],1)}),0):n("NavLink",{attrs:{item:e}})],1)}),0)])],1)},[],!1,null,null,null).exports},computed:{userNav:function(){return this.$themeLocaleConfig.nav||this.$site.themeConfig.nav||[]},nav:function(){var t=this,e=this.$site.locales;if(e&&s()(e).length>1){var n=this.$page.path,i=this.$router.options.routes,r=this.$site.themeConfig.locales||{},a={text:this.$themeLocaleConfig.selectText||"Languages",items:s()(e).map(function(s){var a,o=e[s],u=r[s]&&r[s].label||o.lang;return o.lang===t.$lang?a=n:(a=n.replace(t.$localeConfig.path,s),i.some(function(t){return t.path===a})||(a=s)),{text:u,link:a}})};return[].concat(Object(k.a)(this.userNav),[a])}return this.userNav},userLinks:function(){return(this.nav||[]).map(function(t){return m()(Object(r.k)(t),{items:(t.items||[]).map(r.k)})})},repoLink:function(){var t=this.$site.themeConfig.repo;if(t)return/^https?:/.test(t)?t:"https://github.com/".concat(t)},repoLabel:function(){if(this.repoLink){if(this.$site.themeConfig.repoLabel)return this.$site.themeConfig.repoLabel;for(var t=this.repoLink.match(/^https?:\/\/[^\/]+/)[0],e=["GitHub","GitLab","Bitbucket"],n=0;nMath.abs(n)&&Math.abs(e)>40&&(e>0&&this.touchStart.x<=80?this.toggleSidebar(!0):this.toggleSidebar(!1))}}}),T=(n(297),n(298),Object(o.a)(E,function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("div",{staticClass:"theme-container",class:t.pageClasses,on:{touchstart:t.onTouchStart,touchend:t.onTouchEnd}},[t.shouldShowNavbar?n("Navbar",{on:{"toggle-sidebar":t.toggleSidebar}}):t._e(),t._v(" "),n("div",{staticClass:"sidebar-mask",on:{click:function(e){return t.toggleSidebar(!1)}}}),t._v(" "),n("Sidebar",{attrs:{items:t.sidebarItems},on:{"toggle-sidebar":t.toggleSidebar}},[t._t("sidebar-top",null,{slot:"top"}),t._v(" "),t._t("sidebar-bottom",null,{slot:"bottom"})],2),t._v(" "),t.$page.frontmatter.home?n("Home"):n("Page",{attrs:{"sidebar-items":t.sidebarItems}},[t._t("page-top",null,{slot:"top"}),t._v(" "),t._t("page-bottom",null,{slot:"bottom"})],2)],1)},[],!1,null,null,null));e.default=T.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/20.f2154956.js b/docs/assets/js/20.f2154956.js new file mode 100644 index 00000000..01b09228 --- /dev/null +++ b/docs/assets/js/20.f2154956.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[20],{345:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"seeder"}})]),e._v(" "),r("h2",{attrs:{id:"seeder"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#seeder","aria-hidden":"true"}},[e._v("#")]),e._v(" seeder")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("seeder")]),e._v("(_seed?: "),r("em",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_types_.html#seeder"}},[e._v("Seeder")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/seeder.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[e._v("beachball/seeder.ts:11"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" _seed")]),e._v(" "),r("td",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("td",[e._v("new Uint8Array(32)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_types_.html#seeder"}},[e._v("Seeder")])],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/21.d98322fa.js b/docs/assets/js/21.d98322fa.js new file mode 100644 index 00000000..a55a3400 --- /dev/null +++ b/docs/assets/js/21.d98322fa.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[21],{348:function(e,t,r){"use strict";r.r(t);var _=r(46),n=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"circle"}})]),e._v(" "),r("h2",{attrs:{id:"circle"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#circle","aria-hidden":"true"}},[e._v("#")]),e._v(" circle")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("circle")]),e._v("(seeder: "),r("em",[r("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_types_.html#seeder"}},[e._v("Seeder")])],1),e._v(", fill: "),r("em",[r("code",[e._v("string")])]),e._v(", diameter: "),r("em",[r("code",[e._v("number")])]),e._v(", count: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Element")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/shape/circle.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[e._v("beachball/shape/circle.ts:11"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("seeder")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_types_.html#seeder"}},[e._v("Seeder")])],1)]),e._v(" "),r("tr",[r("td",[e._v("fill")]),e._v(" "),r("td",[r("code",[e._v("string")])])]),e._v(" "),r("tr",[r("td",[e._v("diameter")]),e._v(" "),r("td",[r("code",[e._v("number")])])]),e._v(" "),r("tr",[r("td",[e._v("count")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Element")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/22.11f02f68.js b/docs/assets/js/22.11f02f68.js new file mode 100644 index 00000000..f04e2be6 --- /dev/null +++ b/docs/assets/js/22.11f02f68.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[22],{347:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"square"}})]),e._v(" "),r("h2",{attrs:{id:"square"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#square","aria-hidden":"true"}},[e._v("#")]),e._v(" square")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("square")]),e._v("(seeder: "),r("em",[r("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_types_.html#seeder"}},[e._v("Seeder")])],1),e._v(", fill: "),r("em",[r("code",[e._v("string")])]),e._v(", diameter: "),r("em",[r("code",[e._v("number")])]),e._v(", count: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Element")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/shape/square.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[e._v("beachball/shape/square.ts:11"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("seeder")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_types_.html#seeder"}},[e._v("Seeder")])],1)]),e._v(" "),r("tr",[r("td",[e._v("fill")]),e._v(" "),r("td",[r("code",[e._v("string")])])]),e._v(" "),r("tr",[r("td",[e._v("diameter")]),e._v(" "),r("td",[r("code",[e._v("number")])])]),e._v(" "),r("tr",[r("td",[e._v("count")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Element")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/23.7e342d4b.js b/docs/assets/js/23.7e342d4b.js new file mode 100644 index 00000000..23cf9be3 --- /dev/null +++ b/docs/assets/js/23.7e342d4b.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[23],{351:function(e,t,r){"use strict";r.r(t);var n=r(46),c=Object(n.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"circle"}})]),e._v(" "),r("h2",{attrs:{id:"circle"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#circle","aria-hidden":"true"}},[e._v("#")]),e._v(" circle")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("circle")]),e._v("(r: "),r("em",[r("code",[e._v("number")])]),e._v(", cx: "),r("em",[r("code",[e._v("number")])]),e._v(", cy: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Element")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/svg/circle.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[e._v("beachball/svg/circle.ts:7"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("r")]),e._v(" "),r("td",[r("code",[e._v("number")])])]),e._v(" "),r("tr",[r("td",[e._v("cx")]),e._v(" "),r("td",[r("code",[e._v("number")])])]),e._v(" "),r("tr",[r("td",[e._v("cy")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Element")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=c.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/24.09820451.js b/docs/assets/js/24.09820451.js new file mode 100644 index 00000000..3ce4f277 --- /dev/null +++ b/docs/assets/js/24.09820451.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[24],{350:function(e,t,v){"use strict";v.r(t);var _=v(46),n=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("h1",{attrs:{id:"functions"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),v("p",[v("a",{attrs:{id:"element"}})]),e._v(" "),v("h2",{attrs:{id:"element"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#element","aria-hidden":"true"}},[e._v("#")]),e._v(" element")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("element")]),e._v("(size: "),v("em",[v("code",[e._v("number")])]),e._v(", type?: "),v("em",[v("code",[e._v("string")])]),e._v(", x?: "),v("em",[v("code",[e._v("number")])]),e._v(", y?: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Element")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/svg/element.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[e._v("beachball/svg/element.ts:8"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Default value")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("size")]),e._v(" "),v("td",[v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("-")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Default value")]),e._v(" type")]),e._v(" "),v("td",[v("code",[e._v("string")])]),e._v(" "),v("td",[e._v('"svg"')])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Default value")]),e._v(" x")]),e._v(" "),v("td",[v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("0")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Default value")]),e._v(" y")]),e._v(" "),v("td",[v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("0")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Element")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/25.1bd9b377.js b/docs/assets/js/25.1bd9b377.js new file mode 100644 index 00000000..28595211 --- /dev/null +++ b/docs/assets/js/25.1bd9b377.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[25],{353:function(t,e,r){"use strict";r.r(e);var a=r(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"rect"}})]),t._v(" "),r("h2",{attrs:{id:"rect"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rect","aria-hidden":"true"}},[t._v("#")]),t._v(" rect")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("rect")]),t._v("(size: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("Element")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/svg/rect.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("beachball/svg/rect.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("size")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Element")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/26.7b3990eb.js b/docs/assets/js/26.7b3990eb.js new file mode 100644 index 00000000..85504b7b --- /dev/null +++ b/docs/assets/js/26.7b3990eb.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{354:function(t,e,s){"use strict";s.r(e);var r=s(46),a=Object(r.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"svg"}})]),t._v(" "),s("h2",{attrs:{id:"svg"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#svg","aria-hidden":"true"}},[t._v("#")]),t._v(" svg")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("svg")]),t._v("(type: "),s("em",[s("code",[t._v("string")])]),t._v("): "),s("code",[t._v("Element")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/svg/svg.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("beachball/svg/svg.ts:8"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("type")]),t._v(" "),s("td",[s("code",[t._v("string")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Element")])]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/27.dd6dd743.js b/docs/assets/js/27.dd6dd743.js new file mode 100644 index 00000000..6538af84 --- /dev/null +++ b/docs/assets/js/27.dd6dd743.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{357:function(e,t,a){"use strict";a.r(t);var r=a(46),n=Object(r.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("p",[a("a",{attrs:{id:"colorgen"}})]),e._v(" "),a("h2",{attrs:{id:"colorgen"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#colorgen","aria-hidden":"true"}},[e._v("#")]),e._v(" ColorGen")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ ColorGen")]),e._v(": "),a("em",[a("code",[e._v("function")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/types.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[e._v("beachball/types.ts:7"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("p",[e._v("▸(alpha?: "),a("em",[a("code",[e._v("undefined")]),e._v(" | "),a("code",[e._v("number")])]),e._v("): "),a("code",[e._v("string")])]),e._v(" "),a("p",[a("strong",[e._v("Parameters:")])]),e._v(" "),a("table",[a("thead",[a("tr",[a("th",[e._v("Name")]),e._v(" "),a("th",[e._v("Type")])])]),e._v(" "),a("tbody",[a("tr",[a("td",[a("code",[e._v("Optional")]),e._v(" alpha")]),e._v(" "),a("td",[a("code",[e._v("undefined")]),e._v(" | "),a("code",[e._v("number")])])])])]),e._v(" "),a("p",[a("strong",[e._v("Returns:")]),e._v(" "),a("code",[e._v("string")])]),e._v(" "),a("hr"),e._v(" "),a("p",[a("a",{attrs:{id:"seeder"}})]),e._v(" "),a("h2",{attrs:{id:"seeder"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#seeder","aria-hidden":"true"}},[e._v("#")]),e._v(" Seeder")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ Seeder")]),e._v(": "),a("em",[a("code",[e._v("function")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[e._v("beachball/types.ts:5"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("p",[e._v("▸(): "),a("code",[e._v("number")])]),e._v(" "),a("p",[a("strong",[e._v("Returns:")]),e._v(" "),a("code",[e._v("number")])]),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/28.233b0f0a.js b/docs/assets/js/28.233b0f0a.js new file mode 100644 index 00000000..9d228d56 --- /dev/null +++ b/docs/assets/js/28.233b0f0a.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[28],{356:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/ui-identicon/classes/_demo_.demo.html"}},[t._v("Demo")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/29.a6937576.js b/docs/assets/js/29.a6937576.js new file mode 100644 index 00000000..5862ec35 --- /dev/null +++ b/docs/assets/js/29.a6937576.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[29],{359:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/ui-identicon/classes/_icons_beachball_.beachball.html"}},[t._v("Beachball")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/3.59687fa1.js b/docs/assets/js/3.59687fa1.js new file mode 100644 index 00000000..50c42f57 --- /dev/null +++ b/docs/assets/js/3.59687fa1.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[3],{250:function(t,e,s){},269:function(t,e,s){"use strict";var n=s(250);s.n(n).a},301:function(t,e,s){"use strict";s.r(e);var n=["There's nothing here.","How did we get here?","That's a Four-Oh-Four.","Looks like we've got some broken links."],o={methods:{getMsg:function(){return n[Math.floor(Math.random()*n.length)]}}},i=(s(269),s(46)),r=Object(i.a)(o,function(){var t=this.$createElement,e=this._self._c||t;return e("div",{staticClass:"theme-container"},[e("div",{staticClass:"content"},[e("h1",[this._v("404")]),this._v(" "),e("blockquote",[this._v(this._s(this.getMsg()))]),this._v(" "),e("router-link",{attrs:{to:"/"}},[this._v("Take me home.")])],1)])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/30.328e9c48.js b/docs/assets/js/30.328e9c48.js new file mode 100644 index 00000000..82d1bec4 --- /dev/null +++ b/docs/assets/js/30.328e9c48.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[30],{360:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/ui-identicon/classes/_icons_empty_.empty.html"}},[t._v("Empty")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/31.cb7914e9.js b/docs/assets/js/31.cb7914e9.js new file mode 100644 index 00000000..26080b1e --- /dev/null +++ b/docs/assets/js/31.cb7914e9.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[31],{362:function(t,e,s){"use strict";s.r(e);var n=s(46),a=Object(n.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/ui-identicon/classes/_icons_jdenticon_.jdenticon.html"}},[t._v("Jdenticon")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/32.665882f2.js b/docs/assets/js/32.665882f2.js new file mode 100644 index 00000000..4781d548 --- /dev/null +++ b/docs/assets/js/32.665882f2.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[32],{364:function(t,e,s){"use strict";s.r(e);var a=s(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/ui-identicon/classes/_icons_polkadot_.identicon.html"}},[t._v("Identicon")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/33.df108508.js b/docs/assets/js/33.df108508.js new file mode 100644 index 00000000..2391b29c --- /dev/null +++ b/docs/assets/js/33.df108508.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{361:function(t,e,s){"use strict";s.r(e);var a=s(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/ui-identicon/classes/_identicon_.identityicon.html"}},[t._v("IdentityIcon")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/34.b3c60c46.js b/docs/assets/js/34.b3c60c46.js new file mode 100644 index 00000000..c6a14ab2 --- /dev/null +++ b/docs/assets/js/34.b3c60c46.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[34],{358:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-aliases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),r("p",[r("a",{attrs:{id:"baseprops"}})]),t._v(" "),r("h2",{attrs:{id:"baseprops"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#baseprops","aria-hidden":"true"}},[t._v("#")]),t._v(" BaseProps")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ BaseProps")]),t._v(": "),r("em",[r("code",[t._v("object")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/types.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"identityprops"}})]),t._v(" "),r("h2",{attrs:{id:"identityprops"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#identityprops","aria-hidden":"true"}},[t._v("#")]),t._v(" IdentityProps")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ IdentityProps")]),t._v(": "),r("em",[r("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#baseprops"}},[t._v("BaseProps")]),t._v(" & "),r("code",[t._v("object")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/types.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"props"}})]),t._v(" "),r("h2",{attrs:{id:"props"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#props","aria-hidden":"true"}},[t._v("#")]),t._v(" Props")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ Props")]),t._v(": "),r("em",[r("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html#baseprops"}},[t._v("BaseProps")]),t._v(" & "),r("code",[t._v("object")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/types.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:14"),r("OutboundLink")],1)])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/35.29dac2f1.js b/docs/assets/js/35.29dac2f1.js new file mode 100644 index 00000000..803b9e91 --- /dev/null +++ b/docs/assets/js/35.29dac2f1.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[35],{352:function(s,t,a){"use strict";a.r(t);var n=a(46),e=Object(n.a)({},function(){var s=this,t=s.$createElement,a=s._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":s.$parent.slotKey}},[a("h1",{attrs:{id:"polkadot-ui-keyring"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-ui-keyring","aria-hidden":"true"}},[s._v("#")]),s._v(" @polkadot/ui-keyring")]),s._v(" "),a("p",[s._v("A wrapper extending the base @polkadot/keyring interface for usage in the browser: Key management of user accounts including generation and retrieval of keyring pairs from a variety of input combinations.")]),s._v(" "),a("h2",{attrs:{id:"usage-examples"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#usage-examples","aria-hidden":"true"}},[s._v("#")]),s._v(" Usage Examples")]),s._v(" "),a("p",[s._v("All module methods are exposed through a single default export.")]),s._v(" "),a("h3",{attrs:{id:"regular"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#regular","aria-hidden":"true"}},[s._v("#")]),s._v(" Regular")]),s._v(" "),a("div",{staticClass:"language-js line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-js"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" keyring "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" @polkadot"),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("/")]),s._v("ui"),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("-")]),s._v("keyring\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("render")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("// encode publicKey to ss58 address")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("const")]),s._v(" address "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),s._v(" keyring"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("encodeAddress")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),s._v("publicKey"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("// get keyring pair from ss58 address")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("const")]),s._v(" pair "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),s._v(" keyring"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("getPair")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),s._v("address"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("// ask questions about that particular keyring pair")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("const")]),s._v(" isLocked "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),s._v(" pair"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("isLocked")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("const")]),s._v(" meta "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),s._v(" pair"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("getMeta")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("// save account from pair")]),s._v("\n keyring"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("saveAccount")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),s._v("pair"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(",")]),s._v(" password"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("// save address without unlocking it")]),s._v("\n keyring"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("saveAddress")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),s._v("address"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(",")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("...")]),s._v("meta "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v("\n")])]),s._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[s._v("1")]),a("br"),a("span",{staticClass:"line-number"},[s._v("2")]),a("br"),a("span",{staticClass:"line-number"},[s._v("3")]),a("br"),a("span",{staticClass:"line-number"},[s._v("4")]),a("br"),a("span",{staticClass:"line-number"},[s._v("5")]),a("br"),a("span",{staticClass:"line-number"},[s._v("6")]),a("br"),a("span",{staticClass:"line-number"},[s._v("7")]),a("br"),a("span",{staticClass:"line-number"},[s._v("8")]),a("br"),a("span",{staticClass:"line-number"},[s._v("9")]),a("br"),a("span",{staticClass:"line-number"},[s._v("10")]),a("br"),a("span",{staticClass:"line-number"},[s._v("11")]),a("br"),a("span",{staticClass:"line-number"},[s._v("12")]),a("br"),a("span",{staticClass:"line-number"},[s._v("13")]),a("br"),a("span",{staticClass:"line-number"},[s._v("14")]),a("br"),a("span",{staticClass:"line-number"},[s._v("15")]),a("br"),a("span",{staticClass:"line-number"},[s._v("16")]),a("br"),a("span",{staticClass:"line-number"},[s._v("17")]),a("br"),a("span",{staticClass:"line-number"},[s._v("18")]),a("br"),a("span",{staticClass:"line-number"},[s._v("19")]),a("br")])]),a("h2",{attrs:{id:"observables"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#observables","aria-hidden":"true"}},[s._v("#")]),s._v(" Observables")]),s._v(" "),a("p",[s._v("Option 1: Declarative subscribe/unsubscribe w/ react-with-observable (recommended 'React' way)")]),s._v(" "),a("div",{staticClass:"language-js line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-js"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" accountObservable "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'@polkadot/ui-keyring/observable/accounts'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v(" SingleAddress"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(",")]),s._v(" SubjectInfo "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'@polkadot/ui-keyring/observable/types'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" React "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'react'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v(" Subscribe "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'react-with-observable'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v(" map "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'rxjs/operators'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("class")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[s._v("MyReactComponent")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("extends")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[s._v("React"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),s._v("PureComponent")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("render")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("<")]),s._v("Subscribe"),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v(">")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v("accountObservable"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),s._v("subject"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("pipe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("map")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),s._v("allAccounts"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(":")]),s._v(" SubjectInfo"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=>")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("!")]),s._v("allAccounts\n "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("?")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("this")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("renderEmpty")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(":")]),s._v(" Object"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("values")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),s._v("allAccounts"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("map")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),s._v("account"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(":")]),s._v(" SingleAddress"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=>")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("// Your component goes here")]),s._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),s._v("account"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),s._v("json"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),s._v("address"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("<")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("/")]),s._v("Subscribe"),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v(">")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v("\n\n "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("renderEmpty")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("return")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("<")]),s._v("div"),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v(">")]),s._v(" no accounts to display "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("...")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("<")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("/")]),s._v("div"),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v(">")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v("\n\n")])]),s._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[s._v("1")]),a("br"),a("span",{staticClass:"line-number"},[s._v("2")]),a("br"),a("span",{staticClass:"line-number"},[s._v("3")]),a("br"),a("span",{staticClass:"line-number"},[s._v("4")]),a("br"),a("span",{staticClass:"line-number"},[s._v("5")]),a("br"),a("span",{staticClass:"line-number"},[s._v("6")]),a("br"),a("span",{staticClass:"line-number"},[s._v("7")]),a("br"),a("span",{staticClass:"line-number"},[s._v("8")]),a("br"),a("span",{staticClass:"line-number"},[s._v("9")]),a("br"),a("span",{staticClass:"line-number"},[s._v("10")]),a("br"),a("span",{staticClass:"line-number"},[s._v("11")]),a("br"),a("span",{staticClass:"line-number"},[s._v("12")]),a("br"),a("span",{staticClass:"line-number"},[s._v("13")]),a("br"),a("span",{staticClass:"line-number"},[s._v("14")]),a("br"),a("span",{staticClass:"line-number"},[s._v("15")]),a("br"),a("span",{staticClass:"line-number"},[s._v("16")]),a("br"),a("span",{staticClass:"line-number"},[s._v("17")]),a("br"),a("span",{staticClass:"line-number"},[s._v("18")]),a("br"),a("span",{staticClass:"line-number"},[s._v("19")]),a("br"),a("span",{staticClass:"line-number"},[s._v("20")]),a("br"),a("span",{staticClass:"line-number"},[s._v("21")]),a("br"),a("span",{staticClass:"line-number"},[s._v("22")]),a("br"),a("span",{staticClass:"line-number"},[s._v("23")]),a("br"),a("span",{staticClass:"line-number"},[s._v("24")]),a("br"),a("span",{staticClass:"line-number"},[s._v("25")]),a("br"),a("span",{staticClass:"line-number"},[s._v("26")]),a("br"),a("span",{staticClass:"line-number"},[s._v("27")]),a("br"),a("span",{staticClass:"line-number"},[s._v("28")]),a("br")])]),a("p",[s._v("Option 2: Imperative subscribe/unsubscribe")]),s._v(" "),a("div",{staticClass:"language-js line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-js"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" accountObservable "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'@polkadot/ui-keyring/observable/accounts'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v(" SingleAddress"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(",")]),s._v(" SubjectInfo "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'@polkadot/ui-keyring/observable/types'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" React "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'react'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v(" Subscription "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'rxjs'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n\ntype State "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v("\n allAccounts"),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("?")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(":")]),s._v(" SubjectInfo"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(",")]),s._v("\n subscriptions"),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("?")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(":")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("[")]),s._v("Subscription"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("]")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("class")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[s._v("MyReactComponent")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("extends")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[s._v("React"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),s._v("PureComponent")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("<")]),s._v("State"),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v(">")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("componentDidMount")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("const")]),s._v(" accountSubscription "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),s._v(" accountObservable"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),s._v("subject"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("subscribe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),s._v("observedAccounts"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=>")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("this")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("setState")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v("\n accounts"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(":")]),s._v(" observedAccounts\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),s._v("\n\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("this")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("setState")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v("\n subscriptions"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(":")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("[")]),s._v("accountSubscription"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("]")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v("\n\n "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("componentWillUnmount")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("const")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v(" subscriptions "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("this")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),s._v("state"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("for")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),s._v("s "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("in")]),s._v(" subscriptions"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v("\n s"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),s._v("subject"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("unsubscribe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v("\n\n "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("render")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("const")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v(" accounts "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("this")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),s._v("state"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("return")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("<")]),s._v("h1"),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v(">")]),s._v("All Accounts"),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("<")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("/")]),s._v("h1"),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v(">")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v("\n Object"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("keys")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),s._v("accounts"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("map")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),s._v("address"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(":")]),s._v(" SingleAddress"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=>")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("return")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("<")]),s._v("p"),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v(">")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v("address"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("<")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("/")]),s._v("p"),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v(">")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v("\n")])]),s._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[s._v("1")]),a("br"),a("span",{staticClass:"line-number"},[s._v("2")]),a("br"),a("span",{staticClass:"line-number"},[s._v("3")]),a("br"),a("span",{staticClass:"line-number"},[s._v("4")]),a("br"),a("span",{staticClass:"line-number"},[s._v("5")]),a("br"),a("span",{staticClass:"line-number"},[s._v("6")]),a("br"),a("span",{staticClass:"line-number"},[s._v("7")]),a("br"),a("span",{staticClass:"line-number"},[s._v("8")]),a("br"),a("span",{staticClass:"line-number"},[s._v("9")]),a("br"),a("span",{staticClass:"line-number"},[s._v("10")]),a("br"),a("span",{staticClass:"line-number"},[s._v("11")]),a("br"),a("span",{staticClass:"line-number"},[s._v("12")]),a("br"),a("span",{staticClass:"line-number"},[s._v("13")]),a("br"),a("span",{staticClass:"line-number"},[s._v("14")]),a("br"),a("span",{staticClass:"line-number"},[s._v("15")]),a("br"),a("span",{staticClass:"line-number"},[s._v("16")]),a("br"),a("span",{staticClass:"line-number"},[s._v("17")]),a("br"),a("span",{staticClass:"line-number"},[s._v("18")]),a("br"),a("span",{staticClass:"line-number"},[s._v("19")]),a("br"),a("span",{staticClass:"line-number"},[s._v("20")]),a("br"),a("span",{staticClass:"line-number"},[s._v("21")]),a("br"),a("span",{staticClass:"line-number"},[s._v("22")]),a("br"),a("span",{staticClass:"line-number"},[s._v("23")]),a("br"),a("span",{staticClass:"line-number"},[s._v("24")]),a("br"),a("span",{staticClass:"line-number"},[s._v("25")]),a("br"),a("span",{staticClass:"line-number"},[s._v("26")]),a("br"),a("span",{staticClass:"line-number"},[s._v("27")]),a("br"),a("span",{staticClass:"line-number"},[s._v("28")]),a("br"),a("span",{staticClass:"line-number"},[s._v("29")]),a("br"),a("span",{staticClass:"line-number"},[s._v("30")]),a("br"),a("span",{staticClass:"line-number"},[s._v("31")]),a("br"),a("span",{staticClass:"line-number"},[s._v("32")]),a("br"),a("span",{staticClass:"line-number"},[s._v("33")]),a("br"),a("span",{staticClass:"line-number"},[s._v("34")]),a("br"),a("span",{staticClass:"line-number"},[s._v("35")]),a("br"),a("span",{staticClass:"line-number"},[s._v("36")]),a("br"),a("span",{staticClass:"line-number"},[s._v("37")]),a("br"),a("span",{staticClass:"line-number"},[s._v("38")]),a("br"),a("span",{staticClass:"line-number"},[s._v("39")]),a("br"),a("span",{staticClass:"line-number"},[s._v("40")]),a("br"),a("span",{staticClass:"line-number"},[s._v("41")]),a("br"),a("span",{staticClass:"line-number"},[s._v("42")]),a("br"),a("span",{staticClass:"line-number"},[s._v("43")]),a("br"),a("span",{staticClass:"line-number"},[s._v("44")]),a("br")])]),a("h2",{attrs:{id:"faq"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#faq","aria-hidden":"true"}},[s._v("#")]),s._v(" FAQ")]),s._v(" "),a("ul",[a("li",[s._v("Difference between Keyring Accounts and Addresses?\n"),a("ul",[a("li",[s._v("From the perspective of the keyring, it saves a particular user's unlocked identities as an account, a la keyring.saveAccount(pair, password). So with these accounts you are able to send and sign transactions.")]),s._v(" "),a("li",[s._v("To save addresses without unlocking them (i.e. because a user might want to have easy access to addresses they frequently transact with), use keyring.saveAddress(address, meta)")])])]),s._v(" "),a("li",[s._v("What are 'external' accounts, i.e. when to set the "),a("code",[s._v("isExternal")]),s._v(" meta key to true?\n"),a("ul",[a("li",[s._v("An external account is one where the keys are not managed by keyring, e.g. in Parity Signer or Ledger Nano.")])])]),s._v(" "),a("li",[s._v("SS58 Encode / Decode?\n"),a("ul",[a("li",[s._v("SS58 is a simple address format designed for Substrate based chains. You can read about its specification in more detail in the "),a("a",{attrs:{href:"https://wiki.parity.io/External-Address-Format-(SS58)",target:"_blank",rel:"noopener noreferrer"}},[s._v("Parity Wiki"),a("OutboundLink")],1),s._v(".")])])])]),s._v(" "),a("p",[a("strong",[s._v("If you have any unanswered/undocumented questions, please raise an issue "),a("a",{attrs:{href:"https://github.com/polkadot-js/ui/issues",target:"_blank",rel:"noopener noreferrer"}},[s._v("here"),a("OutboundLink")],1),s._v(".")])]),s._v(" "),a("h2",{attrs:{id:"users"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#users","aria-hidden":"true"}},[s._v("#")]),s._v(" Users")]),s._v(" "),a("p",[s._v("Keyring is core to many polkadot/substrate apps.")]),s._v(" "),a("ul",[a("li",[a("a",{attrs:{href:"https://github.com/polkadot-js/apps",target:"_blank",rel:"noopener noreferrer"}},[s._v("polkadot-js/apps"),a("OutboundLink")],1)]),s._v(" "),a("li",[a("a",{attrs:{href:"https://github.com/paritytech/substrate-light-ui",target:"_blank",rel:"noopener noreferrer"}},[s._v("paritytech/substrate-light-ui"),a("OutboundLink")],1)])])])},[],!1,null,null,null);t.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/36.21d292ef.js b/docs/assets/js/36.21d292ef.js new file mode 100644 index 00000000..2c87b3d4 --- /dev/null +++ b/docs/assets/js/36.21d292ef.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[36],{355:function(t,e,r){"use strict";r.r(e);var i=r(46),l=Object(i.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("ul",[r("li",[r("router-link",{attrs:{to:"/ui-keyring/modules/_base_.html"}},[t._v('"Base"')]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html"}},[t._v("Base")])],1)])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/ui-keyring/modules/_keyring_.html"}},[t._v('"Keyring"')]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/ui-keyring/classes/_keyring_.keyring.html"}},[t._v("Keyring")])],1)])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/ui-keyring/modules/_defaults_.html"}},[t._v('"defaults"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/ui-keyring/modules/_observable_accounts_.html"}},[t._v('"observable/accounts"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/ui-keyring/modules/_observable_addresses_.html"}},[t._v('"observable/addresses"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/ui-keyring/modules/_observable_development_.html"}},[t._v('"observable/development"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/ui-keyring/modules/_observable_genericsubject_.html"}},[t._v('"observable/genericSubject"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/ui-keyring/modules/_observable_types_.html"}},[t._v('"observable/types"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/ui-keyring/modules/_options_keypair_.html"}},[t._v('"options/KeyPair"')]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/ui-keyring/classes/_options_keypair_.keypair.html"}},[t._v("KeyPair")])],1)])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/ui-keyring/modules/_options_item_.html"}},[t._v('"options/item"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/ui-keyring/modules/_options_types_.html"}},[t._v('"options/types"')]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/ui-keyring/interfaces/_options_types_.keyringoptioninstance.html"}},[t._v("KeyringOptionInstance")])],1)])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html"}},[t._v('"types"')]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/ui-keyring/interfaces/_types_.keyringstruct.html"}},[t._v("KeyringStruct")])],1)])],1)])])},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/37.decf506d.js b/docs/assets/js/37.decf506d.js new file mode 100644 index 00000000..ba5d9e45 --- /dev/null +++ b/docs/assets/js/37.decf506d.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[37],{349:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("Base")])]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/ui-keyring/classes/_keyring_.keyring.html"}},[e._v("Keyring")])],1),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new Base")]),e._v("(): "),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html"}},[e._v("Base")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:22"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html"}},[e._v("Base")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"accounts"}})]),e._v(" "),r("h2",{attrs:{id:"accounts"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accounts","aria-hidden":"true"}},[e._v("#")]),e._v(" accounts")]),e._v(" "),r("p",[r("strong",[e._v("get accounts")]),e._v("(): "),r("code",[e._v("object")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:30"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("object")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"addresses"}})]),e._v(" "),r("h2",{attrs:{id:"addresses"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#addresses","aria-hidden":"true"}},[e._v("#")]),e._v(" addresses")]),e._v(" "),r("p",[r("strong",[e._v("get addresses")]),e._v("(): "),r("code",[e._v("object")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:34"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("object")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keyring"}})]),e._v(" "),r("h2",{attrs:{id:"keyring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keyring","aria-hidden":"true"}},[e._v("#")]),e._v(" keyring")]),e._v(" "),r("p",[r("strong",[e._v("get keyring")]),e._v("(): "),r("code",[e._v("KeyringInstance")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:38"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("KeyringInstance")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"decodeaddress"}})]),e._v(" "),r("h2",{attrs:{id:"decodeaddress"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodeaddress","aria-hidden":"true"}},[e._v("#")]),e._v(" decodeAddress")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeAddress")]),e._v("(key: "),r("em",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:46"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodeaddress"}})]),e._v(" "),r("h2",{attrs:{id:"encodeaddress"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodeaddress","aria-hidden":"true"}},[e._v("#")]),e._v(" encodeAddress")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("encodeAddress")]),e._v("(key: "),r("em",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"getpair"}})]),e._v(" "),r("h2",{attrs:{id:"getpair"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getpair","aria-hidden":"true"}},[e._v("#")]),e._v(" getPair")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("getPair")]),e._v("(address: "),r("em",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:54"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("address")]),e._v(" "),r("td",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"getpairs"}})]),e._v(" "),r("h2",{attrs:{id:"getpairs"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getpairs","aria-hidden":"true"}},[e._v("#")]),e._v(" getPairs")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("getPairs")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("KeyringPair")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("KeyringPair")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isavailable"}})]),e._v(" "),r("h2",{attrs:{id:"isavailable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isavailable","aria-hidden":"true"}},[e._v("#")]),e._v(" isAvailable")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isAvailable")]),e._v("(_address: "),r("em",[r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:64"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("_address")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"ispassvalid"}})]),e._v(" "),r("h2",{attrs:{id:"ispassvalid"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#ispassvalid","aria-hidden":"true"}},[e._v("#")]),e._v(" isPassValid")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isPassValid")]),e._v("(password: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L74",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:74"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("password")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"setaddressprefix"}})]),e._v(" "),r("h2",{attrs:{id:"setaddressprefix"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#setaddressprefix","aria-hidden":"true"}},[e._v("#")]),e._v(" setAddressPrefix")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("setAddressPrefix")]),e._v("(prefix: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:78"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("prefix")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"setdevmode"}})]),e._v(" "),r("h2",{attrs:{id:"setdevmode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#setdevmode","aria-hidden":"true"}},[e._v("#")]),e._v(" setDevMode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("setDevMode")]),e._v("(isDevelopment: "),r("em",[r("code",[e._v("boolean")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L82",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:82"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("isDevelopment")]),e._v(" "),r("td",[r("code",[e._v("boolean")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/38.fa65c92d.js b/docs/assets/js/38.fa65c92d.js new file mode 100644 index 00000000..6ab54b73 --- /dev/null +++ b/docs/assets/js/38.fa65c92d.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[38],{304:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html"}},[e._v("Base")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ Keyring")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/ui-keyring/interfaces/_types_.keyringstruct.html"}},[e._v("KeyringStruct")])],1)]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new Keyring")]),e._v("(): "),r("router-link",{attrs:{to:"/ui-keyring/classes/_keyring_.keyring.html"}},[e._v("Keyring")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html"}},[e._v("Base")]),e._v("."),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:22"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/ui-keyring/classes/_keyring_.keyring.html"}},[e._v("Keyring")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"accounts"}})]),e._v(" "),r("h2",{attrs:{id:"accounts"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accounts","aria-hidden":"true"}},[e._v("#")]),e._v(" accounts")]),e._v(" "),r("p",[r("strong",[e._v("get accounts")]),e._v("(): "),r("code",[e._v("object")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html"}},[e._v("Base")]),e._v("."),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html#accounts"}},[e._v("accounts")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:30"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("object")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"addresses"}})]),e._v(" "),r("h2",{attrs:{id:"addresses"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#addresses","aria-hidden":"true"}},[e._v("#")]),e._v(" addresses")]),e._v(" "),r("p",[r("strong",[e._v("get addresses")]),e._v("(): "),r("code",[e._v("object")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html"}},[e._v("Base")]),e._v("."),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html#addresses"}},[e._v("addresses")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:34"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("object")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keyring"}})]),e._v(" "),r("h2",{attrs:{id:"keyring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keyring","aria-hidden":"true"}},[e._v("#")]),e._v(" keyring")]),e._v(" "),r("p",[r("strong",[e._v("get keyring")]),e._v("(): "),r("code",[e._v("KeyringInstance")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html"}},[e._v("Base")]),e._v("."),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html#keyring"}},[e._v("keyring")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:38"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("KeyringInstance")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"addaccountpair"}})]),e._v(" "),r("h2",{attrs:{id:"addaccountpair"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#addaccountpair","aria-hidden":"true"}},[e._v("#")]),e._v(" addAccountPair")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("addAccountPair")]),e._v("(pair: "),r("em",[r("code",[e._v("KeyringPair")])]),e._v(", password: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[e._v("Keyring.ts:22"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("pair")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair")])])]),e._v(" "),r("tr",[r("td",[e._v("password")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"backupaccount"}})]),e._v(" "),r("h2",{attrs:{id:"backupaccount"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#backupaccount","aria-hidden":"true"}},[e._v("#")]),e._v(" backupAccount")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("backupAccount")]),e._v("(pair: "),r("em",[r("code",[e._v("KeyringPair")])]),e._v(", password: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("KeyringPair$Json")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[e._v("Keyring.ts:29"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("pair")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair")])])]),e._v(" "),r("tr",[r("td",[e._v("password")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("KeyringPair$Json")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"createaccount"}})]),e._v(" "),r("h2",{attrs:{id:"createaccount"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createaccount","aria-hidden":"true"}},[e._v("#")]),e._v(" createAccount")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("createAccount")]),e._v("(seed: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v(", password?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(", meta?: "),r("em",[r("code",[e._v("KeyringPair$Meta")])]),e._v("): "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("Keyring.ts:39"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("seed")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])]),e._v(" "),r("td",[e._v("-")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" password")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("-")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" meta")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair$Meta")])]),e._v(" "),r("td",[e._v("{}")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"createaccountexternal"}})]),e._v(" "),r("h2",{attrs:{id:"createaccountexternal"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createaccountexternal","aria-hidden":"true"}},[e._v("#")]),e._v(" createAccountExternal")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("createAccountExternal")]),e._v("(publicKey: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v(", meta?: "),r("em",[r("code",[e._v("KeyringPair$Meta")])]),e._v("): "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L47",target:"_blank",rel:"noopener noreferrer"}},[e._v("Keyring.ts:47"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("publicKey")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])]),e._v(" "),r("td",[e._v("-")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" meta")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair$Meta")])]),e._v(" "),r("td",[e._v("{}")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"createaccountmnemonic"}})]),e._v(" "),r("h2",{attrs:{id:"createaccountmnemonic"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createaccountmnemonic","aria-hidden":"true"}},[e._v("#")]),e._v(" createAccountMnemonic")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("createAccountMnemonic")]),e._v("(seed: "),r("em",[r("code",[e._v("string")])]),e._v(", password?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(", meta?: "),r("em",[r("code",[e._v("KeyringPair$Meta")])]),e._v("): "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L55",target:"_blank",rel:"noopener noreferrer"}},[e._v("Keyring.ts:55"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("seed")]),e._v(" "),r("td",[r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("-")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" password")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("-")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" meta")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair$Meta")])]),e._v(" "),r("td",[e._v("{}")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"decodeaddress"}})]),e._v(" "),r("h2",{attrs:{id:"decodeaddress"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodeaddress","aria-hidden":"true"}},[e._v("#")]),e._v(" decodeAddress")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeAddress")]),e._v("(key: "),r("em",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html"}},[e._v("Base")]),e._v("."),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html#decodeaddress"}},[e._v("decodeAddress")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:46"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodeaddress"}})]),e._v(" "),r("h2",{attrs:{id:"encodeaddress"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodeaddress","aria-hidden":"true"}},[e._v("#")]),e._v(" encodeAddress")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("encodeAddress")]),e._v("(key: "),r("em",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html"}},[e._v("Base")]),e._v("."),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html#encodeaddress"}},[e._v("encodeAddress")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encryptaccount"}})]),e._v(" "),r("h2",{attrs:{id:"encryptaccount"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encryptaccount","aria-hidden":"true"}},[e._v("#")]),e._v(" encryptAccount")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("encryptAccount")]),e._v("(pair: "),r("em",[r("code",[e._v("KeyringPair")])]),e._v(", password: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[e._v("Keyring.ts:63"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("pair")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair")])])]),e._v(" "),r("tr",[r("td",[e._v("password")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"forgetaccount"}})]),e._v(" "),r("h2",{attrs:{id:"forgetaccount"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#forgetaccount","aria-hidden":"true"}},[e._v("#")]),e._v(" forgetAccount")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forgetAccount")]),e._v("(address: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L72",target:"_blank",rel:"noopener noreferrer"}},[e._v("Keyring.ts:72"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("address")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"forgetaddress"}})]),e._v(" "),r("h2",{attrs:{id:"forgetaddress"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#forgetaddress","aria-hidden":"true"}},[e._v("#")]),e._v(" forgetAddress")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forgetAddress")]),e._v("(address: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L77",target:"_blank",rel:"noopener noreferrer"}},[e._v("Keyring.ts:77"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("address")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"getaccount"}})]),e._v(" "),r("h2",{attrs:{id:"getaccount"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getaccount","aria-hidden":"true"}},[e._v("#")]),e._v(" getAccount")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("getAccount")]),e._v("(address: "),r("em",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringaddress"}},[e._v("KeyringAddress")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L81",target:"_blank",rel:"noopener noreferrer"}},[e._v("Keyring.ts:81"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("address")]),e._v(" "),r("td",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringaddress"}},[e._v("KeyringAddress")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"getaccounts"}})]),e._v(" "),r("h2",{attrs:{id:"getaccounts"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getaccounts","aria-hidden":"true"}},[e._v("#")]),e._v(" getAccounts")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("getAccounts")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringaddress"}},[e._v("KeyringAddress")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("Keyring.ts:85"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringaddress"}},[e._v("KeyringAddress")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"getaddress"}})]),e._v(" "),r("h2",{attrs:{id:"getaddress"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getaddress","aria-hidden":"true"}},[e._v("#")]),e._v(" getAddress")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("getAddress")]),e._v("(_address: "),r("em",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v(", type?: "),r("em",[e._v('"account" | "address"')]),e._v("): "),r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringaddress"}},[e._v("KeyringAddress")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("Keyring.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("_address")]),e._v(" "),r("td",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("td",[e._v("-")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" type")]),e._v(" "),r("td",[e._v('"account" | "address"')]),e._v(" "),r("td",[e._v('"address"')])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringaddress"}},[e._v("KeyringAddress")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"getaddresses"}})]),e._v(" "),r("h2",{attrs:{id:"getaddresses"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getaddresses","aria-hidden":"true"}},[e._v("#")]),e._v(" getAddresses")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("getAddresses")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringaddress"}},[e._v("KeyringAddress")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L115",target:"_blank",rel:"noopener noreferrer"}},[e._v("Keyring.ts:115"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringaddress"}},[e._v("KeyringAddress")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"getpair"}})]),e._v(" "),r("h2",{attrs:{id:"getpair"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getpair","aria-hidden":"true"}},[e._v("#")]),e._v(" getPair")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("getPair")]),e._v("(address: "),r("em",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html"}},[e._v("Base")]),e._v("."),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html#getpair"}},[e._v("getPair")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:54"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("address")]),e._v(" "),r("td",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"getpairs"}})]),e._v(" "),r("h2",{attrs:{id:"getpairs"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getpairs","aria-hidden":"true"}},[e._v("#")]),e._v(" getPairs")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("getPairs")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("KeyringPair")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html"}},[e._v("Base")]),e._v("."),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html#getpairs"}},[e._v("getPairs")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("KeyringPair")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isavailable"}})]),e._v(" "),r("h2",{attrs:{id:"isavailable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isavailable","aria-hidden":"true"}},[e._v("#")]),e._v(" isAvailable")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isAvailable")]),e._v("(_address: "),r("em",[r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html"}},[e._v("Base")]),e._v("."),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html#isavailable"}},[e._v("isAvailable")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:64"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("_address")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"ispassvalid"}})]),e._v(" "),r("h2",{attrs:{id:"ispassvalid"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#ispassvalid","aria-hidden":"true"}},[e._v("#")]),e._v(" isPassValid")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isPassValid")]),e._v("(password: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html"}},[e._v("Base")]),e._v("."),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html#ispassvalid"}},[e._v("isPassValid")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L74",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:74"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("password")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"loadall"}})]),e._v(" "),r("h2",{attrs:{id:"loadall"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#loadall","aria-hidden":"true"}},[e._v("#")]),e._v(" loadAll")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("loadAll")]),e._v("(options: "),r("em",[r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringoptions"}},[e._v("KeyringOptions")])],1),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L156",target:"_blank",rel:"noopener noreferrer"}},[e._v("Keyring.ts:156"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("options")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringoptions"}},[e._v("KeyringOptions")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"restoreaccount"}})]),e._v(" "),r("h2",{attrs:{id:"restoreaccount"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#restoreaccount","aria-hidden":"true"}},[e._v("#")]),e._v(" restoreAccount")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("restoreAccount")]),e._v("(json: "),r("em",[r("code",[e._v("KeyringPair$Json")])]),e._v(", password: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L170",target:"_blank",rel:"noopener noreferrer"}},[e._v("Keyring.ts:170"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("json")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair$Json")])])]),e._v(" "),r("tr",[r("td",[e._v("password")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"saveaccount"}})]),e._v(" "),r("h2",{attrs:{id:"saveaccount"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#saveaccount","aria-hidden":"true"}},[e._v("#")]),e._v(" saveAccount")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("saveAccount")]),e._v("(pair: "),r("em",[r("code",[e._v("KeyringPair")])]),e._v(", password?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L188",target:"_blank",rel:"noopener noreferrer"}},[e._v("Keyring.ts:188"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("pair")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" password")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"saveaccountmeta"}})]),e._v(" "),r("h2",{attrs:{id:"saveaccountmeta"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#saveaccountmeta","aria-hidden":"true"}},[e._v("#")]),e._v(" saveAccountMeta")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("saveAccountMeta")]),e._v("(pair: "),r("em",[r("code",[e._v("KeyringPair")])]),e._v(", meta: "),r("em",[r("code",[e._v("KeyringPair$Meta")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L197",target:"_blank",rel:"noopener noreferrer"}},[e._v("Keyring.ts:197"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("pair")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair")])])]),e._v(" "),r("tr",[r("td",[e._v("meta")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair$Meta")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"saveaddress"}})]),e._v(" "),r("h2",{attrs:{id:"saveaddress"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#saveaddress","aria-hidden":"true"}},[e._v("#")]),e._v(" saveAddress")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("saveAddress")]),e._v("(address: "),r("em",[r("code",[e._v("string")])]),e._v(", meta: "),r("em",[r("code",[e._v("KeyringPair$Meta")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L207",target:"_blank",rel:"noopener noreferrer"}},[e._v("Keyring.ts:207"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("address")]),e._v(" "),r("td",[r("code",[e._v("string")])])]),e._v(" "),r("tr",[r("td",[e._v("meta")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair$Meta")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"saverecent"}})]),e._v(" "),r("h2",{attrs:{id:"saverecent"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#saverecent","aria-hidden":"true"}},[e._v("#")]),e._v(" saveRecent")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("saveRecent")]),e._v("(address: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("router-link",{attrs:{to:"/ui-keyring/modules/_observable_types_.html#singleaddress"}},[e._v("SingleAddress")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Keyring.ts#L227",target:"_blank",rel:"noopener noreferrer"}},[e._v("Keyring.ts:227"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("address")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/ui-keyring/modules/_observable_types_.html#singleaddress"}},[e._v("SingleAddress")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"setaddressprefix"}})]),e._v(" "),r("h2",{attrs:{id:"setaddressprefix"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#setaddressprefix","aria-hidden":"true"}},[e._v("#")]),e._v(" setAddressPrefix")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("setAddressPrefix")]),e._v("(prefix: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html"}},[e._v("Base")]),e._v("."),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html#setaddressprefix"}},[e._v("setAddressPrefix")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:78"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("prefix")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"setdevmode"}})]),e._v(" "),r("h2",{attrs:{id:"setdevmode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#setdevmode","aria-hidden":"true"}},[e._v("#")]),e._v(" setDevMode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("setDevMode")]),e._v("(isDevelopment: "),r("em",[r("code",[e._v("boolean")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html"}},[e._v("Base")]),e._v("."),r("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html#setdevmode"}},[e._v("setDevMode")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/Base.ts#L82",target:"_blank",rel:"noopener noreferrer"}},[e._v("Base.ts:82"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("isDevelopment")]),e._v(" "),r("td",[r("code",[e._v("boolean")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/39.b67bc959.js b/docs/assets/js/39.b67bc959.js new file mode 100644 index 00000000..4b8319f6 --- /dev/null +++ b/docs/assets/js/39.b67bc959.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[39],{303:function(e,t,o){"use strict";o.r(t);var n=o(46),r=Object(n.a)({},function(){var e=this,t=e.$createElement,o=e._self._c||t;return o("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[o("h1",{attrs:{id:"type-parameters"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),o("h4",{attrs:{id:"s"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#s","aria-hidden":"true"}},[e._v("#")]),e._v(" S")]),e._v(" "),o("h4",{attrs:{id:"ss"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#ss","aria-hidden":"true"}},[e._v("#")]),e._v(" SS")]),e._v(" "),o("h1",{attrs:{id:"hierarchy"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),o("p",[o("code",[e._v("PureComponent")]),e._v("<"),o("code",[e._v("Props")]),e._v(">")]),e._v(" "),o("p",[o("strong",[e._v("↳ KeyPair")])]),e._v(" "),o("h1",{attrs:{id:"methods"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),o("p",[o("a",{attrs:{id:"unsafe_componentwillmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-unsafe-componentwillmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-unsafe-componentwillmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" UNSAFE_componentWillMount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("UNSAFE_componentWillMount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.UNSAFE_componentWillMount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:613")])]),e._v(" "),o("p",[e._v("Called immediately before mounting occurs, and before "),o("code",[e._v("Component#render")]),e._v(". Avoid introducing any side-effects or subscriptions in this method.")]),e._v(" "),o("p",[e._v("This method will not stop working in React 17.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use componentDidMount or the constructor instead")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"unsafe_componentwillreceiveprops"}})]),e._v(" "),o("h2",{attrs:{id:"optional-unsafe-componentwillreceiveprops"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-unsafe-componentwillreceiveprops","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" UNSAFE_componentWillReceiveProps")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("UNSAFE_componentWillReceiveProps")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("Props")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.UNSAFE_componentWillReceiveProps")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:645")])]),e._v(" "),o("p",[e._v("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.")]),e._v(" "),o("p",[e._v("Calling "),o("code",[e._v("Component#setState")]),e._v(" generally does not trigger this method.")]),e._v(" "),o("p",[e._v("This method will not stop working in React 17.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use static getDerivedStateFromProps instead")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("Props")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"unsafe_componentwillupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-unsafe-componentwillupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-unsafe-componentwillupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" UNSAFE_componentWillUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("UNSAFE_componentWillUpdate")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("Props")]),e._v(">")]),e._v(", nextState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.UNSAFE_componentWillUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:673")])]),e._v(" "),o("p",[e._v("Called immediately before rendering when new props or state is received. Not called for the initial render.")]),e._v(" "),o("p",[e._v("Note: You cannot call "),o("code",[e._v("Component#setState")]),e._v(" here.")]),e._v(" "),o("p",[e._v("This method will not stop working in React 17.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use getSnapshotBeforeUpdate instead")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("Props")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentdidcatch"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentdidcatch"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentdidcatch","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentDidCatch")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentDidCatch")]),e._v("(error: "),o("em",[o("code",[e._v("Error")])]),e._v(", errorInfo: "),o("em",[o("code",[e._v("ErrorInfo")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.componentDidCatch")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:542")])]),e._v(" "),o("p",[e._v("Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("error")]),e._v(" "),o("td",[o("code",[e._v("Error")])])]),e._v(" "),o("tr",[o("td",[e._v("errorInfo")]),e._v(" "),o("td",[o("code",[e._v("ErrorInfo")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentdidmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentdidmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentdidmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentDidMount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentDidMount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.componentDidMount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:521")])]),e._v(" "),o("p",[e._v("Called immediately after a component is mounted. Setting state here will trigger re-rendering.")]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentdidupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentdidupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentdidupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentDidUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentDidUpdate")]),e._v("(prevProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("Props")]),e._v(">")]),e._v(", prevState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", snapshot?: "),o("em",[o("a",{attrs:{href:""}},[e._v("SS")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from NewLifecycle.componentDidUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:584")])]),e._v(" "),o("p",[e._v("Called immediately after updating occurs. Not called for the initial render.")]),e._v(" "),o("p",[e._v("The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("prevProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("Props")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("prevState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[o("code",[e._v("Optional")]),e._v(" snapshot")]),e._v(" "),o("td",[o("a",{attrs:{href:""}},[e._v("SS")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillMount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillMount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.componentWillMount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:599")])]),e._v(" "),o("p",[e._v("Called immediately before mounting occurs, and before "),o("code",[e._v("Component#render")]),e._v(". Avoid introducing any side-effects or subscriptions in this method.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use componentDidMount or the constructor instead; will stop working in React 17")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillreceiveprops"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillreceiveprops"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillreceiveprops","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillReceiveProps")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillReceiveProps")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("Props")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.componentWillReceiveProps")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:628")])]),e._v(" "),o("p",[e._v("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.")]),e._v(" "),o("p",[e._v("Calling "),o("code",[e._v("Component#setState")]),e._v(" generally does not trigger this method.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use static getDerivedStateFromProps instead; will stop working in React 17")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("Props")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillunmount"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillunmount"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillunmount","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillUnmount")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillUnmount")]),e._v("(): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.componentWillUnmount")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:537")])]),e._v(" "),o("p",[e._v("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 "),o("code",[e._v("componentDidMount")]),e._v(".")]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"componentwillupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-componentwillupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-componentwillupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" componentWillUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("componentWillUpdate")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("Props")]),e._v(">")]),e._v(", nextState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("void")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from DeprecatedLifecycle.componentWillUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:658")])]),e._v(" "),o("p",[e._v("Called immediately before rendering when new props or state is received. Not called for the initial render.")]),e._v(" "),o("p",[e._v("Note: You cannot call "),o("code",[e._v("Component#setState")]),e._v(" here.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("deprecated")])]),e._v(": 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17")]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("em",[o("strong",[e._v("see")])]),e._v(": "),o("a",{attrs:{href:"https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"),o("OutboundLink")],1)]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("Props")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("void")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"getsnapshotbeforeupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-getsnapshotbeforeupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-getsnapshotbeforeupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" getSnapshotBeforeUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("getSnapshotBeforeUpdate")]),e._v("(prevProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("Props")]),e._v(">")]),e._v(", prevState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v("): "),o("code",[e._v("SS")]),e._v(" | "),o("code",[e._v("null")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from NewLifecycle.getSnapshotBeforeUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:578")])]),e._v(" "),o("p",[e._v("Runs before React applies the result of "),o("code",[e._v("render")]),e._v(" to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before "),o("code",[e._v("render")]),e._v(" causes changes to it.")]),e._v(" "),o("p",[e._v("Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("prevProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("Props")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("prevState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("SS")]),e._v(" | "),o("code",[e._v("null")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"render"}})]),e._v(" "),o("h2",{attrs:{id:"render"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#render","aria-hidden":"true"}},[e._v("#")]),e._v(" render")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("render")]),e._v("(): "),o("code",[e._v("Element")])]),e._v(" "),o("p",[o("em",[e._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/options/KeyPair.tsx#L53",target:"_blank",rel:"noopener noreferrer"}},[e._v("options/KeyPair.tsx:53"),o("OutboundLink")],1)])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("Element")])]),e._v(" "),o("hr"),e._v(" "),o("p",[o("a",{attrs:{id:"shouldcomponentupdate"}})]),e._v(" "),o("h2",{attrs:{id:"optional-shouldcomponentupdate"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#optional-shouldcomponentupdate","aria-hidden":"true"}},[e._v("#")]),e._v(" "),o("code",[e._v("")]),e._v(" shouldComponentUpdate")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("shouldComponentUpdate")]),e._v("(nextProps: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("Props")]),e._v(">")]),e._v(", nextState: "),o("em",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")]),e._v(", nextContext: "),o("em",[o("code",[e._v("any")])]),e._v("): "),o("code",[e._v("boolean")])]),e._v(" "),o("p",[o("em",[e._v("Inherited from ComponentLifecycle.shouldComponentUpdate")])]),e._v(" "),o("p",[o("em",[e._v("Defined in /home/travis/build/polkadot-js/ui/node_modules/@types/react/index.d.ts:532")])]),e._v(" "),o("p",[e._v("Called to determine whether the change in props and state should trigger a re-render.")]),e._v(" "),o("p",[o("code",[e._v("Component")]),e._v(" always returns true. "),o("code",[e._v("PureComponent")]),e._v(" implements a shallow comparison on props and state and returns true if any props or states have changed.")]),e._v(" "),o("p",[e._v("If false is returned, "),o("code",[e._v("Component#render")]),e._v(", "),o("code",[e._v("componentWillUpdate")]),e._v(" and "),o("code",[e._v("componentDidUpdate")]),e._v(" will not be called.")]),e._v(" "),o("p",[o("strong",[e._v("Parameters:")])]),e._v(" "),o("table",[o("thead",[o("tr",[o("th",[e._v("Name")]),e._v(" "),o("th",[e._v("Type")])])]),e._v(" "),o("tbody",[o("tr",[o("td",[e._v("nextProps")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("Props")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextState")]),e._v(" "),o("td",[o("code",[e._v("Readonly")]),e._v("<"),o("code",[e._v("S")]),e._v(">")])]),e._v(" "),o("tr",[o("td",[e._v("nextContext")]),e._v(" "),o("td",[o("code",[e._v("any")])])])])]),e._v(" "),o("p",[o("strong",[e._v("Returns:")]),e._v(" "),o("code",[e._v("boolean")])]),e._v(" "),o("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/4.7bd9f4a3.js b/docs/assets/js/4.7bd9f4a3.js new file mode 100644 index 00000000..403b0fa7 --- /dev/null +++ b/docs/assets/js/4.7bd9f4a3.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[4],{264:function(t,e,n){},299:function(t,e,n){"use strict";var a=n(264);n.n(a).a},331:function(t,e,n){"use strict";n.r(e);var a={functional:!0,props:{type:{type:String,default:"tip"},text:String,vertical:{type:String,default:"top"}},render:function(t,e){var n=e.props,a=e.slots;return t("span",{class:["badge",n.type,n.vertical]},n.text||a().default)}},r=(n(299),n(46)),i=Object(r.a)(a,void 0,void 0,!1,null,"efceadb8",null);e.default=i.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/40.eb2643d2.js b/docs/assets/js/40.eb2643d2.js new file mode 100644 index 00000000..27ee24da --- /dev/null +++ b/docs/assets/js/40.eb2643d2.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[40],{346:function(t,e,r){"use strict";r.r(e);var a=r(46),i=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("KeyringOptionInstance")])]),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"createoptionheader"}})]),t._v(" "),r("h2",{attrs:{id:"createoptionheader"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createoptionheader","aria-hidden":"true"}},[t._v("#")]),t._v(" createOptionHeader")]),t._v(" "),r("p",[r("strong",[t._v("● createOptionHeader")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/options/types.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[t._v("options/types.ts:30"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(name: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("router-link",{attrs:{to:"/ui-keyring/modules/_options_types_.html#keyringsectionoption"}},[t._v("KeyringSectionOption")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/ui-keyring/modules/_options_types_.html#keyringsectionoption"}},[t._v("KeyringSectionOption")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"init"}})]),t._v(" "),r("h2",{attrs:{id:"init"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#init","aria-hidden":"true"}},[t._v("#")]),t._v(" init")]),t._v(" "),r("p",[r("strong",[t._v("● init")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/options/types.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("options/types.ts:31"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(keyring: "),r("em",[r("router-link",{attrs:{to:"/ui-keyring/interfaces/_types_.keyringstruct.html"}},[t._v("KeyringStruct")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("keyring")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/ui-keyring/interfaces/_types_.keyringstruct.html"}},[t._v("KeyringStruct")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/41.9d7f2b1e.js b/docs/assets/js/41.9d7f2b1e.js new file mode 100644 index 00000000..9718cb50 --- /dev/null +++ b/docs/assets/js/41.9d7f2b1e.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[41],{333:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("KeyringStruct")])]),e._v(" "),r("h1",{attrs:{id:"implemented-by"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implemented-by","aria-hidden":"true"}},[e._v("#")]),e._v(" Implemented by")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/ui-keyring/classes/_keyring_.keyring.html"}},[e._v("Keyring")])],1)]),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"accounts"}})]),e._v(" "),r("h2",{attrs:{id:"accounts"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accounts","aria-hidden":"true"}},[e._v("#")]),e._v(" accounts")]),e._v(" "),r("p",[r("strong",[e._v("● accounts")]),e._v(": "),r("em",[r("router-link",{attrs:{to:"/ui-keyring/modules/_observable_types_.html#addresssubject"}},[e._v("AddressSubject")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:35"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"addaccountpair"}})]),e._v(" "),r("h2",{attrs:{id:"addaccountpair"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#addaccountpair","aria-hidden":"true"}},[e._v("#")]),e._v(" addAccountPair")]),e._v(" "),r("p",[r("strong",[e._v("● addAccountPair")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:39"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(pair: "),r("em",[r("code",[e._v("KeyringPair")])]),e._v(", password: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("pair")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair")])])]),e._v(" "),r("tr",[r("td",[e._v("password")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"addresses"}})]),e._v(" "),r("h2",{attrs:{id:"addresses"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#addresses","aria-hidden":"true"}},[e._v("#")]),e._v(" addresses")]),e._v(" "),r("p",[r("strong",[e._v("● addresses")]),e._v(": "),r("em",[r("router-link",{attrs:{to:"/ui-keyring/modules/_observable_types_.html#addresssubject"}},[e._v("AddressSubject")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"backupaccount"}})]),e._v(" "),r("h2",{attrs:{id:"backupaccount"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#backupaccount","aria-hidden":"true"}},[e._v("#")]),e._v(" backupAccount")]),e._v(" "),r("p",[r("strong",[e._v("● backupAccount")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:40"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(pair: "),r("em",[r("code",[e._v("KeyringPair")])]),e._v(", password: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("KeyringPair$Json")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("pair")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair")])])]),e._v(" "),r("tr",[r("td",[e._v("password")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("KeyringPair$Json")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"createaccount"}})]),e._v(" "),r("h2",{attrs:{id:"createaccount"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createaccount","aria-hidden":"true"}},[e._v("#")]),e._v(" createAccount")]),e._v(" "),r("p",[r("strong",[e._v("● createAccount")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:41"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(seed: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v(", password?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(", meta?: "),r("em",[r("code",[e._v("KeyringPair$Meta")])]),e._v("): "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("seed")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" password")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" meta")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair$Meta")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"createaccountexternal"}})]),e._v(" "),r("h2",{attrs:{id:"createaccountexternal"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createaccountexternal","aria-hidden":"true"}},[e._v("#")]),e._v(" createAccountExternal")]),e._v(" "),r("p",[r("strong",[e._v("● createAccountExternal")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:42"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(publicKey: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v(", meta?: "),r("em",[r("code",[e._v("KeyringPair$Meta")])]),e._v("): "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("publicKey")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" meta")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair$Meta")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"createaccountmnemonic"}})]),e._v(" "),r("h2",{attrs:{id:"createaccountmnemonic"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createaccountmnemonic","aria-hidden":"true"}},[e._v("#")]),e._v(" createAccountMnemonic")]),e._v(" "),r("p",[r("strong",[e._v("● createAccountMnemonic")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-5","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(seed: "),r("em",[r("code",[e._v("string")])]),e._v(", password?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(", meta?: "),r("em",[r("code",[e._v("KeyringPair$Meta")])]),e._v("): "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("seed")]),e._v(" "),r("td",[r("code",[e._v("string")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" password")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" meta")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair$Meta")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"decodeaddress"}})]),e._v(" "),r("h2",{attrs:{id:"decodeaddress"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodeaddress","aria-hidden":"true"}},[e._v("#")]),e._v(" decodeAddress")]),e._v(" "),r("p",[r("strong",[e._v("● decodeAddress")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:44"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-6","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(key: "),r("em",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodeaddress"}})]),e._v(" "),r("h2",{attrs:{id:"encodeaddress"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodeaddress","aria-hidden":"true"}},[e._v("#")]),e._v(" encodeAddress")]),e._v(" "),r("p",[r("strong",[e._v("● encodeAddress")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:45"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-7","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(key: "),r("em",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encryptaccount"}})]),e._v(" "),r("h2",{attrs:{id:"encryptaccount"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encryptaccount","aria-hidden":"true"}},[e._v("#")]),e._v(" encryptAccount")]),e._v(" "),r("p",[r("strong",[e._v("● encryptAccount")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:46"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-8","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(pair: "),r("em",[r("code",[e._v("KeyringPair")])]),e._v(", password: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("pair")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair")])])]),e._v(" "),r("tr",[r("td",[e._v("password")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"forgetaccount"}})]),e._v(" "),r("h2",{attrs:{id:"forgetaccount"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#forgetaccount","aria-hidden":"true"}},[e._v("#")]),e._v(" forgetAccount")]),e._v(" "),r("p",[r("strong",[e._v("● forgetAccount")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L47",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:47"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-9"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-9","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(address: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("address")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"forgetaddress"}})]),e._v(" "),r("h2",{attrs:{id:"forgetaddress"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#forgetaddress","aria-hidden":"true"}},[e._v("#")]),e._v(" forgetAddress")]),e._v(" "),r("p",[r("strong",[e._v("● forgetAddress")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:48"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-10"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-10","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(address: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("address")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"getaccount"}})]),e._v(" "),r("h2",{attrs:{id:"getaccount"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getaccount","aria-hidden":"true"}},[e._v("#")]),e._v(" getAccount")]),e._v(" "),r("p",[r("strong",[e._v("● getAccount")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L49",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:49"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-11"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-11","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(address: "),r("em",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringaddress"}},[e._v("KeyringAddress")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("address")]),e._v(" "),r("td",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringaddress"}},[e._v("KeyringAddress")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"getaccounts"}})]),e._v(" "),r("h2",{attrs:{id:"getaccounts"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getaccounts","aria-hidden":"true"}},[e._v("#")]),e._v(" getAccounts")]),e._v(" "),r("p",[r("strong",[e._v("● getAccounts")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-12"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-12","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringaddress"}},[e._v("KeyringAddress")]),e._v(">")],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringaddress"}},[e._v("KeyringAddress")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"getaddress"}})]),e._v(" "),r("h2",{attrs:{id:"getaddress"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getaddress","aria-hidden":"true"}},[e._v("#")]),e._v(" getAddress")]),e._v(" "),r("p",[r("strong",[e._v("● getAddress")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:51"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-13"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-13","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(address: "),r("em",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringaddress"}},[e._v("KeyringAddress")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("address")]),e._v(" "),r("td",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringaddress"}},[e._v("KeyringAddress")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"getaddresses"}})]),e._v(" "),r("h2",{attrs:{id:"getaddresses"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getaddresses","aria-hidden":"true"}},[e._v("#")]),e._v(" getAddresses")]),e._v(" "),r("p",[r("strong",[e._v("● getAddresses")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-14"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-14","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringaddress"}},[e._v("KeyringAddress")]),e._v(">")],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringaddress"}},[e._v("KeyringAddress")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"getpair"}})]),e._v(" "),r("h2",{attrs:{id:"getpair"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getpair","aria-hidden":"true"}},[e._v("#")]),e._v(" getPair")]),e._v(" "),r("p",[r("strong",[e._v("● getPair")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L53",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:53"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-15"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-15","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(address: "),r("em",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("address")]),e._v(" "),r("td",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"getpairs"}})]),e._v(" "),r("h2",{attrs:{id:"getpairs"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getpairs","aria-hidden":"true"}},[e._v("#")]),e._v(" getPairs")]),e._v(" "),r("p",[r("strong",[e._v("● getPairs")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:54"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-16"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-16","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("KeyringPair")]),e._v(">")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("KeyringPair")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isavailable"}})]),e._v(" "),r("h2",{attrs:{id:"isavailable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isavailable","aria-hidden":"true"}},[e._v("#")]),e._v(" isAvailable")]),e._v(" "),r("p",[r("strong",[e._v("● isAvailable")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L55",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:55"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-17"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-17","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(address: "),r("em",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("address")]),e._v(" "),r("td",[r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"ispassvalid"}})]),e._v(" "),r("h2",{attrs:{id:"ispassvalid"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#ispassvalid","aria-hidden":"true"}},[e._v("#")]),e._v(" isPassValid")]),e._v(" "),r("p",[r("strong",[e._v("● isPassValid")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L56",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:56"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-18"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-18","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(password: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("password")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keyring"}})]),e._v(" "),r("h2",{attrs:{id:"keyring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keyring","aria-hidden":"true"}},[e._v("#")]),e._v(" keyring")]),e._v(" "),r("p",[r("strong",[e._v("● keyring")]),e._v(": "),r("em",[r("code",[e._v("BaseKeyringInstance")]),e._v(" | "),r("code",[e._v("undefined")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:37"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"loadall"}})]),e._v(" "),r("h2",{attrs:{id:"loadall"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#loadall","aria-hidden":"true"}},[e._v("#")]),e._v(" loadAll")]),e._v(" "),r("p",[r("strong",[e._v("● loadAll")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L57",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:57"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-19"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-19","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(options: "),r("em",[r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringoptions"}},[e._v("KeyringOptions")])],1),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("options")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringoptions"}},[e._v("KeyringOptions")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"restoreaccount"}})]),e._v(" "),r("h2",{attrs:{id:"restoreaccount"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#restoreaccount","aria-hidden":"true"}},[e._v("#")]),e._v(" restoreAccount")]),e._v(" "),r("p",[r("strong",[e._v("● restoreAccount")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-20"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-20","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(json: "),r("em",[r("code",[e._v("KeyringPair$Json")])]),e._v(", password: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("json")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair$Json")])])]),e._v(" "),r("tr",[r("td",[e._v("password")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("KeyringPair")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"saveaccount"}})]),e._v(" "),r("h2",{attrs:{id:"saveaccount"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#saveaccount","aria-hidden":"true"}},[e._v("#")]),e._v(" saveAccount")]),e._v(" "),r("p",[r("strong",[e._v("● saveAccount")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:59"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-21"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-21","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(pair: "),r("em",[r("code",[e._v("KeyringPair")])]),e._v(", password?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("pair")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" password")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"saveaccountmeta"}})]),e._v(" "),r("h2",{attrs:{id:"saveaccountmeta"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#saveaccountmeta","aria-hidden":"true"}},[e._v("#")]),e._v(" saveAccountMeta")]),e._v(" "),r("p",[r("strong",[e._v("● saveAccountMeta")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:60"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-22"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-22","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(pair: "),r("em",[r("code",[e._v("KeyringPair")])]),e._v(", meta: "),r("em",[r("code",[e._v("KeyringPair$Meta")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("pair")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair")])])]),e._v(" "),r("tr",[r("td",[e._v("meta")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair$Meta")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"saveaddress"}})]),e._v(" "),r("h2",{attrs:{id:"saveaddress"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#saveaddress","aria-hidden":"true"}},[e._v("#")]),e._v(" saveAddress")]),e._v(" "),r("p",[r("strong",[e._v("● saveAddress")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L61",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:61"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-23"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-23","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(address: "),r("em",[r("code",[e._v("string")])]),e._v(", meta: "),r("em",[r("code",[e._v("KeyringPair$Meta")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("address")]),e._v(" "),r("td",[r("code",[e._v("string")])])]),e._v(" "),r("tr",[r("td",[e._v("meta")]),e._v(" "),r("td",[r("code",[e._v("KeyringPair$Meta")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"saverecent"}})]),e._v(" "),r("h2",{attrs:{id:"saverecent"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#saverecent","aria-hidden":"true"}},[e._v("#")]),e._v(" saveRecent")]),e._v(" "),r("p",[r("strong",[e._v("● saveRecent")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L62",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:62"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-24"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-24","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(address: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("router-link",{attrs:{to:"/ui-keyring/modules/_observable_types_.html#singleaddress"}},[e._v("SingleAddress")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("address")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/ui-keyring/modules/_observable_types_.html#singleaddress"}},[e._v("SingleAddress")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"setdevmode"}})]),e._v(" "),r("h2",{attrs:{id:"setdevmode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#setdevmode","aria-hidden":"true"}},[e._v("#")]),e._v(" setDevMode")]),e._v(" "),r("p",[r("strong",[e._v("● setDevMode")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:63"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-25"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-25","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(isDevelopment: "),r("em",[r("code",[e._v("boolean")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("isDevelopment")]),e._v(" "),r("td",[r("code",[e._v("boolean")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/42.ce9853f2.js b/docs/assets/js/42.ce9853f2.js new file mode 100644 index 00000000..477532fd --- /dev/null +++ b/docs/assets/js/42.ce9853f2.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[42],{343:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/ui-keyring/classes/_base_.base.html"}},[t._v("Base")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/43.ef18b427.js b/docs/assets/js/43.ef18b427.js new file mode 100644 index 00000000..aa6c2806 --- /dev/null +++ b/docs/assets/js/43.ef18b427.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[43],{340:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/44.e0ccc5ab.js b/docs/assets/js/44.e0ccc5ab.js new file mode 100644 index 00000000..616c6683 --- /dev/null +++ b/docs/assets/js/44.e0ccc5ab.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[44],{337:function(t,e,s){"use strict";s.r(e);var r=s(46),a=Object(r.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/ui-keyring/classes/_keyring_.keyring.html"}},[t._v("Keyring")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/45.3b567ceb.js b/docs/assets/js/45.3b567ceb.js new file mode 100644 index 00000000..c5b14c88 --- /dev/null +++ b/docs/assets/js/45.3b567ceb.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[45],{334:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/46.4d5b3c30.js b/docs/assets/js/46.4d5b3c30.js new file mode 100644 index 00000000..0254c035 --- /dev/null +++ b/docs/assets/js/46.4d5b3c30.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[46],{332:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/47.887b39e7.js b/docs/assets/js/47.887b39e7.js new file mode 100644 index 00000000..e35c7e64 --- /dev/null +++ b/docs/assets/js/47.887b39e7.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[47],{365:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/48.a3d06fb4.js b/docs/assets/js/48.a3d06fb4.js new file mode 100644 index 00000000..45b8fb19 --- /dev/null +++ b/docs/assets/js/48.a3d06fb4.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[48],{330:function(e,t,r){"use strict";r.r(t);var s=r(46),a=Object(s.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"genericsubject"}})]),e._v(" "),r("h2",{attrs:{id:"genericsubject"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#genericsubject","aria-hidden":"true"}},[e._v("#")]),e._v(" genericSubject")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("genericSubject")]),e._v("(keyCreator: "),r("em",[r("code",[e._v("function")])]),e._v(", withTest?: "),r("em",[r("code",[e._v("boolean")])]),e._v("): "),r("router-link",{attrs:{to:"/ui-keyring/modules/_observable_types_.html#addresssubject"}},[e._v("AddressSubject")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/observable/genericSubject.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[e._v("observable/genericSubject.ts:30"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("keyCreator")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("-")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" withTest")]),e._v(" "),r("td",[r("code",[e._v("boolean")])]),e._v(" "),r("td",[e._v("false")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/ui-keyring/modules/_observable_types_.html#addresssubject"}},[e._v("AddressSubject")])],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/49.7627fee6.js b/docs/assets/js/49.7627fee6.js new file mode 100644 index 00000000..cbd30197 --- /dev/null +++ b/docs/assets/js/49.7627fee6.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[49],{329:function(e,t,a){"use strict";a.r(t);var r=a(46),s=Object(r.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("p",[a("a",{attrs:{id:"addresssubject"}})]),e._v(" "),a("h2",{attrs:{id:"addresssubject"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#addresssubject","aria-hidden":"true"}},[e._v("#")]),e._v(" AddressSubject")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ AddressSubject")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/observable/types.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[e._v("observable/types.ts:18"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr"),e._v(" "),a("p",[a("a",{attrs:{id:"singleaddress"}})]),e._v(" "),a("h2",{attrs:{id:"singleaddress"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#singleaddress","aria-hidden":"true"}},[e._v("#")]),e._v(" SingleAddress")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ SingleAddress")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/observable/types.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[e._v("observable/types.ts:9"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr"),e._v(" "),a("p",[a("a",{attrs:{id:"subjectinfo"}})]),e._v(" "),a("h2",{attrs:{id:"subjectinfo"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#subjectinfo","aria-hidden":"true"}},[e._v("#")]),e._v(" SubjectInfo")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ SubjectInfo")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/observable/types.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("observable/types.ts:14"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration-3"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/5.483bab38.js b/docs/assets/js/5.483bab38.js new file mode 100644 index 00000000..aeb88ecb --- /dev/null +++ b/docs/assets/js/5.483bab38.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[5],{247:function(n,w,o){}}]); \ No newline at end of file diff --git a/docs/assets/js/50.abd05e11.js b/docs/assets/js/50.abd05e11.js new file mode 100644 index 00000000..dadd403d --- /dev/null +++ b/docs/assets/js/50.abd05e11.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[50],{328:function(t,e,r){"use strict";r.r(e);var n=r(46),i=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"createitem"}})]),t._v(" "),r("h2",{attrs:{id:"createitem"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createitem","aria-hidden":"true"}},[t._v("#")]),t._v(" createItem")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("createItem")]),t._v("(address: "),r("em",[r("code",[t._v("string")])]),t._v(", _name?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v("): "),r("router-link",{attrs:{to:"/ui-keyring/modules/_options_types_.html#keyringsectionoption"}},[t._v("KeyringSectionOption")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/options/item.tsx#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("options/item.tsx:12"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("address")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" _name")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/ui-keyring/modules/_options_types_.html#keyringsectionoption"}},[t._v("KeyringSectionOption")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/51.3ec61dab.js b/docs/assets/js/51.3ec61dab.js new file mode 100644 index 00000000..5a056da0 --- /dev/null +++ b/docs/assets/js/51.3ec61dab.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[51],{327:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/ui-keyring/classes/_options_keypair_.keypair.html"}},[t._v("KeyPair")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/52.2afa38a5.js b/docs/assets/js/52.2afa38a5.js new file mode 100644 index 00000000..e3aa8728 --- /dev/null +++ b/docs/assets/js/52.2afa38a5.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[52],{326:function(t,e,i){"use strict";i.r(e);var r=i(46),n=Object(r.a)({},function(){var t=this,e=t.$createElement,i=t._self._c||e;return i("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[i("h1",{attrs:{id:"index"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),i("h3",{attrs:{id:"interfaces"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[t._v("#")]),t._v(" Interfaces")]),t._v(" "),i("ul",[i("li",[i("router-link",{attrs:{to:"/ui-keyring/interfaces/_options_types_.keyringoptioninstance.html"}},[t._v("KeyringOptionInstance")])],1)]),t._v(" "),i("h3",{attrs:{id:"type-aliases"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),i("ul",[i("li",[i("router-link",{attrs:{to:"/ui-keyring/modules/_options_types_.html#keyringoption_type"}},[t._v("KeyringOption$Type")])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/ui-keyring/modules/_options_types_.html#keyringoptions"}},[t._v("KeyringOptions")])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/ui-keyring/modules/_options_types_.html#keyringsectionoption"}},[t._v("KeyringSectionOption")])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/ui-keyring/modules/_options_types_.html#keyringsectionoptions"}},[t._v("KeyringSectionOptions")])],1)]),t._v(" "),i("hr"),t._v(" "),i("h1",{attrs:{id:"type-aliases-2"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),i("p",[i("a",{attrs:{id:"keyringoption_type"}})]),t._v(" "),i("h2",{attrs:{id:"keyringoption-type"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#keyringoption-type","aria-hidden":"true"}},[t._v("#")]),t._v(" KeyringOption$Type")]),t._v(" "),i("p",[i("strong",[t._v("Ƭ KeyringOption$Type")]),t._v(": "),i("em",[i("code",[t._v("keyof KeyringOptions")])])]),t._v(" "),i("p",[i("em",[t._v("Defined in "),i("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/options/types.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("options/types.ts:27"),i("OutboundLink")],1)])]),t._v(" "),i("hr"),t._v(" "),i("p",[i("a",{attrs:{id:"keyringoptions"}})]),t._v(" "),i("h2",{attrs:{id:"keyringoptions"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#keyringoptions","aria-hidden":"true"}},[t._v("#")]),t._v(" KeyringOptions")]),t._v(" "),i("p",[i("strong",[t._v("Ƭ KeyringOptions")]),t._v(": "),i("em",[i("code",[t._v("object")])])]),t._v(" "),i("p",[i("em",[t._v("Defined in "),i("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/options/types.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("options/types.ts:19"),i("OutboundLink")],1)])]),t._v(" "),i("h4",{attrs:{id:"type-declaration"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),i("hr"),t._v(" "),i("p",[i("a",{attrs:{id:"keyringsectionoption"}})]),t._v(" "),i("h2",{attrs:{id:"keyringsectionoption"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#keyringsectionoption","aria-hidden":"true"}},[t._v("#")]),t._v(" KeyringSectionOption")]),t._v(" "),i("p",[i("strong",[t._v("Ƭ KeyringSectionOption")]),t._v(": "),i("em",[i("code",[t._v("object")])])]),t._v(" "),i("p",[i("em",[t._v("Defined in "),i("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/options/types.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("options/types.ts:7"),i("OutboundLink")],1)])]),t._v(" "),i("h4",{attrs:{id:"type-declaration-2"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),i("hr"),t._v(" "),i("p",[i("a",{attrs:{id:"keyringsectionoptions"}})]),t._v(" "),i("h2",{attrs:{id:"keyringsectionoptions"}},[i("a",{staticClass:"header-anchor",attrs:{href:"#keyringsectionoptions","aria-hidden":"true"}},[t._v("#")]),t._v(" KeyringSectionOptions")]),t._v(" "),i("p",[i("strong",[t._v("Ƭ KeyringSectionOptions")]),t._v(": "),i("em",[i("code",[t._v("Array")]),t._v("<"),i("router-link",{attrs:{to:"/ui-keyring/modules/_options_types_.html#keyringsectionoption"}},[t._v("KeyringSectionOption")]),t._v(">")],1)]),t._v(" "),i("p",[i("em",[t._v("Defined in "),i("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/options/types.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("options/types.ts:17"),i("OutboundLink")],1)])]),t._v(" "),i("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/53.f77215a0.js b/docs/assets/js/53.f77215a0.js new file mode 100644 index 00000000..8f0dd03d --- /dev/null +++ b/docs/assets/js/53.f77215a0.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[53],{306:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),r("h3",{attrs:{id:"interfaces"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[e._v("#")]),e._v(" Interfaces")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/ui-keyring/interfaces/_types_.keyringstruct.html"}},[e._v("KeyringStruct")])],1)]),e._v(" "),r("h3",{attrs:{id:"type-aliases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringaddress"}},[e._v("KeyringAddress")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringjson"}},[e._v("KeyringJson")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringjson_meta"}},[e._v("KeyringJson$Meta")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/ui-keyring/modules/_types_.html#keyringoptions"}},[e._v("KeyringOptions")])],1)]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"type-aliases-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),r("p",[r("a",{attrs:{id:"keyringaddress"}})]),e._v(" "),r("h2",{attrs:{id:"keyringaddress"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keyringaddress","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringAddress")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ KeyringAddress")]),e._v(": "),r("em",[r("code",[e._v("object")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:27"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keyringjson"}})]),e._v(" "),r("h2",{attrs:{id:"keyringjson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keyringjson","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringJson")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ KeyringJson")]),e._v(": "),r("em",[r("code",[e._v("object")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:22"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keyringjson_meta"}})]),e._v(" "),r("h2",{attrs:{id:"keyringjson-meta"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keyringjson-meta","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringJson$Meta")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ KeyringJson$Meta")]),e._v(": "),r("em",[r("code",[e._v("object")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:12"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keyringoptions"}})]),e._v(" "),r("h2",{attrs:{id:"keyringoptions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keyringoptions","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyringOptions")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ KeyringOptions")]),e._v(": "),r("em",[r("code",[e._v("KeyringOptionsBase")]),e._v(" & "),r("code",[e._v("object")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:8"),r("OutboundLink")],1)])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/54.683fae75.js b/docs/assets/js/54.683fae75.js new file mode 100644 index 00000000..a59dc7f6 --- /dev/null +++ b/docs/assets/js/54.683fae75.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[54],{325:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"polkadot-ui-settings"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-ui-settings","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/ui-settings")]),t._v(" "),a("p",[t._v("Manages app settings including endpoints, themes and prefixes")]),t._v(" "),a("h2",{attrs:{id:"usage-examples"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#usage-examples","aria-hidden":"true"}},[t._v("#")]),t._v(" Usage Examples")]),t._v(" "),a("p",[t._v("User preferences are set as a settings object in the browser's local storage.")]),t._v(" "),a("div",{staticClass:"language-js line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-js"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" settings "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/ui-settings'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("render")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get api endpoint for the selected chain")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("WS_URL")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" settings"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("apiUrl")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the selected il8n language")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" language "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" settings"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("il8nLang")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get all available il8n languages")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" languages "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" settings"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("availableLanguages")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// update settings")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" updatedSettings "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),t._v("settings"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n i18nLang"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Arabic'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n settings"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("set")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("updatedSettings"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// NOTE: API currently does not handle hot reconnecting properly,")]),t._v("\n so you need to manually reload the page after updating settings"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("\n window"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("location"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("reload")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br"),a("span",{staticClass:"line-number"},[t._v("11")]),a("br"),a("span",{staticClass:"line-number"},[t._v("12")]),a("br"),a("span",{staticClass:"line-number"},[t._v("13")]),a("br"),a("span",{staticClass:"line-number"},[t._v("14")]),a("br"),a("span",{staticClass:"line-number"},[t._v("15")]),a("br"),a("span",{staticClass:"line-number"},[t._v("16")]),a("br"),a("span",{staticClass:"line-number"},[t._v("17")]),a("br"),a("span",{staticClass:"line-number"},[t._v("18")]),a("br"),a("span",{staticClass:"line-number"},[t._v("19")]),a("br"),a("span",{staticClass:"line-number"},[t._v("20")]),a("br"),a("span",{staticClass:"line-number"},[t._v("21")]),a("br"),a("span",{staticClass:"line-number"},[t._v("22")]),a("br"),a("span",{staticClass:"line-number"},[t._v("23")]),a("br")])]),a("h2",{attrs:{id:"used-by"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#used-by","aria-hidden":"true"}},[t._v("#")]),t._v(" Used by")]),t._v(" "),a("p",[t._v("Apps that currently use the settings package")]),t._v(" "),a("ul",[a("li",[a("a",{attrs:{href:"https://www.github.com/polkadot-js/apps",target:"_blank",rel:"noopener noreferrer"}},[t._v("polkadot-js/apps"),a("OutboundLink")],1)]),t._v(" "),a("li",[a("a",{attrs:{href:"https://github.com/paritytech/substrate-light-ui",target:"_blank",rel:"noopener noreferrer"}},[t._v("paritytech/substrate-light-ui"),a("OutboundLink")],1)])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/55.8b987b3e.js b/docs/assets/js/55.8b987b3e.js new file mode 100644 index 00000000..845c1690 --- /dev/null +++ b/docs/assets/js/55.8b987b3e.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[55],{305:function(t,s,e){"use strict";e.r(s);var i=e(46),l=Object(i.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("ul",[e("li",[e("router-link",{attrs:{to:"/ui-settings/modules/_settings_.html"}},[t._v('"Settings"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/ui-settings/classes/_settings_.settings.html"}},[t._v("Settings")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/ui-settings/modules/_defaults_.html"}},[t._v('"defaults"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/ui-settings/modules/_types_.html"}},[t._v('"types"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/ui-settings/interfaces/_types_.settingsstruct.html"}},[t._v("SettingsStruct")])],1)])],1)])])},[],!1,null,null,null);s.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/56.3403573d.js b/docs/assets/js/56.3403573d.js new file mode 100644 index 00000000..1f007a46 --- /dev/null +++ b/docs/assets/js/56.3403573d.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[56],{324:function(t,e,s){"use strict";s.r(e);var r=s(46),a=Object(r.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"hierarchy"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),s("p",[s("strong",[t._v("Settings")])]),t._v(" "),s("h1",{attrs:{id:"implements"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/ui-settings/interfaces/_types_.settingsstruct.html"}},[t._v("SettingsStruct")])],1)]),t._v(" "),s("h1",{attrs:{id:"constructors"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),s("p",[s("a",{attrs:{id:"constructor"}})]),t._v(" "),s("h2",{attrs:{id:"constructor"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),s("p",[t._v("⊕ "),s("strong",[t._v("new Settings")]),t._v("(): "),s("router-link",{attrs:{to:"/ui-settings/classes/_settings_.settings.html"}},[t._v("Settings")])],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("Settings.ts:14"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("router-link",{attrs:{to:"/ui-settings/classes/_settings_.settings.html"}},[t._v("Settings")])],1),t._v(" "),s("hr"),t._v(" "),s("h1",{attrs:{id:"accessors"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),s("p",[s("a",{attrs:{id:"apiurl"}})]),t._v(" "),s("h2",{attrs:{id:"apiurl"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#apiurl","aria-hidden":"true"}},[t._v("#")]),t._v(" apiUrl")]),t._v(" "),s("p",[s("strong",[t._v("get apiUrl")]),t._v("(): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[t._v("Settings.ts:25"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"availablelanguages"}})]),t._v(" "),s("h2",{attrs:{id:"availablelanguages"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#availablelanguages","aria-hidden":"true"}},[t._v("#")]),t._v(" availableLanguages")]),t._v(" "),s("p",[s("strong",[t._v("get availableLanguages")]),t._v("(): "),s("router-link",{attrs:{to:"/ui-settings/modules/_types_.html#options"}},[t._v("Options")])],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("Settings.ts:45"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("router-link",{attrs:{to:"/ui-settings/modules/_types_.html#options"}},[t._v("Options")])],1),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"availablenodes"}})]),t._v(" "),s("h2",{attrs:{id:"availablenodes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#availablenodes","aria-hidden":"true"}},[t._v("#")]),t._v(" availableNodes")]),t._v(" "),s("p",[s("strong",[t._v("get availableNodes")]),t._v("(): "),s("router-link",{attrs:{to:"/ui-settings/modules/_types_.html#options"}},[t._v("Options")])],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("Settings.ts:41"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("router-link",{attrs:{to:"/ui-settings/modules/_types_.html#options"}},[t._v("Options")])],1),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"availableuimodes"}})]),t._v(" "),s("h2",{attrs:{id:"availableuimodes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#availableuimodes","aria-hidden":"true"}},[t._v("#")]),t._v(" availableUIModes")]),t._v(" "),s("p",[s("strong",[t._v("get availableUIModes")]),t._v("(): "),s("router-link",{attrs:{to:"/ui-settings/modules/_types_.html#options"}},[t._v("Options")])],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L49",target:"_blank",rel:"noopener noreferrer"}},[t._v("Settings.ts:49"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("router-link",{attrs:{to:"/ui-settings/modules/_types_.html#options"}},[t._v("Options")])],1),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"availableuithemes"}})]),t._v(" "),s("h2",{attrs:{id:"availableuithemes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#availableuithemes","aria-hidden":"true"}},[t._v("#")]),t._v(" availableUIThemes")]),t._v(" "),s("p",[s("strong",[t._v("get availableUIThemes")]),t._v("(): "),s("router-link",{attrs:{to:"/ui-settings/modules/_types_.html#options"}},[t._v("Options")])],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L53",target:"_blank",rel:"noopener noreferrer"}},[t._v("Settings.ts:53"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("router-link",{attrs:{to:"/ui-settings/modules/_types_.html#options"}},[t._v("Options")])],1),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"i18nlang"}})]),t._v(" "),s("h2",{attrs:{id:"i18nlang"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#i18nlang","aria-hidden":"true"}},[t._v("#")]),t._v(" i18nLang")]),t._v(" "),s("p",[s("strong",[t._v("get i18nLang")]),t._v("(): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("Settings.ts:29"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"uimode"}})]),t._v(" "),s("h2",{attrs:{id:"uimode"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#uimode","aria-hidden":"true"}},[t._v("#")]),t._v(" uiMode")]),t._v(" "),s("p",[s("strong",[t._v("get uiMode")]),t._v("(): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("Settings.ts:33"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"uitheme"}})]),t._v(" "),s("h2",{attrs:{id:"uitheme"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#uitheme","aria-hidden":"true"}},[t._v("#")]),t._v(" uiTheme")]),t._v(" "),s("p",[s("strong",[t._v("get uiTheme")]),t._v("(): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("Settings.ts:37"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr"),t._v(" "),s("h1",{attrs:{id:"methods"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),s("p",[s("a",{attrs:{id:"get"}})]),t._v(" "),s("h2",{attrs:{id:"get"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("get")]),t._v("(): "),s("router-link",{attrs:{to:"/ui-settings/interfaces/_types_.settingsstruct.html"}},[t._v("SettingsStruct")])],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L57",target:"_blank",rel:"noopener noreferrer"}},[t._v("Settings.ts:57"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("router-link",{attrs:{to:"/ui-settings/interfaces/_types_.settingsstruct.html"}},[t._v("SettingsStruct")])],1),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"set"}})]),t._v(" "),s("h2",{attrs:{id:"set"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("set")]),t._v("(settings: "),s("em",[s("code",[t._v("Partial")]),t._v("<"),s("router-link",{attrs:{to:"/ui-settings/interfaces/_types_.settingsstruct.html"}},[t._v("SettingsStruct")]),t._v(">")],1),t._v("): "),s("code",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L66",target:"_blank",rel:"noopener noreferrer"}},[t._v("Settings.ts:66"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("settings")]),t._v(" "),s("td",[s("code",[t._v("Partial")]),t._v("<"),s("router-link",{attrs:{to:"/ui-settings/interfaces/_types_.settingsstruct.html"}},[t._v("SettingsStruct")]),t._v(">")],1)])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("void")])]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/57.3a215b4a.js b/docs/assets/js/57.3a215b4a.js new file mode 100644 index 00000000..75a82c50 --- /dev/null +++ b/docs/assets/js/57.3a215b4a.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[57],{323:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("SettingsStruct")])]),t._v(" "),r("h1",{attrs:{id:"implemented-by"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implemented-by","aria-hidden":"true"}},[t._v("#")]),t._v(" Implemented by")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/ui-settings/classes/_settings_.settings.html"}},[t._v("Settings")])],1)]),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"apiurl"}})]),t._v(" "),r("h2",{attrs:{id:"apiurl"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#apiurl","aria-hidden":"true"}},[t._v("#")]),t._v(" apiUrl")]),t._v(" "),r("p",[r("strong",[t._v("● apiUrl")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/types.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:12"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"i18nlang"}})]),t._v(" "),r("h2",{attrs:{id:"i18nlang"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#i18nlang","aria-hidden":"true"}},[t._v("#")]),t._v(" i18nLang")]),t._v(" "),r("p",[r("strong",[t._v("● i18nLang")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/types.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:13"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"uimode"}})]),t._v(" "),r("h2",{attrs:{id:"uimode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#uimode","aria-hidden":"true"}},[t._v("#")]),t._v(" uiMode")]),t._v(" "),r("p",[r("strong",[t._v("● uiMode")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/types.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:14"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"uitheme"}})]),t._v(" "),r("h2",{attrs:{id:"uitheme"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#uitheme","aria-hidden":"true"}},[t._v("#")]),t._v(" uiTheme")]),t._v(" "),r("p",[r("strong",[t._v("● uiTheme")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/types.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:15"),r("OutboundLink")],1)])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/58.43ef2d75.js b/docs/assets/js/58.43ef2d75.js new file mode 100644 index 00000000..a6b23ed0 --- /dev/null +++ b/docs/assets/js/58.43ef2d75.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[58],{322:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/59.dc6b692e.js b/docs/assets/js/59.dc6b692e.js new file mode 100644 index 00000000..4feb3696 --- /dev/null +++ b/docs/assets/js/59.dc6b692e.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[59],{321:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/ui-settings/classes/_settings_.settings.html"}},[t._v("Settings")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/6.1cf8dc02.js b/docs/assets/js/6.1cf8dc02.js new file mode 100644 index 00000000..53a5217d --- /dev/null +++ b/docs/assets/js/6.1cf8dc02.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[6],{335:function(e,t,r){"use strict";r.r(t);var s=r(46),a=Object(s.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"contributing"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#contributing","aria-hidden":"true"}},[e._v("#")]),e._v(" Contributing")]),e._v(" "),r("h2",{attrs:{id:"what"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#what","aria-hidden":"true"}},[e._v("#")]),e._v(" What?")]),e._v(" "),r("p",[e._v("Individuals making significant and valuable contributions are given commit-access to a project to contribute as they see fit.\nA project is more like an open wiki than a standard guarded open source project.")]),e._v(" "),r("h2",{attrs:{id:"rules"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rules","aria-hidden":"true"}},[e._v("#")]),e._v(" Rules")]),e._v(" "),r("p",[e._v("There are a few basic ground-rules for contributors (including the maintainer(s) of the project):")]),e._v(" "),r("ol",[r("li",[r("strong",[e._v("No "),r("code",[e._v("--force")]),e._v(" pushes")]),e._v(" or modifying the Git history in any way. If you need to rebase, ensure you do it in your own repo.")]),e._v(" "),r("li",[r("strong",[e._v("Non-master branches")]),e._v(", prefixed with a short name moniker (e.g. "),r("code",[e._v("-")]),e._v(") must be used for ongoing work.")]),e._v(" "),r("li",[r("strong",[e._v("All modifications")]),e._v(" must be made in a "),r("strong",[e._v("pull-request")]),e._v(" to solicit feedback from other contributors.")]),e._v(" "),r("li",[e._v("A pull-request "),r("em",[e._v("must not be merged until CI")]),e._v(" has finished successfully.")])]),e._v(" "),r("h4",{attrs:{id:"merging-pull-requests-once-ci-is-successful"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#merging-pull-requests-once-ci-is-successful","aria-hidden":"true"}},[e._v("#")]),e._v(" Merging pull requests once CI is successful:")]),e._v(" "),r("ul",[r("li",[e._v("A pull request with no large change to logic that is an urgent fix may be merged after a non-author contributor has reviewed it well.")]),e._v(" "),r("li",[e._v("No PR should be merged until all reviews' comments are addressed.")])]),e._v(" "),r("h4",{attrs:{id:"reviewing-pull-requests"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reviewing-pull-requests","aria-hidden":"true"}},[e._v("#")]),e._v(" Reviewing pull requests:")]),e._v(" "),r("p",[e._v("When reviewing a pull request, the end-goal is to suggest useful changes to the author. Reviews should finish with approval unless there are issues that would result in:")]),e._v(" "),r("ul",[r("li",[e._v("Buggy behaviour.")]),e._v(" "),r("li",[e._v("Undue maintenance burden.")]),e._v(" "),r("li",[e._v("Breaking with house coding style.")]),e._v(" "),r("li",[e._v("Pessimisation (i.e. reduction of speed as measured in the projects benchmarks).")]),e._v(" "),r("li",[e._v("Feature reduction (i.e. it removes some aspect of functionality that a significant minority of users rely on).")]),e._v(" "),r("li",[e._v("Uselessness (i.e. it does not strictly add a feature or fix a known issue).")])]),e._v(" "),r("h4",{attrs:{id:"reviews-may-not-be-used-as-an-effective-veto-for-a-pr-because"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reviews-may-not-be-used-as-an-effective-veto-for-a-pr-because","aria-hidden":"true"}},[e._v("#")]),e._v(" Reviews may not be used as an effective veto for a PR because:")]),e._v(" "),r("ul",[r("li",[e._v("There exists a somewhat cleaner/better/faster way of accomplishing the same feature/fix.")]),e._v(" "),r("li",[e._v("It does not fit well with some other contributors' longer-term vision for the project.")])]),e._v(" "),r("h2",{attrs:{id:"releases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#releases","aria-hidden":"true"}},[e._v("#")]),e._v(" Releases")]),e._v(" "),r("p",[e._v("Declaring formal releases remains the prerogative of the project maintainer(s).")]),e._v(" "),r("h2",{attrs:{id:"changes-to-this-arrangement"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#changes-to-this-arrangement","aria-hidden":"true"}},[e._v("#")]),e._v(" Changes to this arrangement")]),e._v(" "),r("p",[e._v("This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change.")]),e._v(" "),r("h2",{attrs:{id:"heritage"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#heritage","aria-hidden":"true"}},[e._v("#")]),e._v(" Heritage")]),e._v(" "),r("p",[e._v('These contributing guidelines are modified from the "OPEN Open Source Project" guidelines for the Level project: '),r("a",{attrs:{href:"https://github.com/Level/community/blob/master/CONTRIBUTING.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/Level/community/blob/master/CONTRIBUTING.md"),r("OutboundLink")],1)])])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/60.9121e16b.js b/docs/assets/js/60.9121e16b.js new file mode 100644 index 00000000..04212fd6 --- /dev/null +++ b/docs/assets/js/60.9121e16b.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[60],{320:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"interfaces"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[t._v("#")]),t._v(" Interfaces")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/ui-settings/interfaces/_types_.settingsstruct.html"}},[t._v("SettingsStruct")])],1)]),t._v(" "),s("h3",{attrs:{id:"type-aliases"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/ui-settings/modules/_types_.html#options"}},[t._v("Options")])],1)]),t._v(" "),s("hr"),t._v(" "),s("h1",{attrs:{id:"type-aliases-2"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),s("p",[s("a",{attrs:{id:"options"}})]),t._v(" "),s("h2",{attrs:{id:"options"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#options","aria-hidden":"true"}},[t._v("#")]),t._v(" Options")]),t._v(" "),s("p",[s("strong",[t._v("Ƭ Options")]),t._v(": "),s("em",[s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("object")]),t._v(">")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:5"),s("OutboundLink")],1)])]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/61.fdb5b478.js b/docs/assets/js/61.fdb5b478.js new file mode 100644 index 00000000..ff6d8205 --- /dev/null +++ b/docs/assets/js/61.fdb5b478.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[61],{319:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"polkadot-ui-util"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-ui-util","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/ui-util")]),t._v(" "),s("p",[t._v("Various utility and formatting functions")]),t._v(" "),s("h2",{attrs:{id:"formatbalance"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#formatbalance","aria-hidden":"true"}},[t._v("#")]),t._v(" formatBalance")]),t._v(" "),s("div",{staticClass:"language-js line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" props "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" api"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("system"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("properties")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nformatBalance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setDefaults")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n decimals"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" props"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tokenDecimals"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n unit"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" props"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tokenSymbol\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("formatBalance")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'12345'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 12.345z DOT")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br")])]),s("h2",{attrs:{id:"calcsi"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#calcsi","aria-hidden":"true"}},[t._v("#")]),t._v(" calcSi")]),t._v(" "),s("div",{staticClass:"language-js line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// calculates the SI unit applicable")]),t._v("\nformatBalance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("calcSi")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'12345'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// { power: 3, value: 'k', text: 'Kilo' }")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br")])])])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/62.3852ca62.js b/docs/assets/js/62.3852ca62.js new file mode 100644 index 00000000..54fe0fe8 --- /dev/null +++ b/docs/assets/js/62.3852ca62.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[62],{318:function(t,l,i){"use strict";i.r(l);var r=i(46),e=Object(r.a)({},function(){var t=this,l=t.$createElement,i=t._self._c||l;return i("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[i("ul",[i("li",[i("router-link",{attrs:{to:"/ui-util/modules/_formatbalance_.html"}},[t._v('"formatBalance"')])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/ui-util/modules/_formatdecimal_.html"}},[t._v('"formatDecimal"')])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/ui-util/modules/_formatelapsed_.html"}},[t._v('"formatElapsed"')])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/ui-util/modules/_formatnumber_.html"}},[t._v('"formatNumber"')])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/ui-util/modules/_istestchain_.html"}},[t._v('"isTestChain"')])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/ui-util/modules/_si_.html"}},[t._v('"si"')])],1)])])},[],!1,null,null,null);l.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/63.17c6de51.js b/docs/assets/js/63.17c6de51.js new file mode 100644 index 00000000..deedf5d4 --- /dev/null +++ b/docs/assets/js/63.17c6de51.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[63],{317:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/64.53931fa1.js b/docs/assets/js/64.53931fa1.js new file mode 100644 index 00000000..78040309 --- /dev/null +++ b/docs/assets/js/64.53931fa1.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[64],{316:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"formatdecimal"}})]),t._v(" "),a("h2",{attrs:{id:"formatdecimal"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#formatdecimal","aria-hidden":"true"}},[t._v("#")]),t._v(" formatDecimal")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("formatDecimal")]),t._v("(value: "),a("em",[a("code",[t._v("string")])]),t._v("): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-util/src/formatDecimal.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("formatDecimal.ts:7"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("value")]),t._v(" "),a("td",[a("code",[t._v("string")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("string")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/65.4a396d1b.js b/docs/assets/js/65.4a396d1b.js new file mode 100644 index 00000000..3334de2a --- /dev/null +++ b/docs/assets/js/65.4a396d1b.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[65],{315:function(t,e,a){"use strict";a.r(e);var v=a(46),_=Object(v.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"formatelapsed"}})]),t._v(" "),a("h2",{attrs:{id:"formatelapsed"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#formatelapsed","aria-hidden":"true"}},[t._v("#")]),t._v(" formatElapsed")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("formatElapsed")]),t._v("(now?: "),a("em",[a("code",[t._v("Date")]),t._v(" | "),a("code",[t._v("null")])]),t._v(", value?: "),a("em",[a("code",[t._v("BN")]),t._v(" | "),a("code",[t._v("Compact")]),t._v(" | "),a("code",[t._v("Date")]),t._v(" | "),a("code",[t._v("number")]),t._v(" | "),a("code",[t._v("null")])]),t._v("): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-util/src/formatElapsed.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("formatElapsed.ts:20"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" now")]),t._v(" "),a("td",[a("code",[t._v("Date")]),t._v(" | "),a("code",[t._v("null")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),a("td",[a("code",[t._v("BN")]),t._v(" | "),a("code",[t._v("Compact")]),t._v(" | "),a("code",[t._v("Date")]),t._v(" | "),a("code",[t._v("number")]),t._v(" | "),a("code",[t._v("null")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("string")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/66.bdab91ca.js b/docs/assets/js/66.bdab91ca.js new file mode 100644 index 00000000..8f84e657 --- /dev/null +++ b/docs/assets/js/66.bdab91ca.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[66],{314:function(t,e,r){"use strict";r.r(e);var a=r(46),o=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"formatnumber"}})]),t._v(" "),r("h2",{attrs:{id:"formatnumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#formatnumber","aria-hidden":"true"}},[t._v("#")]),t._v(" formatNumber")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("formatNumber")]),t._v("(_value?: "),r("em",[r("code",[t._v("Compact")]),t._v(" | "),r("code",[t._v("BN")]),t._v(" | "),r("code",[t._v("number")]),t._v(" | "),r("code",[t._v("null")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-util/src/formatNumber.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("formatNumber.ts:11"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" _value")]),t._v(" "),r("td",[r("code",[t._v("Compact")]),t._v(" | "),r("code",[t._v("BN")]),t._v(" | "),r("code",[t._v("number")]),t._v(" | "),r("code",[t._v("null")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/67.c5fc00e6.js b/docs/assets/js/67.c5fc00e6.js new file mode 100644 index 00000000..233d8b3b --- /dev/null +++ b/docs/assets/js/67.c5fc00e6.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[67],{313:function(t,e,s){"use strict";s.r(e);var n=s(46),a=Object(n.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"istestchain"}})]),t._v(" "),s("h2",{attrs:{id:"istestchain"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#istestchain","aria-hidden":"true"}},[t._v("#")]),t._v(" isTestChain")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isTestChain")]),t._v("(chain?: "),s("em",[s("code",[t._v("string")]),t._v(" | "),s("code",[t._v("null")])]),t._v("): "),s("code",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-util/src/isTestChain.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("isTestChain.ts:7"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" chain")]),t._v(" "),s("td",[s("code",[t._v("string")]),t._v(" | "),s("code",[t._v("null")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("boolean")])]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/68.8152528b.js b/docs/assets/js/68.8152528b.js new file mode 100644 index 00000000..e1630d15 --- /dev/null +++ b/docs/assets/js/68.8152528b.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[68],{312:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"sidef"}})]),t._v(" "),a("h2",{attrs:{id:"sidef"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#sidef","aria-hidden":"true"}},[t._v("#")]),t._v(" SiDef")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ SiDef")]),t._v(": "),a("em",[a("code",[t._v("object")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-util/src/si.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("si.ts:5"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"variables"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#variables","aria-hidden":"true"}},[t._v("#")]),t._v(" Variables")]),t._v(" "),a("p",[a("a",{attrs:{id:"si"}})]),t._v(" "),a("h2",{attrs:{id:"const-si"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#const-si","aria-hidden":"true"}},[t._v("#")]),t._v(" "),a("code",[t._v("")]),t._v(" SI")]),t._v(" "),a("p",[a("strong",[t._v("● SI")]),t._v(": "),a("em",[a("code",[t._v("Array")]),t._v("<"),a("router-link",{attrs:{to:"/ui-util/modules/_si_.html#sidef"}},[t._v("SiDef")]),t._v(">")],1),t._v(" = [\n{ power: -24, value: 'y', text: 'yocto' },\n{ power: -21, value: 'z', text: 'zepto' },\n{ power: -18, value: 'a', text: 'atto' },\n{ power: -15, value: 'f', text: 'femto' },\n{ power: -12, value: 'p', text: 'pico' },\n{ power: -9, value: 'n', text: 'nano' },\n{ power: -6, value: 'µ', text: 'micro' },\n{ power: -3, value: 'm', text: 'milli' },\n{ power: 0, value: '-', text: 'Unit' }, // position 8\n{ power: 3, value: 'k', text: 'Kilo' },\n{ power: 6, value: 'M', text: 'Mega' },\n{ power: 9, value: 'G', text: 'Giga' },\n{ power: 12, value: 'T', text: 'Tera' },\n{ power: 15, value: 'P', text: 'Peta' },\n{ power: 18, value: 'E', text: 'Exa' },\n{ power: 21, value: 'Z', text: 'Zeta' },\n{ power: 24, value: 'Y', text: 'Yotta' }\n]")]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-util/src/si.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("si.ts:13"),a("OutboundLink")],1)])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"si_mid"}})]),t._v(" "),a("h2",{attrs:{id:"const-si-mid"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#const-si-mid","aria-hidden":"true"}},[t._v("#")]),t._v(" "),a("code",[t._v("")]),t._v(" SI_MID")]),t._v(" "),a("p",[a("strong",[t._v("● SI_MID")]),t._v(": "),a("em",[a("code",[t._v("8")])]),t._v(" = 8")]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-util/src/si.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("si.ts:11"),a("OutboundLink")],1)])]),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"calcsi"}})]),t._v(" "),a("h2",{attrs:{id:"calcsi"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#calcsi","aria-hidden":"true"}},[t._v("#")]),t._v(" calcSi")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("calcSi")]),t._v("(text: "),a("em",[a("code",[t._v("string")])]),t._v(", decimals: "),a("em",[a("code",[t._v("number")])]),t._v("): "),a("router-link",{attrs:{to:"/ui-util/modules/_si_.html#sidef"}},[t._v("SiDef")])],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-util/src/si.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("si.ts:33"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("text")]),t._v(" "),a("td",[a("code",[t._v("string")])])]),t._v(" "),a("tr",[a("td",[t._v("decimals")]),t._v(" "),a("td",[a("code",[t._v("number")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/ui-util/modules/_si_.html#sidef"}},[t._v("SiDef")])],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"findsi"}})]),t._v(" "),a("h2",{attrs:{id:"findsi"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#findsi","aria-hidden":"true"}},[t._v("#")]),t._v(" findSi")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("findSi")]),t._v("(type: "),a("em",[a("code",[t._v("string")])]),t._v("): "),a("router-link",{attrs:{to:"/ui-util/modules/_si_.html#sidef"}},[t._v("SiDef")])],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-util/src/si.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("si.ts:38"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("type")]),t._v(" "),a("td",[a("code",[t._v("string")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/ui-util/modules/_si_.html#sidef"}},[t._v("SiDef")])],1),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/7.b58d6c7e.js b/docs/assets/js/7.b58d6c7e.js new file mode 100644 index 00000000..d287f1a4 --- /dev/null +++ b/docs/assets/js/7.b58d6c7e.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[7],{302:function(t,r,e){"use strict";e.r(r);var o=e(46),a=Object(o.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"polkadot-javascript-ui-libraries"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-javascript-ui-libraries","aria-hidden":"true"}},[t._v("#")]),t._v(" Polkadot Javascript UI libraries")]),t._v(" "),e("p",[t._v("This is a collection of UI (Rwact) libraries, utlities and classes that allows for easier use of the Polkadot JS infrstaructure inside your apps.")]),t._v(" "),e("h2",{attrs:{id:"the-polkadot-project"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#the-polkadot-project","aria-hidden":"true"}},[t._v("#")]),t._v(" The Polkadot Project")]),t._v(" "),e("p",[t._v("You can read more about the Polkadot Network at "),e("a",{attrs:{href:"https://polkadot.network/",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://polkadot.network/"),e("OutboundLink")],1),t._v(" and more about the polkadot-js projects at "),e("a",{attrs:{href:"https://polkadot.js.org",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://polkadot.js.org"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"github-repositories"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#github-repositories","aria-hidden":"true"}},[t._v("#")]),t._v(" Github repositories")]),t._v(" "),e("p",[t._v("You can find the Polkadot repositories at:")]),t._v(" "),e("ul",[e("li",[e("a",{attrs:{href:"https://github.com/polkadot-js",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/polkadot-js"),e("OutboundLink")],1)]),t._v(" "),e("li",[e("a",{attrs:{href:"https://github.com/paritytech/polkadot",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/paritytech/polkadot"),e("OutboundLink")],1)]),t._v(" "),e("li",[e("a",{attrs:{href:"https://github.com/paritytech/substrate",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/paritytech/substrate"),e("OutboundLink")],1)])]),t._v(" "),e("p",[t._v("This documentation is generated from "),e("a",{attrs:{href:"https://github.com/polkadot-js/ui",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/polkadot-js/ui"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"contributing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#contributing","aria-hidden":"true"}},[t._v("#")]),t._v(" Contributing")]),t._v(" "),e("p",[t._v("Contribution to the Polkadot JS projects are more than welcome. You can "),e("a",{attrs:{href:"https://github.com/polkadot-js/ui/issues/new",target:"_blank",rel:"noopener noreferrer"}},[t._v("report issues"),e("OutboundLink")],1),t._v(" and "),e("a",{attrs:{href:"https://github.com/polkadot-js/ui/issues/new",target:"_blank",rel:"noopener noreferrer"}},[t._v("log feature requests"),e("OutboundLink")],1),t._v(".")])])},[],!1,null,null,null);r.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/8.24fc59de.js b/docs/assets/js/8.24fc59de.js new file mode 100644 index 00000000..ebfa10f8 --- /dev/null +++ b/docs/assets/js/8.24fc59de.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[8],{336:function(s,t,a){"use strict";a.r(t);var n=a(46),e=Object(n.a)({},function(){var s=this,t=s.$createElement,a=s._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":s.$parent.slotKey}},[a("h1",{attrs:{id:"polkadot-ui-identicon"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-ui-identicon","aria-hidden":"true"}},[s._v("#")]),s._v(" @polkadot/ui-identicon")]),s._v(" "),a("p",[s._v("A generic identity icon that can render icons based on the theme, be it Substrate or Polkadot")]),s._v(" "),a("h2",{attrs:{id:"usage-examples"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#usage-examples","aria-hidden":"true"}},[s._v("#")]),s._v(" Usage Examples")]),s._v(" "),a("p",[s._v("To install the component, do "),a("code",[s._v("yarn add @polkadot/ui-identicon")])]),s._v(" "),a("p",[s._v("Inside a React component, you can now render any account with the associated icon -")]),s._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" Identicon "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'@polkadot/ui-identicon'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n\n"),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("...")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("render")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("// address is an ss58-encoded address or publicKey (hex string or Uint8Array)")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("const")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v(" address "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("this")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),s._v("props"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("// size (optional) is a number, indicating the size (in pixels, 64 as default)")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("const")]),s._v(" size "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[s._v("32")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("// theme (optional), depicts the type of icon, one of")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("// 'polkadot', 'substrate' (default), 'beachball' or 'jdenticon'")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("const")]),s._v(" theme "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'polkadot'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("// standard className & style props are also available")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("return")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("<")]),s._v("Identicon\n value"),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v("address"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v("\n size"),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v("size"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v("\n theme"),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v("theme"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("/")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v(">")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("...")]),s._v("\n")])]),s._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[s._v("1")]),a("br"),a("span",{staticClass:"line-number"},[s._v("2")]),a("br"),a("span",{staticClass:"line-number"},[s._v("3")]),a("br"),a("span",{staticClass:"line-number"},[s._v("4")]),a("br"),a("span",{staticClass:"line-number"},[s._v("5")]),a("br"),a("span",{staticClass:"line-number"},[s._v("6")]),a("br"),a("span",{staticClass:"line-number"},[s._v("7")]),a("br"),a("span",{staticClass:"line-number"},[s._v("8")]),a("br"),a("span",{staticClass:"line-number"},[s._v("9")]),a("br"),a("span",{staticClass:"line-number"},[s._v("10")]),a("br"),a("span",{staticClass:"line-number"},[s._v("11")]),a("br"),a("span",{staticClass:"line-number"},[s._v("12")]),a("br"),a("span",{staticClass:"line-number"},[s._v("13")]),a("br"),a("span",{staticClass:"line-number"},[s._v("14")]),a("br"),a("span",{staticClass:"line-number"},[s._v("15")]),a("br"),a("span",{staticClass:"line-number"},[s._v("16")]),a("br"),a("span",{staticClass:"line-number"},[s._v("17")]),a("br"),a("span",{staticClass:"line-number"},[s._v("18")]),a("br"),a("span",{staticClass:"line-number"},[s._v("19")]),a("br"),a("span",{staticClass:"line-number"},[s._v("20")]),a("br"),a("span",{staticClass:"line-number"},[s._v("21")]),a("br"),a("span",{staticClass:"line-number"},[s._v("22")]),a("br")])])])},[],!1,null,null,null);t.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/9.0d2a08b3.js b/docs/assets/js/9.0d2a08b3.js new file mode 100644 index 00000000..869f52f6 --- /dev/null +++ b/docs/assets/js/9.0d2a08b3.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[9],{338:function(t,l,e){"use strict";e.r(l);var i=e(46),o=Object(i.a)({},function(){var t=this,l=t.$createElement,e=t._self._c||l;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("ul",[e("li",[e("router-link",{attrs:{to:"/ui-identicon/modules/_demo_.html"}},[t._v('"Demo"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/ui-identicon/classes/_demo_.demo.html"}},[t._v("Demo")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/ui-identicon/modules/_identicon_.html"}},[t._v('"Identicon"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/ui-identicon/classes/_identicon_.identityicon.html"}},[t._v("IdentityIcon")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_colors_.html"}},[t._v('"beachball/colors"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_container_.html"}},[t._v('"beachball/container"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_defaults_.html"}},[t._v('"beachball/defaults"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_demo_.html"}},[t._v('"beachball/demo"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_seeder_.html"}},[t._v('"beachball/seeder"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_shape_circle_.html"}},[t._v('"beachball/shape/circle"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_shape_square_.html"}},[t._v('"beachball/shape/square"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_svg_circle_.html"}},[t._v('"beachball/svg/circle"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_svg_element_.html"}},[t._v('"beachball/svg/element"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_svg_rect_.html"}},[t._v('"beachball/svg/rect"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_svg_svg_.html"}},[t._v('"beachball/svg/svg"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/ui-identicon/modules/_beachball_types_.html"}},[t._v('"beachball/types"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/ui-identicon/modules/_icons_beachball_.html"}},[t._v('"icons/Beachball"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/ui-identicon/classes/_icons_beachball_.beachball.html"}},[t._v("Beachball")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/ui-identicon/modules/_icons_empty_.html"}},[t._v('"icons/Empty"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/ui-identicon/classes/_icons_empty_.empty.html"}},[t._v("Empty")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/ui-identicon/modules/_icons_jdenticon_.html"}},[t._v('"icons/Jdenticon"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/ui-identicon/classes/_icons_jdenticon_.jdenticon.html"}},[t._v("Jdenticon")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/ui-identicon/modules/_icons_polkadot_.html"}},[t._v('"icons/Polkadot"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/ui-identicon/classes/_icons_polkadot_.identicon.html"}},[t._v("Identicon")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/ui-identicon/modules/_types_.html"}},[t._v('"types"')])],1)])])},[],!1,null,null,null);l.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/app.73634ed0.js b/docs/assets/js/app.73634ed0.js new file mode 100644 index 00000000..c0f7bd03 --- /dev/null +++ b/docs/assets/js/app.73634ed0.js @@ -0,0 +1,8 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[0],[]]);!function(t){function e(e){for(var r,a,s=e[0],l=e[1],u=e[2],f=0,p=[];f0?o(r(t),9007199254740991):0}},function(t,e){var n=t.exports={version:"2.6.5"};"number"==typeof __e&&(__e=n)},function(t,e){var n={}.toString;t.exports=function(t){return n.call(t).slice(8,-1)}},function(t,e,n){var r=n(67);t.exports=function(t){return Object(r(t))}},function(t,e){t.exports={}},function(t,e){t.exports=function(t){try{return!!t()}catch(t){return!0}}},function(t,e){t.exports=function(t){if(null==t)throw TypeError("Can't call method on "+t);return t}},function(t,e,n){var r=n(11),o=n(136),i=n(137),a=Object.defineProperty;e.f=n(21)?Object.defineProperty:function(t,e,n){if(r(t),e=i(e,!0),r(n),o)try{return a(t,e,n)}catch(t){}if("get"in n||"set"in n)throw TypeError("Accessors not supported!");return"value"in n&&(t[e]=n.value),t}},function(t,e,n){var r=n(5),o=n(17),i=n(48),a=n(71)("src"),s=n(150),l=(""+s).split("toString");n(23).inspectSource=function(t){return s.call(t)},(t.exports=function(t,e,n,s){var u="function"==typeof n;u&&(i(n,"name")||o(n,"name",e)),t[e]!==n&&(u&&(i(n,a)||o(n,a,t[e]?""+t[e]:l.join(String(e)))),t===r?t[e]=n:s?t[e]?t[e]=n:o(t,e,n):(delete t[e],o(t,e,n)))})(Function.prototype,"toString",function(){return"function"==typeof this&&this[a]||s.call(this)})},function(t,e,n){var r=n(33);t.exports=function(t,e,n){if(r(t),void 0===e)return t;switch(n){case 1:return function(n){return t.call(e,n)};case 2:return function(n,r){return t.call(e,n,r)};case 3:return function(n,r,o){return t.call(e,n,r,o)}}return function(){return t.apply(e,arguments)}}},function(t,e){t.exports={}},function(t,e){t.exports=function(t){if("function"!=typeof t)throw TypeError(t+" is not a function!");return t}},function(t,e,n){var r=n(28);t.exports=function(t){return Object(r(t))}},function(t,e){t.exports=function(t){if("function"!=typeof t)throw TypeError(t+" is not a function!");return t}},function(t,e){t.exports=function(t,e){return{enumerable:!(1&t),configurable:!(2&t),writable:!(4&t),value:e}}},function(t,e,n){var r=n(108),o=n(83);t.exports=Object.keys||function(t){return r(t,o)}},function(t,e){var n={}.toString;t.exports=function(t){return n.call(t).slice(8,-1)}},function(t,e){t.exports=!0},function(t,e,n){"use strict";var r=n(195)(!0);n(88)(String,"String",function(t){this._t=String(t),this._i=0},function(){var t,e=this._t,n=this._i;return n>=e.length?{value:void 0,done:!0}:(t=r(e,n),this._i+=t.length,{value:t,done:!1})})},function(t,e,n){var r=n(7).f,o=n(18),i=n(4)("toStringTag");t.exports=function(t,e,n){t&&!o(t=n?t:t.prototype,i)&&r(t,i,{configurable:!0,value:e})}},function(t,e,n){var r=n(12),o=n(115),i=n(116),a=n(9),s=n(51),l=n(117),u={},c={};(e=t.exports=function(t,e,n,f,p){var d,h,v,m,y=p?function(){return t}:l(t),g=r(n,f,e?2:1),_=0;if("function"!=typeof y)throw TypeError(t+" is not iterable!");if(i(y)){for(d=s(t.length);d>_;_++)if((m=e?g(a(h=t[_])[0],h[1]):g(t[_]))===u||m===c)return m}else for(v=y.call(t);!(h=v.next()).done;)if((m=o(v,g,h.value,e))===u||m===c)return m}).BREAK=u,e.RETURN=c},function(t,e,n){t.exports=n(185)},function(t,e,n){t.exports=n(189)},function(t,e,n){t.exports=n(213)},function(t,e,n){"use strict";function r(t,e,n,r,o,i,a,s){var l,u="function"==typeof t?t.options:t;if(e&&(u.render=e,u.staticRenderFns=n,u._compiled=!0),r&&(u.functional=!0),i&&(u._scopeId="data-v-"+i),a?(l=function(t){(t=t||this.$vnode&&this.$vnode.ssrContext||this.parent&&this.parent.$vnode&&this.parent.$vnode.ssrContext)||"undefined"==typeof __VUE_SSR_CONTEXT__||(t=__VUE_SSR_CONTEXT__),o&&o.call(this,t),t&&t._registeredComponents&&t._registeredComponents.add(a)},u._ssrRegister=l):o&&(l=s?function(){o.call(this,this.$root.$options.shadowRoot)}:o),l)if(u.functional){u._injectStyles=l;var c=u.render;u.render=function(t,e){return l.call(e),c(t,e)}}else{var f=u.beforeCreate;u.beforeCreate=f?[].concat(f,l):[l]}return{exports:t,options:u}}n.d(e,"a",function(){return r})},function(t,e,n){"use strict";var r=n(27);t.exports=function(t,e){return!!t&&r(function(){e?t.call(null,function(){},1):t.call(null)})}},function(t,e){var n={}.hasOwnProperty;t.exports=function(t,e){return n.call(t,e)}},function(t,e,n){var r=n(24);t.exports=Object("z").propertyIsEnumerable(0)?Object:function(t){return"String"==r(t)?t.split(""):Object(t)}},function(t,e){var n=Math.ceil,r=Math.floor;t.exports=function(t){return isNaN(t=+t)?0:(t>0?r:n)(t)}},function(t,e,n){var r=n(80),o=Math.min;t.exports=function(t){return t>0?o(r(t),9007199254740991):0}},function(t,e){var n=0,r=Math.random();t.exports=function(t){return"Symbol(".concat(void 0===t?"":t,")_",(++n+r).toString(36))}},function(t,e){e.f=Object.getOwnPropertySymbols},function(t,e){e.f={}.propertyIsEnumerable},function(t,e,n){for(var r=n(100),o=n(73),i=n(30),a=n(5),s=n(17),l=n(32),u=n(2),c=u("iterator"),f=u("toStringTag"),p=l.Array,d={CSSRuleList:!0,CSSStyleDeclaration:!1,CSSValueList:!1,ClientRectList:!1,DOMRectList:!1,DOMStringList:!1,DOMTokenList:!0,DataTransferItemList:!1,FileList:!1,HTMLAllCollection:!1,HTMLCollection:!1,HTMLFormElement:!1,HTMLSelectElement:!1,MediaList:!0,MimeTypeArray:!1,NamedNodeMap:!1,NodeList:!0,PaintRequestList:!1,Plugin:!1,PluginArray:!1,SVGLengthList:!1,SVGNumberList:!1,SVGPathSegList:!1,SVGPointList:!1,SVGStringList:!1,SVGTransformList:!1,SourceBufferList:!1,StyleSheetList:!0,TextTrackCueList:!1,TextTrackList:!1,TouchList:!1},h=o(d),v=0;vdocument.F=Object<\/script>"),t.close(),l=t.F;r--;)delete l.prototype[i[r]];return l()};t.exports=Object.create||function(t,e){var n;return null!==t?(s.prototype=r(t),n=new s,s.prototype=null,n[a]=t):n=l(),void 0===e?n:o(n,e)}},function(t,e,n){n(198);for(var r=n(3),o=n(14),i=n(26),a=n(4)("toStringTag"),s="CSSRuleList,CSSStyleDeclaration,CSSValueList,ClientRectList,DOMRectList,DOMStringList,DOMTokenList,DataTransferItemList,FileList,HTMLAllCollection,HTMLCollection,HTMLFormElement,HTMLSelectElement,MediaList,MimeTypeArray,NamedNodeMap,NodeList,PaintRequestList,Plugin,PluginArray,SVGLengthList,SVGNumberList,SVGPathSegList,SVGPointList,SVGStringList,SVGTransformList,SourceBufferList,StyleSheetList,TextTrackCueList,TextTrackList,TouchList".split(","),l=0;l
'};function o(t,e,n){return tn?n:t}function i(t){return 100*(-1+t)}n.configure=function(t){var e,n;for(e in t)void 0!==(n=t[e])&&t.hasOwnProperty(e)&&(r[e]=n);return this},n.status=null,n.set=function(t){var e=n.isStarted();t=o(t,r.minimum,1),n.status=1===t?null:t;var l=n.render(!e),u=l.querySelector(r.barSelector),c=r.speed,f=r.easing;return l.offsetWidth,a(function(e){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),s(u,function(t,e,n){var o;return(o="translate3d"===r.positionUsing?{transform:"translate3d("+i(t)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+i(t)+"%,0)"}:{"margin-left":i(t)+"%"}).transition="all "+e+"ms "+n,o}(t,c,f)),1===t?(s(l,{transition:"none",opacity:1}),l.offsetWidth,setTimeout(function(){s(l,{transition:"all "+c+"ms linear",opacity:0}),setTimeout(function(){n.remove(),e()},c)},c)):setTimeout(e,c)}),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var t=function(){setTimeout(function(){n.status&&(n.trickle(),t())},r.trickleSpeed)};return r.trickle&&t(),this},n.done=function(t){return t||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(t){var e=n.status;return e?("number"!=typeof t&&(t=(1-e)*o(Math.random()*e,.1,.95)),e=o(e+t,0,.994),n.set(e)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},t=0,e=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===e&&n.start(),t++,e++,r.always(function(){0==--e?(t=0,n.done()):n.set((t-e)/t)}),this):this},n.render=function(t){if(n.isRendered())return document.getElementById("nprogress");u(document.documentElement,"nprogress-busy");var e=document.createElement("div");e.id="nprogress",e.innerHTML=r.template;var o,a=e.querySelector(r.barSelector),l=t?"-100":i(n.status||0),c=document.querySelector(r.parent);return s(a,{transition:"all 0 linear",transform:"translate3d("+l+"%,0,0)"}),r.showSpinner||(o=e.querySelector(r.spinnerSelector))&&p(o),c!=document.body&&u(c,"nprogress-custom-parent"),c.appendChild(e),e},n.remove=function(){c(document.documentElement,"nprogress-busy"),c(document.querySelector(r.parent),"nprogress-custom-parent");var t=document.getElementById("nprogress");t&&p(t)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var t=document.body.style,e="WebkitTransform"in t?"Webkit":"MozTransform"in t?"Moz":"msTransform"in t?"ms":"OTransform"in t?"O":"";return e+"Perspective"in t?"translate3d":e+"Transform"in t?"translate":"margin"};var a=function(){var t=[];function e(){var n=t.shift();n&&n(e)}return function(n){t.push(n),1==t.length&&e()}}(),s=function(){var t=["Webkit","O","Moz","ms"],e={};function n(n){return n=n.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,function(t,e){return e.toUpperCase()}),e[n]||(e[n]=function(e){var n=document.body.style;if(e in n)return e;for(var r,o=t.length,i=e.charAt(0).toUpperCase()+e.slice(1);o--;)if((r=t[o]+i)in n)return r;return e}(n))}function r(t,e,r){e=n(e),t.style[e]=r}return function(t,e){var n,o,i=arguments;if(2==i.length)for(n in e)void 0!==(o=e[n])&&e.hasOwnProperty(n)&&r(t,n,o);else r(t,i[1],i[2])}}();function l(t,e){var n="string"==typeof t?t:f(t);return n.indexOf(" "+e+" ")>=0}function u(t,e){var n=f(t),r=n+e;l(n,e)||(t.className=r.substring(1))}function c(t,e){var n,r=f(t);l(t,e)&&(n=r.replace(" "+e+" "," "),t.className=n.substring(1,n.length-1))}function f(t){return(" "+(t.className||"")+" ").replace(/\s+/gi," ")}function p(t){t&&t.parentNode&&t.parentNode.removeChild(t)}return n})?r.call(e,n,e,t):r)||(t.exports=o)},function(t,e,n){"use strict";var r=n(8),o=n(66)(1);r(r.P+r.F*!n(47)([].map,!0),"Array",{map:function(t){return o(this,t,arguments[1])}})},function(t,e,n){var r=n(49),o=n(28);t.exports=function(t){return r(o(t))}},function(t,e,n){var r=n(31),o=n(49),i=n(34),a=n(22),s=n(172);t.exports=function(t,e){var n=1==t,l=2==t,u=3==t,c=4==t,f=6==t,p=5==t||f,d=e||s;return function(e,s,h){for(var v,m,y=i(e),g=o(y),_=r(s,h,3),b=a(g.length),x=0,w=n?d(e,b):l?d(e,0):void 0;b>x;x++)if((p||x in g)&&(m=_(v=g[x],x,y),t))if(n)w[x]=m;else if(m)switch(t){case 3:return!0;case 5:return v;case 6:return x;case 2:w.push(v)}else if(c)return!1;return f?-1:u||c?c:w}}},function(t,e){t.exports=function(t){if(null==t)throw TypeError("Can't call method on "+t);return t}},function(t,e,n){"use strict";var r=n(8),o=n(66)(2);r(r.P+r.F*!n(47)([].filter,!0),"Array",{filter:function(t){return o(this,t,arguments[1])}})},function(t,e,n){var r=n(23),o=n(5),i=o["__core-js_shared__"]||(o["__core-js_shared__"]={});(t.exports=function(t,e){return i[t]||(i[t]=void 0!==e?e:{})})("versions",[]).push({version:r.version,mode:n(70)?"pure":"global",copyright:"© 2019 Denis Pushkarev (zloirock.ru)"})},function(t,e){t.exports=!1},function(t,e){var n=0,r=Math.random();t.exports=function(t){return"Symbol(".concat(void 0===t?"":t,")_",(++n+r).toString(36))}},function(t,e,n){var r=n(15),o=n(5).document,i=r(o)&&r(o.createElement);t.exports=function(t){return i?o.createElement(t):{}}},function(t,e,n){var r=n(138),o=n(99);t.exports=Object.keys||function(t){return r(t,o)}},function(t,e,n){var r=n(69)("keys"),o=n(71);t.exports=function(t){return r[t]||(r[t]=o(t))}},function(t,e,n){var r=n(29).f,o=n(48),i=n(2)("toStringTag");t.exports=function(t,e,n){t&&!o(t=n?t:t.prototype,i)&&r(t,i,{configurable:!0,value:e})}},function(t,e,n){var r=n(24),o=n(2)("toStringTag"),i="Arguments"==r(function(){return arguments}());t.exports=function(t){var e,n,a;return void 0===t?"Undefined":null===t?"Null":"string"==typeof(n=function(t,e){try{return t[e]}catch(t){}}(e=Object(t),o))?n:i?r(e):"Object"==(a=r(e))&&"function"==typeof e.callee?"Arguments":a}},function(t,e,n){var r=n(6),o=n(3).document,i=r(o)&&r(o.createElement);t.exports=function(t){return i?o.createElement(t):{}}},function(t,e,n){var r=n(6);t.exports=function(t,e){if(!r(t))return t;var n,o;if(e&&"function"==typeof(n=t.toString)&&!r(o=n.call(t)))return o;if("function"==typeof(n=t.valueOf)&&!r(o=n.call(t)))return o;if(!e&&"function"==typeof(n=t.toString)&&!r(o=n.call(t)))return o;throw TypeError("Can't convert object to primitive value")}},function(t,e,n){var r=n(38);t.exports=Object("z").propertyIsEnumerable(0)?Object:function(t){return"String"==r(t)?t.split(""):Object(t)}},function(t,e){var n=Math.ceil,r=Math.floor;t.exports=function(t){return isNaN(t=+t)?0:(t>0?r:n)(t)}},function(t,e,n){var r=n(82)("keys"),o=n(52);t.exports=function(t){return r[t]||(r[t]=o(t))}},function(t,e,n){var r=n(0),o=n(3),i=o["__core-js_shared__"]||(o["__core-js_shared__"]={});(t.exports=function(t,e){return i[t]||(i[t]=void 0!==e?e:{})})("versions",[]).push({version:r.version,mode:n(39)?"pure":"global",copyright:"© 2019 Denis Pushkarev (zloirock.ru)"})},function(t,e){t.exports="constructor,hasOwnProperty,isPrototypeOf,propertyIsEnumerable,toLocaleString,toString,valueOf".split(",")},function(t,e,n){"use strict";var r=n(8),o=n(66)(0),i=n(47)([].forEach,!0);r(r.P+r.F*!i,"Array",{forEach:function(t){return o(this,t,arguments[1])}})},function(t,e,n){var r=n(1),o=n(0),i=n(16);t.exports=function(t,e){var n=(o.Object||{})[t]||Object[t],a={};a[t]=e(n),r(r.S+r.F*i(function(){n(1)}),"Object",a)}},function(t,e,n){var r=n(108),o=n(83).concat("length","prototype");e.f=Object.getOwnPropertyNames||function(t){return r(t,o)}},function(t,e,n){var r=n(54),o=n(36),i=n(19),a=n(78),s=n(18),l=n(107),u=Object.getOwnPropertyDescriptor;e.f=n(10)?u:function(t,e){if(t=i(t),e=a(e,!0),l)try{return u(t,e)}catch(t){}if(s(t,e))return o(!r.f.call(t,e),t[e])}},function(t,e,n){"use strict";var r=n(39),o=n(1),i=n(111),a=n(14),s=n(26),l=n(196),u=n(41),c=n(109),f=n(4)("iterator"),p=!([].keys&&"next"in[].keys()),d=function(){return this};t.exports=function(t,e,n,h,v,m,y){l(n,e,h);var g,_,b,x=function(t){if(!p&&t in S)return S[t];switch(t){case"keys":case"values":return function(){return new n(this,t)}}return function(){return new n(this,t)}},w=e+" Iterator",k="values"==v,O=!1,S=t.prototype,A=S[f]||S["@@iterator"]||v&&S[v],E=A||x(v),C=v?k?x("entries"):E:void 0,P="Array"==e&&S.entries||A;if(P&&(b=c(P.call(new t)))!==Object.prototype&&b.next&&(u(b,w,!0),r||"function"==typeof b[f]||a(b,f,d)),k&&A&&"values"!==A.name&&(O=!0,E=function(){return A.call(this)}),r&&!y||!p&&!O&&S[f]||a(S,f,E),s[e]=E,s[w]=d,v)if(g={values:k?E:x("values"),keys:m?E:x("keys"),entries:C},y)for(_ in g)_ in S||i(S,_,g[_]);else o(o.P+o.F*(p||O),e,g);return g}},function(t,e,n){e.f=n(4)},function(t,e,n){var r=n(3),o=n(0),i=n(39),a=n(89),s=n(7).f;t.exports=function(t){var e=o.Symbol||(o.Symbol=i?{}:r.Symbol||{});"_"==t.charAt(0)||t in e||s(e,t,{value:a.f(t)})}},function(t,e,n){var r=n(38);t.exports=Array.isArray||function(t){return"Array"==r(t)}},function(t,e){},function(t,e){t.exports=function(t,e,n,r){if(!(t instanceof e)||void 0!==r&&r in t)throw TypeError(n+": incorrect invocation!");return t}},function(t,e,n){"use strict";var r=n(35);function o(t){var e,n;this.promise=new t(function(t,r){if(void 0!==e||void 0!==n)throw TypeError("Bad Promise constructor");e=t,n=r}),this.resolve=r(e),this.reject=r(n)}t.exports.f=function(t){return new o(t)}},function(t,e,n){var r=n(14);t.exports=function(t,e,n){for(var o in e)n&&t[o]?t[o]=e[o]:r(t,o,e[o]);return t}},function(t,e,n){t.exports=n(194)},function(t,e,n){t.exports=n(221)},function(t,e){t.exports=function(t,e){return{enumerable:!(1&t),configurable:!(2&t),writable:!(4&t),value:e}}},function(t,e){t.exports="constructor,hasOwnProperty,isPrototypeOf,propertyIsEnumerable,toLocaleString,toString,valueOf".split(",")},function(t,e,n){"use strict";var r=n(148),o=n(149),i=n(32),a=n(65);t.exports=n(101)(Array,"Array",function(t,e){this._t=a(t),this._i=0,this._k=e},function(){var t=this._t,e=this._k,n=this._i++;return!t||n>=t.length?(this._t=void 0,o(1)):o(0,"keys"==e?n:"values"==e?t[n]:[n,t[n]])},"values"),i.Arguments=i.Array,r("keys"),r("values"),r("entries")},function(t,e,n){"use strict";var r=n(70),o=n(8),i=n(30),a=n(17),s=n(32),l=n(151),u=n(75),c=n(155),f=n(2)("iterator"),p=!([].keys&&"next"in[].keys()),d=function(){return this};t.exports=function(t,e,n,h,v,m,y){l(n,e,h);var g,_,b,x=function(t){if(!p&&t in S)return S[t];switch(t){case"keys":case"values":return function(){return new n(this,t)}}return function(){return new n(this,t)}},w=e+" Iterator",k="values"==v,O=!1,S=t.prototype,A=S[f]||S["@@iterator"]||v&&S[v],E=A||x(v),C=v?k?x("entries"):E:void 0,P="Array"==e&&S.entries||A;if(P&&(b=c(P.call(new t)))!==Object.prototype&&b.next&&(u(b,w,!0),r||"function"==typeof b[f]||a(b,f,d)),k&&A&&"values"!==A.name&&(O=!0,E=function(){return A.call(this)}),r&&!y||!p&&!O&&S[f]||a(S,f,E),s[e]=E,s[w]=d,v)if(g={values:k?E:x("values"),keys:m?E:x("keys"),entries:C},y)for(_ in g)_ in S||i(S,_,g[_]);else o(o.P+o.F*(p||O),e,g);return g}},function(t,e,n){var r=n(5).document;t.exports=r&&r.documentElement},function(t,e,n){var r=n(11),o=n(33),i=n(2)("species");t.exports=function(t,e){var n,a=r(t).constructor;return void 0===a||null==(n=r(a)[i])?e:o(n)}},function(t,e,n){var r,o,i,a=n(31),s=n(162),l=n(102),u=n(72),c=n(5),f=c.process,p=c.setImmediate,d=c.clearImmediate,h=c.MessageChannel,v=c.Dispatch,m=0,y={},g=function(){var t=+this;if(y.hasOwnProperty(t)){var e=y[t];delete y[t],e()}},_=function(t){g.call(t.data)};p&&d||(p=function(t){for(var e=[],n=1;arguments.length>n;)e.push(arguments[n++]);return y[++m]=function(){s("function"==typeof t?t:Function(t),e)},r(m),m},d=function(t){delete y[t]},"process"==n(24)(f)?r=function(t){f.nextTick(a(g,t,1))}:v&&v.now?r=function(t){v.now(a(g,t,1))}:h?(i=(o=new h).port2,o.port1.onmessage=_,r=a(i.postMessage,i,1)):c.addEventListener&&"function"==typeof postMessage&&!c.importScripts?(r=function(t){c.postMessage(t+"","*")},c.addEventListener("message",_,!1)):r="onreadystatechange"in u("script")?function(t){l.appendChild(u("script")).onreadystatechange=function(){l.removeChild(this),g.call(t)}}:function(t){setTimeout(a(g,t,1),0)}),t.exports={set:p,clear:d}},function(t,e,n){"use strict";var r=n(33);function o(t){var e,n;this.promise=new t(function(t,r){if(void 0!==e||void 0!==n)throw TypeError("Bad Promise constructor");e=t,n=r}),this.resolve=r(e),this.reject=r(n)}t.exports.f=function(t){return new o(t)}},function(t,e,n){var r=n(11),o=n(15),i=n(105);t.exports=function(t,e){if(r(t),o(e)&&e.constructor===t)return e;var n=i.f(t);return(0,n.resolve)(e),n.promise}},function(t,e,n){t.exports=!n(10)&&!n(16)(function(){return 7!=Object.defineProperty(n(77)("div"),"a",{get:function(){return 7}}).a})},function(t,e,n){var r=n(18),o=n(19),i=n(178)(!1),a=n(81)("IE_PROTO");t.exports=function(t,e){var n,s=o(t),l=0,u=[];for(n in s)n!=a&&r(s,n)&&u.push(n);for(;e.length>l;)r(s,n=e[l++])&&(~i(u,n)||u.push(n));return u}},function(t,e,n){var r=n(18),o=n(25),i=n(81)("IE_PROTO"),a=Object.prototype;t.exports=Object.getPrototypeOf||function(t){return t=o(t),r(t,i)?t[i]:"function"==typeof t.constructor&&t instanceof t.constructor?t.constructor.prototype:t instanceof Object?a:null}},function(t,e,n){"use strict";var r=n(7),o=n(36);t.exports=function(t,e,n){e in t?r.f(t,e,o(0,n)):t[e]=n}},function(t,e,n){t.exports=n(14)},function(t,e,n){var r=n(3).document;t.exports=r&&r.documentElement},function(t,e){t.exports=function(t,e){return{value:e,done:!!t}}},function(t,e,n){t.exports=n(206)},function(t,e,n){var r=n(9);t.exports=function(t,e,n,o){try{return o?e(r(n)[0],n[1]):e(n)}catch(e){var i=t.return;throw void 0!==i&&r(i.call(t)),e}}},function(t,e,n){var r=n(26),o=n(4)("iterator"),i=Array.prototype;t.exports=function(t){return void 0!==t&&(r.Array===t||i[o]===t)}},function(t,e,n){var r=n(59),o=n(4)("iterator"),i=n(26);t.exports=n(0).getIteratorMethod=function(t){if(null!=t)return t[o]||t["@@iterator"]||i[r(t)]}},function(t,e,n){var r=n(4)("iterator"),o=!1;try{var i=[7][r]();i.return=function(){o=!0},Array.from(i,function(){throw 2})}catch(t){}t.exports=function(t,e){if(!e&&!o)return!1;var n=!1;try{var i=[7],a=i[r]();a.next=function(){return{done:n=!0}},i[r]=function(){return a},t(i)}catch(t){}return n}},function(t,e,n){var r=n(29).f,o=Function.prototype,i=/^\s*function ([^ (]*)/;"name"in o||n(21)&&r(o,"name",{configurable:!0,get:function(){try{return(""+this).match(i)[1]}catch(t){return""}}})},function(t,e,n){var r=n(9),o=n(35),i=n(4)("species");t.exports=function(t,e){var n,a=r(t).constructor;return void 0===a||null==(n=r(a)[i])?e:o(n)}},function(t,e,n){var r,o,i,a=n(12),s=n(215),l=n(112),u=n(77),c=n(3),f=c.process,p=c.setImmediate,d=c.clearImmediate,h=c.MessageChannel,v=c.Dispatch,m=0,y={},g=function(){var t=+this;if(y.hasOwnProperty(t)){var e=y[t];delete y[t],e()}},_=function(t){g.call(t.data)};p&&d||(p=function(t){for(var e=[],n=1;arguments.length>n;)e.push(arguments[n++]);return y[++m]=function(){s("function"==typeof t?t:Function(t),e)},r(m),m},d=function(t){delete y[t]},"process"==n(38)(f)?r=function(t){f.nextTick(a(g,t,1))}:v&&v.now?r=function(t){v.now(a(g,t,1))}:h?(i=(o=new h).port2,o.port1.onmessage=_,r=a(i.postMessage,i,1)):c.addEventListener&&"function"==typeof postMessage&&!c.importScripts?(r=function(t){c.postMessage(t+"","*")},c.addEventListener("message",_,!1)):r="onreadystatechange"in u("script")?function(t){l.appendChild(u("script")).onreadystatechange=function(){l.removeChild(this),g.call(t)}}:function(t){setTimeout(a(g,t,1),0)}),t.exports={set:p,clear:d}},function(t,e){t.exports=function(t){try{return{e:!1,v:t()}}catch(t){return{e:!0,v:t}}}},function(t,e,n){var r=n(9),o=n(6),i=n(94);t.exports=function(t,e){if(r(t),o(e)&&e.constructor===t)return e;var n=i.f(t);return(0,n.resolve)(e),n.promise}},function(t,e,n){"use strict";var r=n(3),o=n(0),i=n(7),a=n(10),s=n(4)("species");t.exports=function(t){var e="function"==typeof o[t]?o[t]:r[t];a&&e&&!e[s]&&i.f(e,s,{configurable:!0,get:function(){return this}})}},function(t,e,n){var r=n(50),o=n(28);t.exports=function(t){return function(e,n){var i,a,s=String(o(e)),l=r(n),u=s.length;return l<0||l>=u?t?"":void 0:(i=s.charCodeAt(l))<55296||i>56319||l+1===u||(a=s.charCodeAt(l+1))<56320||a>57343?t?s.charAt(l):i:t?s.slice(l,l+2):a-56320+(i-55296<<10)+65536}}},function(t,e,n){var r=n(6);t.exports=function(t,e){if(!r(t)||t._t!==e)throw TypeError("Incompatible receiver, "+e+" required!");return t}},function(t,e,n){"use strict";var r,o,i=n(146),a=RegExp.prototype.exec,s=String.prototype.replace,l=a,u=(r=/a/,o=/b*/g,a.call(r,"a"),a.call(o,"a"),0!==r.lastIndex||0!==o.lastIndex),c=void 0!==/()??/.exec("")[1];(u||c)&&(l=function(t){var e,n,r,o,l=this;return c&&(n=new RegExp("^"+l.source+"$(?!\\s)",i.call(l))),u&&(e=l.lastIndex),r=a.call(l,t),u&&r&&(l.lastIndex=l.global?r.index+r[0].length:e),c&&r&&r.length>1&&s.call(r[0],n,function(){for(o=1;o=e||n<0||p&&t-c>=a}function x(){var t=m();if(b(t))return w(t);l=setTimeout(x,function(t){var n=e-(t-u);return p?v(n,a-(t-c)):n}(t))}function w(t){return l=void 0,d&&o?y(t):(o=i=void 0,s)}function k(){var t=m(),n=b(t);if(o=arguments,i=this,u=t,n){if(void 0===l)return function(t){return c=t,l=setTimeout(x,e),f?y(t):s}(u);if(p)return l=setTimeout(x,e),y(u)}return void 0===l&&(l=setTimeout(x,e)),s}return e=_(e)||0,g(r)&&(f=!!r.leading,a=(p="maxWait"in r)?h(_(r.maxWait)||0,e):a,d="trailing"in r?!!r.trailing:d),k.cancel=function(){void 0!==l&&clearTimeout(l),c=0,o=u=i=l=void 0},k.flush=function(){return void 0===l?s:w(m())},k}function g(t){var e=typeof t;return!!t&&("object"==e||"function"==e)}function _(t){if("number"==typeof t)return t;if(function(t){return"symbol"==typeof t||function(t){return!!t&&"object"==typeof t}(t)&&d.call(t)==o}(t))return r;if(g(t)){var e="function"==typeof t.valueOf?t.valueOf():t;t=g(e)?e+"":e}if("string"!=typeof t)return 0===t?t:+t;t=t.replace(i,"");var n=s.test(t);return n||l.test(t)?u(t.slice(2),n?2:8):a.test(t)?r:+t}t.exports=function(t,e,r){var o=!0,i=!0;if("function"!=typeof t)throw new TypeError(n);return g(r)&&(o="leading"in r?!!r.leading:o,i="trailing"in r?!!r.trailing:i),y(t,e,{leading:o,maxWait:e,trailing:i})}},function(t,e,n){t.exports=n(240)},function(t,e,n){t.exports=n(242)},function(t,e,n){"use strict";var r=n(11),o=n(34),i=n(22),a=n(50),s=n(143),l=n(144),u=Math.max,c=Math.min,f=Math.floor,p=/\$([$&`']|\d\d?|<[^>]*>)/g,d=/\$([$&`']|\d\d?)/g;n(145)("replace",2,function(t,e,n,h){return[function(r,o){var i=t(this),a=null==r?void 0:r[e];return void 0!==a?a.call(r,i,o):n.call(String(i),r,o)},function(t,e){var o=h(n,t,this,e);if(o.done)return o.value;var f=r(t),p=String(this),d="function"==typeof e;d||(e=String(e));var m=f.global;if(m){var y=f.unicode;f.lastIndex=0}for(var g=[];;){var _=l(f,p);if(null===_)break;if(g.push(_),!m)break;""===String(_[0])&&(f.lastIndex=s(p,i(f.lastIndex),y))}for(var b,x="",w=0,k=0;k=w&&(x+=p.slice(w,S)+$,w=S+O.length)}return x+p.slice(w)}];function v(t,e,r,i,a,s){var l=r+t.length,u=i.length,c=d;return void 0!==a&&(a=o(a),c=p),n.call(s,c,function(n,o){var s;switch(o.charAt(0)){case"$":return"$";case"&":return t;case"`":return e.slice(0,r);case"'":return e.slice(l);case"<":s=a[o.slice(1,-1)];break;default:var c=+o;if(0===c)return n;if(c>u){var p=f(c/10);return 0===p?n:p<=u?void 0===i[p-1]?o.charAt(1):i[p-1]+o.charAt(1):n}s=i[c-1]}return void 0===s?"":s})}})},function(t,e,n){t.exports=!n(21)&&!n(27)(function(){return 7!=Object.defineProperty(n(72)("div"),"a",{get:function(){return 7}}).a})},function(t,e,n){var r=n(15);t.exports=function(t,e){if(!r(t))return t;var n,o;if(e&&"function"==typeof(n=t.toString)&&!r(o=n.call(t)))return o;if("function"==typeof(n=t.valueOf)&&!r(o=n.call(t)))return o;if(!e&&"function"==typeof(n=t.toString)&&!r(o=n.call(t)))return o;throw TypeError("Can't convert object to primitive value")}},function(t,e,n){var r=n(48),o=n(65),i=n(139)(!1),a=n(74)("IE_PROTO");t.exports=function(t,e){var n,s=o(t),l=0,u=[];for(n in s)n!=a&&r(s,n)&&u.push(n);for(;e.length>l;)r(s,n=e[l++])&&(~i(u,n)||u.push(n));return u}},function(t,e,n){var r=n(65),o=n(22),i=n(154);t.exports=function(t){return function(e,n,a){var s,l=r(e),u=o(l.length),c=i(a,u);if(t&&n!=n){for(;u>c;)if((s=l[c++])!=s)return!0}else for(;u>c;c++)if((t||c in l)&&l[c]===n)return t||c||0;return!t&&-1}}},function(t,e,n){"use strict";var r=n(5),o=n(29),i=n(21),a=n(2)("species");t.exports=function(t){var e=r[t];i&&e&&!e[a]&&o.f(e,a,{configurable:!0,get:function(){return this}})}},function(t,e){e.f={}.propertyIsEnumerable},function(t,e,n){var r=n(15),o=n(24),i=n(2)("match");t.exports=function(t){var e;return r(t)&&(void 0!==(e=t[i])?!!e:"RegExp"==o(t))}},function(t,e,n){"use strict";var r=n(125)(!0);t.exports=function(t,e,n){return e+(n?r(t,e).length:1)}},function(t,e,n){"use strict";var r=n(76),o=RegExp.prototype.exec;t.exports=function(t,e){var n=t.exec;if("function"==typeof n){var i=n.call(t,e);if("object"!=typeof i)throw new TypeError("RegExp exec method returned something other than an Object or null");return i}if("RegExp"!==r(t))throw new TypeError("RegExp#exec called on incompatible receiver");return o.call(t,e)}},function(t,e,n){"use strict";n(244);var r=n(30),o=n(17),i=n(27),a=n(28),s=n(2),l=n(127),u=s("species"),c=!i(function(){var t=/./;return t.exec=function(){var t=[];return t.groups={a:"7"},t},"7"!=="".replace(t,"$")}),f=function(){var t=/(?:)/,e=t.exec;t.exec=function(){return e.apply(this,arguments)};var n="ab".split(t);return 2===n.length&&"a"===n[0]&&"b"===n[1]}();t.exports=function(t,e,n){var p=s(t),d=!i(function(){var e={};return e[p]=function(){return 7},7!=""[t](e)}),h=d?!i(function(){var e=!1,n=/a/;return n.exec=function(){return e=!0,null},"split"===t&&(n.constructor={},n.constructor[u]=function(){return n}),n[p](""),!e}):void 0;if(!d||!h||"replace"===t&&!c||"split"===t&&!f){var v=/./[p],m=n(a,p,""[t],function(t,e,n,r,o){return e.exec===l?d&&!o?{done:!0,value:v.call(e,n,r)}:{done:!0,value:t.call(n,e,r)}:{done:!1}}),y=m[0],g=m[1];r(String.prototype,t,y),o(RegExp.prototype,p,2==e?function(t,e){return g.call(t,this,e)}:function(t){return g.call(t,this)})}}},function(t,e,n){"use strict";var r=n(11);t.exports=function(){var t=r(this),e="";return t.global&&(e+="g"),t.ignoreCase&&(e+="i"),t.multiline&&(e+="m"),t.unicode&&(e+="u"),t.sticky&&(e+="y"),e}},function(t,e,n){t.exports=n(246)},function(t,e,n){var r=n(2)("unscopables"),o=Array.prototype;null==o[r]&&n(17)(o,r,{}),t.exports=function(t){o[r][t]=!0}},function(t,e){t.exports=function(t,e){return{value:e,done:!!t}}},function(t,e,n){t.exports=n(69)("native-function-to-string",Function.toString)},function(t,e,n){"use strict";var r=n(152),o=n(98),i=n(75),a={};n(17)(a,n(2)("iterator"),function(){return this}),t.exports=function(t,e,n){t.prototype=r(a,{next:o(1,n)}),i(t,e+" Iterator")}},function(t,e,n){var r=n(11),o=n(153),i=n(99),a=n(74)("IE_PROTO"),s=function(){},l=function(){var t,e=n(72)("iframe"),r=i.length;for(e.style.display="none",n(102).appendChild(e),e.src="javascript:",(t=e.contentWindow.document).open(),t.write(" + + diff --git a/docs/ui-identicon/README.md b/docs/ui-identicon/README.md new file mode 100644 index 00000000..cad4be52 --- /dev/null +++ b/docs/ui-identicon/README.md @@ -0,0 +1,38 @@ + +@polkadot/ui-identicon +====================== + +A generic identity icon that can render icons based on the theme, be it Substrate or Polkadot + +Usage Examples +-------------- + +To install the component, do `yarn add @polkadot/ui-identicon` + +Inside a React component, you can now render any account with the associated icon - + +```javascript +import Identicon from '@polkadot/ui-identicon'; + +... +render () { + // address is an ss58-encoded address or publicKey (hex string or Uint8Array) + const { address } = this.props; + // size (optional) is a number, indicating the size (in pixels, 64 as default) + const size = 32; + // theme (optional), depicts the type of icon, one of + // 'polkadot', 'substrate' (default), 'beachball' or 'jdenticon' + const theme = 'polkadot'; + + // standard className & style props are also available + return ( + + ); +} +... +``` + diff --git a/docs/ui-identicon/SUMMARY.html b/docs/ui-identicon/SUMMARY.html new file mode 100644 index 00000000..db087bc5 --- /dev/null +++ b/docs/ui-identicon/SUMMARY.html @@ -0,0 +1,21 @@ + + + + + + polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-identicon/SUMMARY.md b/docs/ui-identicon/SUMMARY.md new file mode 100644 index 00000000..5c225679 --- /dev/null +++ b/docs/ui-identicon/SUMMARY.md @@ -0,0 +1,25 @@ +* ["Demo"](modules/_demo_.md) + * [Demo](classes/_demo_.demo.md) +* ["Identicon"](modules/_identicon_.md) + * [IdentityIcon](classes/_identicon_.identityicon.md) +* ["beachball/colors"](modules/_beachball_colors_.md) +* ["beachball/container"](modules/_beachball_container_.md) +* ["beachball/defaults"](modules/_beachball_defaults_.md) +* ["beachball/demo"](modules/_beachball_demo_.md) +* ["beachball/seeder"](modules/_beachball_seeder_.md) +* ["beachball/shape/circle"](modules/_beachball_shape_circle_.md) +* ["beachball/shape/square"](modules/_beachball_shape_square_.md) +* ["beachball/svg/circle"](modules/_beachball_svg_circle_.md) +* ["beachball/svg/element"](modules/_beachball_svg_element_.md) +* ["beachball/svg/rect"](modules/_beachball_svg_rect_.md) +* ["beachball/svg/svg"](modules/_beachball_svg_svg_.md) +* ["beachball/types"](modules/_beachball_types_.md) +* ["icons/Beachball"](modules/_icons_beachball_.md) + * [Beachball](classes/_icons_beachball_.beachball.md) +* ["icons/Empty"](modules/_icons_empty_.md) + * [Empty](classes/_icons_empty_.empty.md) +* ["icons/Jdenticon"](modules/_icons_jdenticon_.md) + * [Jdenticon](classes/_icons_jdenticon_.jdenticon.md) +* ["icons/Polkadot"](modules/_icons_polkadot_.md) + * [Identicon](classes/_icons_polkadot_.identicon.md) +* ["types"](modules/_types_.md) diff --git a/docs/ui-identicon/classes/_demo_.demo.html b/docs/ui-identicon/classes/_demo_.demo.html new file mode 100644 index 00000000..319e6381 --- /dev/null +++ b/docs/ui-identicon/classes/_demo_.demo.html @@ -0,0 +1,21 @@ + + + + + + Type parameters | polkadot-js/ui + + + + + + + +
polkadot-js/ui

Type parameters

P

S

SS

Hierarchy

PureComponent

↳ Demo

Methods

<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

see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns: void

<Optional> UNSAFE_componentWillReceiveProps

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly<P>, 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

see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters:

Name Type
nextProps Readonly<P>
nextContext any

Returns: void

<Optional> UNSAFE_componentWillUpdate

▸ UNSAFE_componentWillUpdate(nextProps: Readonly<P>, 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

see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters:

Name Type
nextProps Readonly<P>
nextState Readonly<S>
nextContext any

Returns: void

<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

<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

<Optional> componentDidUpdate

▸ componentDidUpdate(prevProps: Readonly<P>, 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<P>
prevState Readonly<S>
Optional snapshot SS

Returns: void

<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

see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns: void

<Optional> componentWillReceiveProps

▸ componentWillReceiveProps(nextProps: Readonly<P>, 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

see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters:

Name Type
nextProps Readonly<P>
nextContext any

Returns: void

<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

<Optional> componentWillUpdate

▸ componentWillUpdate(nextProps: Readonly<P>, 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

see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters:

Name Type
nextProps Readonly<P>
nextState Readonly<S>
nextContext any

Returns: void

<Optional> getSnapshotBeforeUpdate

▸ getSnapshotBeforeUpdate(prevProps: Readonly<P>, 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<P>
prevState Readonly<S>

Returns: SS | null

render

▸ render(): Element[]

Defined in Demo.tsx:13

Returns: Element[]

<Optional> shouldComponentUpdate

▸ shouldComponentUpdate(nextProps: Readonly<P>, 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<P>
nextState Readonly<S>
nextContext any

Returns: boolean

+ + + diff --git a/docs/ui-identicon/classes/_demo_.demo.md b/docs/ui-identicon/classes/_demo_.demo.md new file mode 100644 index 00000000..3d328321 --- /dev/null +++ b/docs/ui-identicon/classes/_demo_.demo.md @@ -0,0 +1,336 @@ + + +# Type parameters +#### P +#### S +#### SS +# Hierarchy + + `PureComponent` + +**↳ Demo** + +# Methods + + + +## `` 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` + +___ + + +## `` UNSAFE_componentWillReceiveProps + +▸ **UNSAFE_componentWillReceiveProps**(nextProps: *`Readonly`<`P`>*, 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`<`P`> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` UNSAFE_componentWillUpdate + +▸ **UNSAFE_componentWillUpdate**(nextProps: *`Readonly`<`P`>*, 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`<`P`> | +| nextState | `Readonly`<`S`> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` 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` + +___ + + +## `` 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` + +___ + + +## `` componentDidUpdate + +▸ **componentDidUpdate**(prevProps: *`Readonly`<`P`>*, 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`<`P`> | +| prevState | `Readonly`<`S`> | +| `Optional` snapshot | [SS]() | + +**Returns:** `void` + +___ + + +## `` 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` + +___ + + +## `` componentWillReceiveProps + +▸ **componentWillReceiveProps**(nextProps: *`Readonly`<`P`>*, 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`<`P`> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` 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` + +___ + + +## `` componentWillUpdate + +▸ **componentWillUpdate**(nextProps: *`Readonly`<`P`>*, 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`<`P`> | +| nextState | `Readonly`<`S`> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` getSnapshotBeforeUpdate + +▸ **getSnapshotBeforeUpdate**(prevProps: *`Readonly`<`P`>*, 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`<`P`> | +| prevState | `Readonly`<`S`> | + +**Returns:** `SS` \| `null` + +___ + + +## render + +▸ **render**(): `Element`[] + +*Defined in [Demo.tsx:13](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/Demo.tsx#L13)* + +**Returns:** `Element`[] + +___ + + +## `` shouldComponentUpdate + +▸ **shouldComponentUpdate**(nextProps: *`Readonly`<`P`>*, 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`<`P`> | +| nextState | `Readonly`<`S`> | +| nextContext | `any` | + +**Returns:** `boolean` + +___ + diff --git a/docs/ui-identicon/classes/_icons_beachball_.beachball.html b/docs/ui-identicon/classes/_icons_beachball_.beachball.html new file mode 100644 index 00000000..9f6ddfeb --- /dev/null +++ b/docs/ui-identicon/classes/_icons_beachball_.beachball.html @@ -0,0 +1,21 @@ + + + + + + Type parameters | polkadot-js/ui + + + + + + + +
polkadot-js/ui

Type parameters

S

SS

Hierarchy

PureComponent<Props>

↳ Beachball

Methods

<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

see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns: void

<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

see: 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

<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

see: 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

<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

<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

<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

<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

see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns: void

<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

see: 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

<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

<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

see: 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

<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

render

▸ render(): Element

Defined in icons/Beachball.tsx:12

Returns: Element

<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

+ + + diff --git a/docs/ui-identicon/classes/_icons_beachball_.beachball.md b/docs/ui-identicon/classes/_icons_beachball_.beachball.md new file mode 100644 index 00000000..8f1e0bd6 --- /dev/null +++ b/docs/ui-identicon/classes/_icons_beachball_.beachball.md @@ -0,0 +1,335 @@ + + +# Type parameters +#### S +#### SS +# Hierarchy + + `PureComponent`<[Props](../modules/_types_.md#props)> + +**↳ Beachball** + +# Methods + + + +## `` 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` + +___ + + +## `` UNSAFE_componentWillReceiveProps + +▸ **UNSAFE_componentWillReceiveProps**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` UNSAFE_componentWillUpdate + +▸ **UNSAFE_componentWillUpdate**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextState | `Readonly`<`S`> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` 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` + +___ + + +## `` 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` + +___ + + +## `` componentDidUpdate + +▸ **componentDidUpdate**(prevProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| prevState | `Readonly`<`S`> | +| `Optional` snapshot | [SS]() | + +**Returns:** `void` + +___ + + +## `` 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` + +___ + + +## `` componentWillReceiveProps + +▸ **componentWillReceiveProps**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` 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` + +___ + + +## `` componentWillUpdate + +▸ **componentWillUpdate**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextState | `Readonly`<`S`> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` getSnapshotBeforeUpdate + +▸ **getSnapshotBeforeUpdate**(prevProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| prevState | `Readonly`<`S`> | + +**Returns:** `SS` \| `null` + +___ + + +## render + +▸ **render**(): `Element` + +*Defined in [icons/Beachball.tsx:12](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/icons/Beachball.tsx#L12)* + +**Returns:** `Element` + +___ + + +## `` shouldComponentUpdate + +▸ **shouldComponentUpdate**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextState | `Readonly`<`S`> | +| nextContext | `any` | + +**Returns:** `boolean` + +___ + diff --git a/docs/ui-identicon/classes/_icons_empty_.empty.html b/docs/ui-identicon/classes/_icons_empty_.empty.html new file mode 100644 index 00000000..3fe6a09b --- /dev/null +++ b/docs/ui-identicon/classes/_icons_empty_.empty.html @@ -0,0 +1,21 @@ + + + + + + Type parameters | polkadot-js/ui + + + + + + + +
polkadot-js/ui

Type parameters

S

SS

Hierarchy

PureComponent<Props>

↳ Empty

Methods

<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

see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns: void

<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

see: 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

<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

see: 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

<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

<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

<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

<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

see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns: void

<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

see: 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

<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

<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

see: 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

<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

render

▸ render(): Element

Defined in icons/Empty.tsx:10

Returns: Element

<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

+ + + diff --git a/docs/ui-identicon/classes/_icons_empty_.empty.md b/docs/ui-identicon/classes/_icons_empty_.empty.md new file mode 100644 index 00000000..7e6096b4 --- /dev/null +++ b/docs/ui-identicon/classes/_icons_empty_.empty.md @@ -0,0 +1,335 @@ + + +# Type parameters +#### S +#### SS +# Hierarchy + + `PureComponent`<[Props](../modules/_types_.md#props)> + +**↳ Empty** + +# Methods + + + +## `` 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` + +___ + + +## `` UNSAFE_componentWillReceiveProps + +▸ **UNSAFE_componentWillReceiveProps**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` UNSAFE_componentWillUpdate + +▸ **UNSAFE_componentWillUpdate**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextState | `Readonly`<`S`> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` 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` + +___ + + +## `` 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` + +___ + + +## `` componentDidUpdate + +▸ **componentDidUpdate**(prevProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| prevState | `Readonly`<`S`> | +| `Optional` snapshot | [SS]() | + +**Returns:** `void` + +___ + + +## `` 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` + +___ + + +## `` componentWillReceiveProps + +▸ **componentWillReceiveProps**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` 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` + +___ + + +## `` componentWillUpdate + +▸ **componentWillUpdate**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextState | `Readonly`<`S`> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` getSnapshotBeforeUpdate + +▸ **getSnapshotBeforeUpdate**(prevProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| prevState | `Readonly`<`S`> | + +**Returns:** `SS` \| `null` + +___ + + +## render + +▸ **render**(): `Element` + +*Defined in [icons/Empty.tsx:10](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/icons/Empty.tsx#L10)* + +**Returns:** `Element` + +___ + + +## `` shouldComponentUpdate + +▸ **shouldComponentUpdate**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextState | `Readonly`<`S`> | +| nextContext | `any` | + +**Returns:** `boolean` + +___ + diff --git a/docs/ui-identicon/classes/_icons_jdenticon_.jdenticon.html b/docs/ui-identicon/classes/_icons_jdenticon_.jdenticon.html new file mode 100644 index 00000000..ed7b2f3b --- /dev/null +++ b/docs/ui-identicon/classes/_icons_jdenticon_.jdenticon.html @@ -0,0 +1,21 @@ + + + + + + Type parameters | polkadot-js/ui + + + + + + + +
polkadot-js/ui

Type parameters

S

SS

Hierarchy

PureComponent<Props>

↳ Jdenticon

Methods

<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

see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns: void

<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

see: 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

<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

see: 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

<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

<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

<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

<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

see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns: void

<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

see: 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

<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

<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

see: 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

<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

render

▸ render(): Element

Defined in icons/Jdenticon.tsx:11

Returns: Element

<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

+ + + diff --git a/docs/ui-identicon/classes/_icons_jdenticon_.jdenticon.md b/docs/ui-identicon/classes/_icons_jdenticon_.jdenticon.md new file mode 100644 index 00000000..5d2aff7e --- /dev/null +++ b/docs/ui-identicon/classes/_icons_jdenticon_.jdenticon.md @@ -0,0 +1,335 @@ + + +# Type parameters +#### S +#### SS +# Hierarchy + + `PureComponent`<[Props](../modules/_types_.md#props)> + +**↳ Jdenticon** + +# Methods + + + +## `` 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` + +___ + + +## `` UNSAFE_componentWillReceiveProps + +▸ **UNSAFE_componentWillReceiveProps**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` UNSAFE_componentWillUpdate + +▸ **UNSAFE_componentWillUpdate**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextState | `Readonly`<`S`> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` 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` + +___ + + +## `` 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` + +___ + + +## `` componentDidUpdate + +▸ **componentDidUpdate**(prevProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| prevState | `Readonly`<`S`> | +| `Optional` snapshot | [SS]() | + +**Returns:** `void` + +___ + + +## `` 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` + +___ + + +## `` componentWillReceiveProps + +▸ **componentWillReceiveProps**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` 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` + +___ + + +## `` componentWillUpdate + +▸ **componentWillUpdate**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextState | `Readonly`<`S`> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` getSnapshotBeforeUpdate + +▸ **getSnapshotBeforeUpdate**(prevProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| prevState | `Readonly`<`S`> | + +**Returns:** `SS` \| `null` + +___ + + +## render + +▸ **render**(): `Element` + +*Defined in [icons/Jdenticon.tsx:11](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/icons/Jdenticon.tsx#L11)* + +**Returns:** `Element` + +___ + + +## `` shouldComponentUpdate + +▸ **shouldComponentUpdate**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextState | `Readonly`<`S`> | +| nextContext | `any` | + +**Returns:** `boolean` + +___ + diff --git a/docs/ui-identicon/classes/_icons_polkadot_.identicon.html b/docs/ui-identicon/classes/_icons_polkadot_.identicon.html new file mode 100644 index 00000000..23502020 --- /dev/null +++ b/docs/ui-identicon/classes/_icons_polkadot_.identicon.html @@ -0,0 +1,21 @@ + + + + + + Type parameters | polkadot-js/ui + + + + + + + +
polkadot-js/ui

Type parameters

S

SS

Hierarchy

PureComponent<Props>

↳ Identicon

Methods

<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

see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns: void

<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

see: 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

<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

see: 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

<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

<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

<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

<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

see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns: void

<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

see: 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

<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

<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

see: 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

<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

render

▸ render(): Element

Defined in icons/Polkadot.tsx:50

Returns: Element

<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

+ + + diff --git a/docs/ui-identicon/classes/_icons_polkadot_.identicon.md b/docs/ui-identicon/classes/_icons_polkadot_.identicon.md new file mode 100644 index 00000000..a51901e5 --- /dev/null +++ b/docs/ui-identicon/classes/_icons_polkadot_.identicon.md @@ -0,0 +1,335 @@ + + +# Type parameters +#### S +#### SS +# Hierarchy + + `PureComponent`<[Props](../modules/_types_.md#props)> + +**↳ Identicon** + +# Methods + + + +## `` 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` + +___ + + +## `` UNSAFE_componentWillReceiveProps + +▸ **UNSAFE_componentWillReceiveProps**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` UNSAFE_componentWillUpdate + +▸ **UNSAFE_componentWillUpdate**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextState | `Readonly`<`S`> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` 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` + +___ + + +## `` 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` + +___ + + +## `` componentDidUpdate + +▸ **componentDidUpdate**(prevProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| prevState | `Readonly`<`S`> | +| `Optional` snapshot | [SS]() | + +**Returns:** `void` + +___ + + +## `` 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` + +___ + + +## `` componentWillReceiveProps + +▸ **componentWillReceiveProps**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` 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` + +___ + + +## `` componentWillUpdate + +▸ **componentWillUpdate**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextState | `Readonly`<`S`> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` getSnapshotBeforeUpdate + +▸ **getSnapshotBeforeUpdate**(prevProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| prevState | `Readonly`<`S`> | + +**Returns:** `SS` \| `null` + +___ + + +## render + +▸ **render**(): `Element` + +*Defined in [icons/Polkadot.tsx:50](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/icons/Polkadot.tsx#L50)* + +**Returns:** `Element` + +___ + + +## `` shouldComponentUpdate + +▸ **shouldComponentUpdate**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextState | `Readonly`<`S`> | +| nextContext | `any` | + +**Returns:** `boolean` + +___ + diff --git a/docs/ui-identicon/classes/_identicon_.identityicon.html b/docs/ui-identicon/classes/_identicon_.identityicon.html new file mode 100644 index 00000000..02ff3d8b --- /dev/null +++ b/docs/ui-identicon/classes/_identicon_.identityicon.html @@ -0,0 +1,21 @@ + + + + + + Type parameters | polkadot-js/ui + + + + + + + +
polkadot-js/ui

Type parameters

SS

Hierarchy

PureComponent<Props, State>

↳ IdentityIcon

Methods

<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

see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns: void

<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

see: 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

<Optional> UNSAFE_componentWillUpdate

▸ UNSAFE_componentWillUpdate(nextProps: Readonly<Props>, nextState: Readonly<State>, 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

see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters:

Name Type
nextProps Readonly<Props>
nextState Readonly<State>
nextContext any

Returns: void

<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

<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

<Optional> componentDidUpdate

▸ componentDidUpdate(prevProps: Readonly<Props>, prevState: Readonly<State>, 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<State>
Optional snapshot SS

Returns: void

<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

see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns: void

<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

see: 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

<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

<Optional> componentWillUpdate

▸ componentWillUpdate(nextProps: Readonly<Props>, nextState: Readonly<State>, 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

see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters:

Name Type
nextProps Readonly<Props>
nextState Readonly<State>
nextContext any

Returns: void

<Optional> getSnapshotBeforeUpdate

▸ getSnapshotBeforeUpdate(prevProps: Readonly<Props>, prevState: Readonly<State>): 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<State>

Returns: SS | null

render

▸ render(): Element

Defined in Identicon.tsx:91

Returns: Element

<Optional> shouldComponentUpdate

▸ shouldComponentUpdate(nextProps: Readonly<Props>, nextState: Readonly<State>, 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<State>
nextContext any

Returns: boolean

<Static> getDerivedStateFromProps

▸ getDerivedStateFromProps(__namedParameters: object, prevState: State): State | null

Defined in Identicon.tsx:71

Parameters:

Name Type
__namedParameters object
prevState State

Returns: State | null

<Static> setDefaultPrefix

▸ setDefaultPrefix(prefix: Prefix): void

Defined in Identicon.tsx:67

Parameters:

Name Type
prefix Prefix

Returns: void

Object literals

state

state: object

Defined in Identicon.tsx:61

address

● address: null = null

Defined in Identicon.tsx:62

+ + + diff --git a/docs/ui-identicon/classes/_identicon_.identityicon.md b/docs/ui-identicon/classes/_identicon_.identityicon.md new file mode 100644 index 00000000..4db234c9 --- /dev/null +++ b/docs/ui-identicon/classes/_identicon_.identityicon.md @@ -0,0 +1,391 @@ + + +# Type parameters +#### SS +# Hierarchy + + `PureComponent`<[Props](../modules/_types_.md#props), `State`> + +**↳ IdentityIcon** + +# Methods + + + +## `` 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` + +___ + + +## `` UNSAFE_componentWillReceiveProps + +▸ **UNSAFE_componentWillReceiveProps**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` UNSAFE_componentWillUpdate + +▸ **UNSAFE_componentWillUpdate**(nextProps: *`Readonly`<[Props](../modules/_types_.md#props)>*, nextState: *`Readonly`<`State`>*, 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](../modules/_types_.md#props)> | +| nextState | `Readonly`<`State`> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` 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` + +___ + + +## `` 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` + +___ + + +## `` componentDidUpdate + +▸ **componentDidUpdate**(prevProps: *`Readonly`<[Props](../modules/_types_.md#props)>*, prevState: *`Readonly`<`State`>*, 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](../modules/_types_.md#props)> | +| prevState | `Readonly`<`State`> | +| `Optional` snapshot | [SS]() | + +**Returns:** `void` + +___ + + +## `` 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` + +___ + + +## `` componentWillReceiveProps + +▸ **componentWillReceiveProps**(nextProps: *`Readonly`<[Props](../modules/_types_.md#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](../modules/_types_.md#props)> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` 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` + +___ + + +## `` componentWillUpdate + +▸ **componentWillUpdate**(nextProps: *`Readonly`<[Props](../modules/_types_.md#props)>*, nextState: *`Readonly`<`State`>*, 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](../modules/_types_.md#props)> | +| nextState | `Readonly`<`State`> | +| nextContext | `any` | + +**Returns:** `void` + +___ + + +## `` getSnapshotBeforeUpdate + +▸ **getSnapshotBeforeUpdate**(prevProps: *`Readonly`<[Props](../modules/_types_.md#props)>*, prevState: *`Readonly`<`State`>*): `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](../modules/_types_.md#props)> | +| prevState | `Readonly`<`State`> | + +**Returns:** `SS` \| `null` + +___ + + +## render + +▸ **render**(): `Element` + +*Defined in [Identicon.tsx:91](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/Identicon.tsx#L91)* + +**Returns:** `Element` + +___ + + +## `` shouldComponentUpdate + +▸ **shouldComponentUpdate**(nextProps: *`Readonly`<[Props](../modules/_types_.md#props)>*, nextState: *`Readonly`<`State`>*, 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](../modules/_types_.md#props)> | +| nextState | `Readonly`<`State`> | +| nextContext | `any` | + +**Returns:** `boolean` + +___ + + +## `` getDerivedStateFromProps + +▸ **getDerivedStateFromProps**(__namedParameters: *`object`*, prevState: *`State`*): `State` \| `null` + +*Defined in [Identicon.tsx:71](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/Identicon.tsx#L71)* + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| __namedParameters | `object` | +| prevState | `State` | + +**Returns:** `State` \| `null` + +___ + + +## `` setDefaultPrefix + +▸ **setDefaultPrefix**(prefix: *`Prefix`*): `void` + +*Defined in [Identicon.tsx:67](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/Identicon.tsx#L67)* + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| prefix | `Prefix` | + +**Returns:** `void` + +___ + +# Object literals + + + +## state + +**state**: *`object`* + +*Defined in [Identicon.tsx:61](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/Identicon.tsx#L61)* + + + +### address + +**● address**: *`null`* = null + +*Defined in [Identicon.tsx:62](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/Identicon.tsx#L62)* + +___ + +___ + diff --git a/docs/ui-identicon/index.html b/docs/ui-identicon/index.html new file mode 100644 index 00000000..733ee090 --- /dev/null +++ b/docs/ui-identicon/index.html @@ -0,0 +1,47 @@ + + + + + + polkadot-js/ui + + + + + + + +
polkadot-js/ui

@polkadot/ui-identicon

A generic identity icon that can render icons based on the theme, be it Substrate or Polkadot

Usage Examples

To install the component, do yarn add @polkadot/ui-identicon

Inside a React component, you can now render any account with the associated icon -

import Identicon from '@polkadot/ui-identicon';
+
+...
+render () {
+  // address is an ss58-encoded address or publicKey (hex string or Uint8Array)
+  const { address } = this.props;
+  // size (optional) is a number, indicating the size (in pixels, 64 as default)
+  const size = 32;
+  // theme (optional), depicts the type of icon, one of
+  // 'polkadot', 'substrate' (default), 'beachball' or 'jdenticon'
+  const theme = 'polkadot';
+
+  // standard className & style props are also available
+  return (
+    <Identicon
+      value={address}
+      size={size}
+      theme={theme}
+    />
+  );
+}
+...
+
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

+ @polkadot/ui-keyring + + → +

+ + + diff --git a/docs/ui-identicon/modules/_beachball_colors_.html b/docs/ui-identicon/modules/_beachball_colors_.html new file mode 100644 index 00000000..cd679d27 --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_colors_.html @@ -0,0 +1,21 @@ + + + + + + Functions | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-identicon/modules/_beachball_colors_.md b/docs/ui-identicon/modules/_beachball_colors_.md new file mode 100644 index 00000000..b44bbcc1 --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_colors_.md @@ -0,0 +1,22 @@ + + +# Functions + + + +## colors + +▸ **colors**(seeder: *[Seeder](_beachball_types_.md#seeder)*): [ColorGen](_beachball_types_.md#colorgen) + +*Defined in [beachball/colors.ts:14](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/colors.ts#L14)* + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| seeder | [Seeder](_beachball_types_.md#seeder) | + +**Returns:** [ColorGen](_beachball_types_.md#colorgen) + +___ + diff --git a/docs/ui-identicon/modules/_beachball_container_.html b/docs/ui-identicon/modules/_beachball_container_.html new file mode 100644 index 00000000..9096f591 --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_container_.html @@ -0,0 +1,21 @@ + + + + + + Functions | polkadot-js/ui + + + + + + + +
polkadot-js/ui

Functions

container

▸ container(diameter: number, background?: string, className?: string, _style?: object): HTMLElement

Defined in beachball/container.ts:6

Parameters:

Name Type Default value
diameter number -
Default value background string "white"
Default value className string ""
Default value _style object {}

Returns: HTMLElement

+ + + diff --git a/docs/ui-identicon/modules/_beachball_container_.md b/docs/ui-identicon/modules/_beachball_container_.md new file mode 100644 index 00000000..5c76bfe7 --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_container_.md @@ -0,0 +1,25 @@ + + +# Functions + + + +## container + +▸ **container**(diameter: *`number`*, background?: *`string`*, className?: *`string`*, _style?: *`object`*): `HTMLElement` + +*Defined in [beachball/container.ts:6](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/container.ts#L6)* + +**Parameters:** + +| Name | Type | Default value | +| ------ | ------ | ------ | +| diameter | `number` | - | +| `Default value` background | `string` | "white" | +| `Default value` className | `string` | "" | +| `Default value` _style | `object` | {} | + +**Returns:** `HTMLElement` + +___ + diff --git a/docs/ui-identicon/modules/_beachball_defaults_.html b/docs/ui-identicon/modules/_beachball_defaults_.html new file mode 100644 index 00000000..c37a5acd --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_defaults_.html @@ -0,0 +1,21 @@ + + + + + + polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-identicon/modules/_beachball_defaults_.md b/docs/ui-identicon/modules/_beachball_defaults_.md new file mode 100644 index 00000000..139597f9 --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_defaults_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/ui-identicon/modules/_beachball_demo_.html b/docs/ui-identicon/modules/_beachball_demo_.html new file mode 100644 index 00000000..6d9000b7 --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_demo_.html @@ -0,0 +1,21 @@ + + + + + + polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-identicon/modules/_beachball_demo_.md b/docs/ui-identicon/modules/_beachball_demo_.md new file mode 100644 index 00000000..139597f9 --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_demo_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/ui-identicon/modules/_beachball_seeder_.html b/docs/ui-identicon/modules/_beachball_seeder_.html new file mode 100644 index 00000000..d5d30191 --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_seeder_.html @@ -0,0 +1,21 @@ + + + + + + Functions | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-identicon/modules/_beachball_seeder_.md b/docs/ui-identicon/modules/_beachball_seeder_.md new file mode 100644 index 00000000..c12fbc2c --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_seeder_.md @@ -0,0 +1,22 @@ + + +# Functions + + + +## seeder + +▸ **seeder**(_seed?: *`string` \| `Uint8Array`*): [Seeder](_beachball_types_.md#seeder) + +*Defined in [beachball/seeder.ts:11](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/seeder.ts#L11)* + +**Parameters:** + +| Name | Type | Default value | +| ------ | ------ | ------ | +| `Default value` _seed | `string` \| `Uint8Array` | new Uint8Array(32) | + +**Returns:** [Seeder](_beachball_types_.md#seeder) + +___ + diff --git a/docs/ui-identicon/modules/_beachball_shape_circle_.html b/docs/ui-identicon/modules/_beachball_shape_circle_.html new file mode 100644 index 00000000..058457b8 --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_shape_circle_.html @@ -0,0 +1,21 @@ + + + + + + Functions | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-identicon/modules/_beachball_shape_circle_.md b/docs/ui-identicon/modules/_beachball_shape_circle_.md new file mode 100644 index 00000000..508c9ecf --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_shape_circle_.md @@ -0,0 +1,25 @@ + + +# Functions + + + +## circle + +▸ **circle**(seeder: *[Seeder](_beachball_types_.md#seeder)*, fill: *`string`*, diameter: *`number`*, count: *`number`*): `Element` + +*Defined in [beachball/shape/circle.ts:11](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/shape/circle.ts#L11)* + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| seeder | [Seeder](_beachball_types_.md#seeder) | +| fill | `string` | +| diameter | `number` | +| count | `number` | + +**Returns:** `Element` + +___ + diff --git a/docs/ui-identicon/modules/_beachball_shape_square_.html b/docs/ui-identicon/modules/_beachball_shape_square_.html new file mode 100644 index 00000000..62293d23 --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_shape_square_.html @@ -0,0 +1,21 @@ + + + + + + Functions | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-identicon/modules/_beachball_shape_square_.md b/docs/ui-identicon/modules/_beachball_shape_square_.md new file mode 100644 index 00000000..069f893a --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_shape_square_.md @@ -0,0 +1,25 @@ + + +# Functions + + + +## square + +▸ **square**(seeder: *[Seeder](_beachball_types_.md#seeder)*, fill: *`string`*, diameter: *`number`*, count: *`number`*): `Element` + +*Defined in [beachball/shape/square.ts:11](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/shape/square.ts#L11)* + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| seeder | [Seeder](_beachball_types_.md#seeder) | +| fill | `string` | +| diameter | `number` | +| count | `number` | + +**Returns:** `Element` + +___ + diff --git a/docs/ui-identicon/modules/_beachball_svg_circle_.html b/docs/ui-identicon/modules/_beachball_svg_circle_.html new file mode 100644 index 00000000..6d4c646b --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_svg_circle_.html @@ -0,0 +1,21 @@ + + + + + + Functions | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-identicon/modules/_beachball_svg_circle_.md b/docs/ui-identicon/modules/_beachball_svg_circle_.md new file mode 100644 index 00000000..8cfa5607 --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_svg_circle_.md @@ -0,0 +1,24 @@ + + +# Functions + + + +## circle + +▸ **circle**(r: *`number`*, cx: *`number`*, cy: *`number`*): `Element` + +*Defined in [beachball/svg/circle.ts:7](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/svg/circle.ts#L7)* + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| r | `number` | +| cx | `number` | +| cy | `number` | + +**Returns:** `Element` + +___ + diff --git a/docs/ui-identicon/modules/_beachball_svg_element_.html b/docs/ui-identicon/modules/_beachball_svg_element_.html new file mode 100644 index 00000000..e3957409 --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_svg_element_.html @@ -0,0 +1,21 @@ + + + + + + Functions | polkadot-js/ui + + + + + + + +
polkadot-js/ui

Functions

element

▸ element(size: number, type?: string, x?: number, y?: number): Element

Defined in beachball/svg/element.ts:8

Parameters:

Name Type Default value
size number -
Default value type string "svg"
Default value x number 0
Default value y number 0

Returns: Element

+ + + diff --git a/docs/ui-identicon/modules/_beachball_svg_element_.md b/docs/ui-identicon/modules/_beachball_svg_element_.md new file mode 100644 index 00000000..33290925 --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_svg_element_.md @@ -0,0 +1,25 @@ + + +# Functions + + + +## element + +▸ **element**(size: *`number`*, type?: *`string`*, x?: *`number`*, y?: *`number`*): `Element` + +*Defined in [beachball/svg/element.ts:8](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/svg/element.ts#L8)* + +**Parameters:** + +| Name | Type | Default value | +| ------ | ------ | ------ | +| size | `number` | - | +| `Default value` type | `string` | "svg" | +| `Default value` x | `number` | 0 | +| `Default value` y | `number` | 0 | + +**Returns:** `Element` + +___ + diff --git a/docs/ui-identicon/modules/_beachball_svg_rect_.html b/docs/ui-identicon/modules/_beachball_svg_rect_.html new file mode 100644 index 00000000..08c55ad4 --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_svg_rect_.html @@ -0,0 +1,21 @@ + + + + + + Functions | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-identicon/modules/_beachball_svg_rect_.md b/docs/ui-identicon/modules/_beachball_svg_rect_.md new file mode 100644 index 00000000..390e810a --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_svg_rect_.md @@ -0,0 +1,22 @@ + + +# Functions + + + +## rect + +▸ **rect**(size: *`number`*): `Element` + +*Defined in [beachball/svg/rect.ts:7](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/svg/rect.ts#L7)* + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| size | `number` | + +**Returns:** `Element` + +___ + diff --git a/docs/ui-identicon/modules/_beachball_svg_svg_.html b/docs/ui-identicon/modules/_beachball_svg_svg_.html new file mode 100644 index 00000000..d8f5a251 --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_svg_svg_.html @@ -0,0 +1,21 @@ + + + + + + Functions | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-identicon/modules/_beachball_svg_svg_.md b/docs/ui-identicon/modules/_beachball_svg_svg_.md new file mode 100644 index 00000000..7808194f --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_svg_svg_.md @@ -0,0 +1,22 @@ + + +# Functions + + + +## svg + +▸ **svg**(type: *`string`*): `Element` + +*Defined in [beachball/svg/svg.ts:8](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/svg/svg.ts#L8)* + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| type | `string` | + +**Returns:** `Element` + +___ + diff --git a/docs/ui-identicon/modules/_beachball_types_.html b/docs/ui-identicon/modules/_beachball_types_.html new file mode 100644 index 00000000..13dce4ed --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_types_.html @@ -0,0 +1,21 @@ + + + + + + Type aliases | polkadot-js/ui + + + + + + + +
polkadot-js/ui

Type aliases

ColorGen

Ƭ ColorGen: function

Defined in beachball/types.ts:7

Type declaration

▸(alpha?: undefined | number): string

Parameters:

Name Type
Optional alpha undefined | number

Returns: string

Seeder

Ƭ Seeder: function

Defined in beachball/types.ts:5

Type declaration

▸(): number

Returns: number

+ + + diff --git a/docs/ui-identicon/modules/_beachball_types_.md b/docs/ui-identicon/modules/_beachball_types_.md new file mode 100644 index 00000000..650cee8c --- /dev/null +++ b/docs/ui-identicon/modules/_beachball_types_.md @@ -0,0 +1,39 @@ + + +# Type aliases + + + +## ColorGen + +**Ƭ ColorGen**: *`function`* + +*Defined in [beachball/types.ts:7](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/types.ts#L7)* + +#### Type declaration +▸(alpha?: *`undefined` \| `number`*): `string` + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| `Optional` alpha | `undefined` \| `number` | + +**Returns:** `string` + +___ + + +## Seeder + +**Ƭ Seeder**: *`function`* + +*Defined in [beachball/types.ts:5](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/beachball/types.ts#L5)* + +#### Type declaration +▸(): `number` + +**Returns:** `number` + +___ + diff --git a/docs/ui-identicon/modules/_demo_.html b/docs/ui-identicon/modules/_demo_.html new file mode 100644 index 00000000..78dfa7c1 --- /dev/null +++ b/docs/ui-identicon/modules/_demo_.html @@ -0,0 +1,21 @@ + + + + + + Index | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-identicon/modules/_demo_.md b/docs/ui-identicon/modules/_demo_.md new file mode 100644 index 00000000..ac5a2aa6 --- /dev/null +++ b/docs/ui-identicon/modules/_demo_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Demo](../classes/_demo_.demo.md) + +--- + diff --git a/docs/ui-identicon/modules/_icons_beachball_.html b/docs/ui-identicon/modules/_icons_beachball_.html new file mode 100644 index 00000000..ad0b4e3a --- /dev/null +++ b/docs/ui-identicon/modules/_icons_beachball_.html @@ -0,0 +1,21 @@ + + + + + + Index | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-identicon/modules/_icons_beachball_.md b/docs/ui-identicon/modules/_icons_beachball_.md new file mode 100644 index 00000000..fb61e4a5 --- /dev/null +++ b/docs/ui-identicon/modules/_icons_beachball_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Beachball](../classes/_icons_beachball_.beachball.md) + +--- + diff --git a/docs/ui-identicon/modules/_icons_empty_.html b/docs/ui-identicon/modules/_icons_empty_.html new file mode 100644 index 00000000..c561d835 --- /dev/null +++ b/docs/ui-identicon/modules/_icons_empty_.html @@ -0,0 +1,21 @@ + + + + + + Index | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-identicon/modules/_icons_empty_.md b/docs/ui-identicon/modules/_icons_empty_.md new file mode 100644 index 00000000..f6bd6b12 --- /dev/null +++ b/docs/ui-identicon/modules/_icons_empty_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Empty](../classes/_icons_empty_.empty.md) + +--- + diff --git a/docs/ui-identicon/modules/_icons_jdenticon_.html b/docs/ui-identicon/modules/_icons_jdenticon_.html new file mode 100644 index 00000000..014e80f0 --- /dev/null +++ b/docs/ui-identicon/modules/_icons_jdenticon_.html @@ -0,0 +1,21 @@ + + + + + + Index | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-identicon/modules/_icons_jdenticon_.md b/docs/ui-identicon/modules/_icons_jdenticon_.md new file mode 100644 index 00000000..fbb63357 --- /dev/null +++ b/docs/ui-identicon/modules/_icons_jdenticon_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Jdenticon](../classes/_icons_jdenticon_.jdenticon.md) + +--- + diff --git a/docs/ui-identicon/modules/_icons_polkadot_.html b/docs/ui-identicon/modules/_icons_polkadot_.html new file mode 100644 index 00000000..3a62760c --- /dev/null +++ b/docs/ui-identicon/modules/_icons_polkadot_.html @@ -0,0 +1,21 @@ + + + + + + Index | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-identicon/modules/_icons_polkadot_.md b/docs/ui-identicon/modules/_icons_polkadot_.md new file mode 100644 index 00000000..56f3b09b --- /dev/null +++ b/docs/ui-identicon/modules/_icons_polkadot_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Identicon](../classes/_icons_polkadot_.identicon.md) + +--- + diff --git a/docs/ui-identicon/modules/_identicon_.html b/docs/ui-identicon/modules/_identicon_.html new file mode 100644 index 00000000..abaa7495 --- /dev/null +++ b/docs/ui-identicon/modules/_identicon_.html @@ -0,0 +1,21 @@ + + + + + + Index | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-identicon/modules/_identicon_.md b/docs/ui-identicon/modules/_identicon_.md new file mode 100644 index 00000000..6504a643 --- /dev/null +++ b/docs/ui-identicon/modules/_identicon_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [IdentityIcon](../classes/_identicon_.identityicon.md) + +--- + diff --git a/docs/ui-identicon/modules/_types_.html b/docs/ui-identicon/modules/_types_.html new file mode 100644 index 00000000..0045018a --- /dev/null +++ b/docs/ui-identicon/modules/_types_.html @@ -0,0 +1,21 @@ + + + + + + Type aliases | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-identicon/modules/_types_.md b/docs/ui-identicon/modules/_types_.md new file mode 100644 index 00000000..1c43b09c --- /dev/null +++ b/docs/ui-identicon/modules/_types_.md @@ -0,0 +1,34 @@ + + +# Type aliases + + + +## BaseProps + +**Ƭ BaseProps**: *`object`* + +*Defined in [types.ts:7](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/types.ts#L7)* + +#### Type declaration + +___ + + +## IdentityProps + +**Ƭ IdentityProps**: *[BaseProps](_types_.md#baseprops) & `object`* + +*Defined in [types.ts:19](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/types.ts#L19)* + +___ + + +## Props + +**Ƭ Props**: *[BaseProps](_types_.md#baseprops) & `object`* + +*Defined in [types.ts:14](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-identicon/src/types.ts#L14)* + +___ + diff --git a/docs/ui-keyring/README.md b/docs/ui-keyring/README.md new file mode 100644 index 00000000..2ca9944a --- /dev/null +++ b/docs/ui-keyring/README.md @@ -0,0 +1,141 @@ + +@polkadot/ui-keyring +==================== + +A wrapper extending the base @polkadot/keyring interface for usage in the browser: Key management of user accounts including generation and retrieval of keyring pairs from a variety of input combinations. + +Usage Examples +-------------- + +All module methods are exposed through a single default export. + +### Regular + +```js +import keyring from @polkadot/ui-keyring + +render () { + // encode publicKey to ss58 address + const address = keyring.encodeAddress(publicKey); + + // get keyring pair from ss58 address + const pair = keyring.getPair(address); + + // ask questions about that particular keyring pair + const isLocked = pair.isLocked(); + const meta = pair.getMeta(); + + // save account from pair + keyring.saveAccount(pair, password); + + // save address without unlocking it + keyring.saveAddress(address, { ...meta }); +} +``` + +Observables +----------- + +Option 1: Declarative subscribe/unsubscribe w/ react-with-observable (recommended 'React' way) + +```js +import accountObservable from '@polkadot/ui-keyring/observable/accounts'; +import { SingleAddress, SubjectInfo } from '@polkadot/ui-keyring/observable/types'; +import React from 'react'; +import { Subscribe } from 'react-with-observable'; +import { map } from 'rxjs/operators'; + +class MyReactComponent extends React.PureComponent { + render () { + + {accountObservable.subject.pipe( + map((allAccounts: SubjectInfo) => + !allAccounts + ? this.renderEmpty() + : Object.values(allAccounts).map((account: SingleAddress) => + // Your component goes here + console.log(account.json.address) + ) + ))} + + } + + renderEmpty () { + return ( +
no accounts to display ...
+ ); + } +} + +``` + +Option 2: Imperative subscribe/unsubscribe + +```js +import accountObservable from '@polkadot/ui-keyring/observable/accounts'; +import { SingleAddress, SubjectInfo } from '@polkadot/ui-keyring/observable/types'; +import React from 'react'; +import { Subscription } from 'rxjs'; + +type State = { + allAccounts?: SubjectInfo, + subscriptions?: [Subscription] +} + +class MyReactComponent extends React.PureComponent { + componentDidMount () { + const accountSubscription = accountObservable.subject.subscribe((observedAccounts) => { + this.setState({ + accounts: observedAccounts + }); + }) + + this.setState({ + subscriptions: [accountSubscription] + }); + } + + componentWillUnmount () { + const { subscriptions } = this.state; + + for (s in subscriptions) { + s.subject.unsubscribe(); + } + } + + render () { + const { accounts } = this.state; + + return ( +

All Accounts

+ { + Object.keys(accounts).map((address: SingleAddress) => { + return

{address}

; + }) + } + ) + } +} +``` + +FAQ +--- + +* Difference between Keyring Accounts and Addresses? + * From the perspective of the keyring, it saves a particular user's unlocked identities as an account, a la keyring.saveAccount(pair, password). So with these accounts you are able to send and sign transactions. + * To save addresses without unlocking them (i.e. because a user might want to have easy access to addresses they frequently transact with), use keyring.saveAddress(address, meta) +* What are 'external' accounts, i.e. when to set the `isExternal` meta key to true? + * An external account is one where the keys are not managed by keyring, e.g. in Parity Signer or Ledger Nano. +* SS58 Encode / Decode? + * SS58 is a simple address format designed for Substrate based chains. You can read about its specification in more detail in the [Parity Wiki](https://wiki.parity.io/External-Address-Format-(SS58)). + +**If you have any unanswered/undocumented questions, please raise an issue [here](https://github.com/polkadot-js/ui/issues).** + +Users +----- + +Keyring is core to many polkadot/substrate apps. + +* [polkadot-js/apps](https://github.com/polkadot-js/apps) +* [paritytech/substrate-light-ui](https://github.com/paritytech/substrate-light-ui) + diff --git a/docs/ui-keyring/SUMMARY.html b/docs/ui-keyring/SUMMARY.html new file mode 100644 index 00000000..911f9d79 --- /dev/null +++ b/docs/ui-keyring/SUMMARY.html @@ -0,0 +1,21 @@ + + + + + + polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-keyring/SUMMARY.md b/docs/ui-keyring/SUMMARY.md new file mode 100644 index 00000000..0761abff --- /dev/null +++ b/docs/ui-keyring/SUMMARY.md @@ -0,0 +1,17 @@ +* ["Base"](modules/_base_.md) + * [Base](classes/_base_.base.md) +* ["Keyring"](modules/_keyring_.md) + * [Keyring](classes/_keyring_.keyring.md) +* ["defaults"](modules/_defaults_.md) +* ["observable/accounts"](modules/_observable_accounts_.md) +* ["observable/addresses"](modules/_observable_addresses_.md) +* ["observable/development"](modules/_observable_development_.md) +* ["observable/genericSubject"](modules/_observable_genericsubject_.md) +* ["observable/types"](modules/_observable_types_.md) +* ["options/KeyPair"](modules/_options_keypair_.md) + * [KeyPair](classes/_options_keypair_.keypair.md) +* ["options/item"](modules/_options_item_.md) +* ["options/types"](modules/_options_types_.md) + * [KeyringOptionInstance](interfaces/_options_types_.keyringoptioninstance.md) +* ["types"](modules/_types_.md) + * [KeyringStruct](interfaces/_types_.keyringstruct.md) diff --git a/docs/ui-keyring/classes/_base_.base.html b/docs/ui-keyring/classes/_base_.base.html new file mode 100644 index 00000000..4f88c716 --- /dev/null +++ b/docs/ui-keyring/classes/_base_.base.html @@ -0,0 +1,21 @@ + + + + + + Hierarchy | polkadot-js/ui + + + + + + + +
polkadot-js/ui

Hierarchy

Base

↳ Keyring

Constructors

constructor

⊕ new Base(): Base

Defined in Base.ts:22

Returns: Base

Accessors

accounts

get accounts(): object

Defined in Base.ts:30

Returns: object

addresses

get addresses(): object

Defined in Base.ts:34

Returns: object

keyring

get keyring(): KeyringInstance

Defined in Base.ts:38

Returns: KeyringInstance

Methods

decodeAddress

▸ decodeAddress(key: string | Uint8Array): Uint8Array

Defined in Base.ts:46

Parameters:

Name Type
key string | Uint8Array

Returns: Uint8Array

encodeAddress

▸ encodeAddress(key: string | Uint8Array): string

Defined in Base.ts:50

Parameters:

Name Type
key string | Uint8Array

Returns: string

getPair

▸ getPair(address: string | Uint8Array): KeyringPair

Defined in Base.ts:54

Parameters:

Name Type
address string | Uint8Array

Returns: KeyringPair

getPairs

▸ getPairs(): Array<KeyringPair>

Defined in Base.ts:58

Returns: Array<KeyringPair>

isAvailable

▸ isAvailable(_address: Uint8Array | string): boolean

Defined in Base.ts:64

Parameters:

Name Type
_address Uint8Array | string

Returns: boolean

isPassValid

▸ isPassValid(password: string): boolean

Defined in Base.ts:74

Parameters:

Name Type
password string

Returns: boolean

setAddressPrefix

▸ setAddressPrefix(prefix: number): void

Defined in Base.ts:78

Parameters:

Name Type
prefix number

Returns: void

setDevMode

▸ setDevMode(isDevelopment: boolean): void

Defined in Base.ts:82

Parameters:

Name Type
isDevelopment boolean

Returns: void

+ + + diff --git a/docs/ui-keyring/classes/_base_.base.md b/docs/ui-keyring/classes/_base_.base.md new file mode 100644 index 00000000..9d538f04 --- /dev/null +++ b/docs/ui-keyring/classes/_base_.base.md @@ -0,0 +1,191 @@ + + +# Hierarchy + +**Base** + +↳ [Keyring](_keyring_.keyring.md) + +# Constructors + + + +## 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 + + + +## 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` + +___ + + +## 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` + +___ + + +## 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 + + + +## 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` + +___ + + +## 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` + +___ + + +## 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` + +___ + + +## 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`> + +___ + + +## 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` + +___ + + +## 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` + +___ + + +## 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` + +___ + + +## 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` + +___ + diff --git a/docs/ui-keyring/classes/_keyring_.keyring.html b/docs/ui-keyring/classes/_keyring_.keyring.html new file mode 100644 index 00000000..f43748cf --- /dev/null +++ b/docs/ui-keyring/classes/_keyring_.keyring.html @@ -0,0 +1,21 @@ + + + + + + Hierarchy | polkadot-js/ui + + + + + + + +
polkadot-js/ui

Hierarchy

Base

↳ Keyring

Implements

Constructors

constructor

⊕ new Keyring(): Keyring

Inherited from Base.constructor

Defined in Base.ts:22

Returns: Keyring

Accessors

accounts

get accounts(): object

Inherited from Base.accounts

Defined in Base.ts:30

Returns: object

addresses

get addresses(): object

Inherited from Base.addresses

Defined in Base.ts:34

Returns: object

keyring

get keyring(): KeyringInstance

Inherited from Base.keyring

Defined in Base.ts:38

Returns: KeyringInstance

Methods

addAccountPair

▸ addAccountPair(pair: KeyringPair, password: string): KeyringPair

Defined in Keyring.ts:22

Parameters:

Name Type
pair KeyringPair
password string

Returns: KeyringPair

backupAccount

▸ backupAccount(pair: KeyringPair, password: string): KeyringPair$Json

Defined in Keyring.ts:29

Parameters:

Name Type
pair KeyringPair
password string

Returns: KeyringPair$Json

createAccount

▸ createAccount(seed: Uint8Array, password?: undefined | string, meta?: KeyringPair$Meta): KeyringPair

Defined in Keyring.ts:39

Parameters:

Name Type Default value
seed Uint8Array -
Optional password undefined | string -
Default value meta KeyringPair$Meta {}

Returns: KeyringPair

createAccountExternal

▸ createAccountExternal(publicKey: Uint8Array, meta?: KeyringPair$Meta): KeyringPair

Defined in Keyring.ts:47

Parameters:

Name Type Default value
publicKey Uint8Array -
Default value meta KeyringPair$Meta {}

Returns: KeyringPair

createAccountMnemonic

▸ createAccountMnemonic(seed: string, password?: undefined | string, meta?: KeyringPair$Meta): KeyringPair

Defined in Keyring.ts:55

Parameters:

Name Type Default value
seed string -
Optional password undefined | string -
Default value meta KeyringPair$Meta {}

Returns: KeyringPair

decodeAddress

▸ decodeAddress(key: string | Uint8Array): Uint8Array

Inherited from Base.decodeAddress

Defined in Base.ts:46

Parameters:

Name Type
key string | Uint8Array

Returns: Uint8Array

encodeAddress

▸ encodeAddress(key: string | Uint8Array): string

Inherited from Base.encodeAddress

Defined in Base.ts:50

Parameters:

Name Type
key string | Uint8Array

Returns: string

encryptAccount

▸ encryptAccount(pair: KeyringPair, password: string): void

Defined in Keyring.ts:63

Parameters:

Name Type
pair KeyringPair
password string

Returns: void

forgetAccount

▸ forgetAccount(address: string): void

Defined in Keyring.ts:72

Parameters:

Name Type
address string

Returns: void

forgetAddress

▸ forgetAddress(address: string): void

Defined in Keyring.ts:77

Parameters:

Name Type
address string

Returns: void

getAccount

▸ getAccount(address: string | Uint8Array): KeyringAddress

Defined in Keyring.ts:81

Parameters:

Name Type
address string | Uint8Array

Returns: KeyringAddress

getAccounts

▸ getAccounts(): Array<KeyringAddress>

Defined in Keyring.ts:85

Returns: Array<KeyringAddress>

getAddress

▸ getAddress(_address: string | Uint8Array, type?: "account" | "address"): KeyringAddress

Defined in Keyring.ts:94

Parameters:

Name Type Default value
_address string | Uint8Array -
Default value type "account" | "address" "address"

Returns: KeyringAddress

getAddresses

▸ getAddresses(): Array<KeyringAddress>

Defined in Keyring.ts:115

Returns: Array<KeyringAddress>

getPair

▸ getPair(address: string | Uint8Array): KeyringPair

Inherited from Base.getPair

Defined in Base.ts:54

Parameters:

Name Type
address string | Uint8Array

Returns: KeyringPair

getPairs

▸ getPairs(): Array<KeyringPair>

Inherited from Base.getPairs

Defined in Base.ts:58

Returns: Array<KeyringPair>

isAvailable

▸ isAvailable(_address: Uint8Array | string): boolean

Inherited from Base.isAvailable

Defined in Base.ts:64

Parameters:

Name Type
_address Uint8Array | string

Returns: boolean

isPassValid

▸ isPassValid(password: string): boolean

Inherited from Base.isPassValid

Defined in Base.ts:74

Parameters:

Name Type
password string

Returns: boolean

loadAll

▸ loadAll(options: KeyringOptions): void

Defined in Keyring.ts:156

Parameters:

Name Type
options KeyringOptions

Returns: void

restoreAccount

▸ restoreAccount(json: KeyringPair$Json, password: string): KeyringPair

Defined in Keyring.ts:170

Parameters:

Name Type
json KeyringPair$Json
password string

Returns: KeyringPair

saveAccount

▸ saveAccount(pair: KeyringPair, password?: undefined | string): void

Defined in Keyring.ts:188

Parameters:

Name Type
pair KeyringPair
Optional password undefined | string

Returns: void

saveAccountMeta

▸ saveAccountMeta(pair: KeyringPair, meta: KeyringPair$Meta): void

Defined in Keyring.ts:197

Parameters:

Name Type
pair KeyringPair
meta KeyringPair$Meta

Returns: void

saveAddress

▸ saveAddress(address: string, meta: KeyringPair$Meta): void

Defined in Keyring.ts:207

Parameters:

Name Type
address string
meta KeyringPair$Meta

Returns: void

saveRecent

▸ saveRecent(address: string): SingleAddress

Defined in Keyring.ts:227

Parameters:

Name Type
address string

Returns: SingleAddress

setAddressPrefix

▸ setAddressPrefix(prefix: number): void

Inherited from Base.setAddressPrefix

Defined in Base.ts:78

Parameters:

Name Type
prefix number

Returns: void

setDevMode

▸ setDevMode(isDevelopment: boolean): void

Inherited from Base.setDevMode

Defined in Base.ts:82

Parameters:

Name Type
isDevelopment boolean

Returns: void

+ + + diff --git a/docs/ui-keyring/classes/_keyring_.keyring.md b/docs/ui-keyring/classes/_keyring_.keyring.md new file mode 100644 index 00000000..f6ea9211 --- /dev/null +++ b/docs/ui-keyring/classes/_keyring_.keyring.md @@ -0,0 +1,526 @@ + + +# Hierarchy + + [Base](_base_.base.md) + +**↳ Keyring** + +# Implements + +* [KeyringStruct](../interfaces/_types_.keyringstruct.md) + +# Constructors + + + +## 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 + + + +## 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` + +___ + + +## 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` + +___ + + +## 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 + + + +## 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` + +___ + + +## 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` + +___ + + +## 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` + +___ + + +## 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` + +___ + + +## 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` + +___ + + +## 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` + +___ + + +## 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` + +___ + + +## 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` + +___ + + +## 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` + +___ + + +## 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` + +___ + + +## 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) + +___ + + +## 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)> + +___ + + +## 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" | "address" | + +**Returns:** [KeyringAddress](../modules/_types_.md#keyringaddress) + +___ + + +## 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)> + +___ + + +## 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` + +___ + + +## 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`> + +___ + + +## 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` + +___ + + +## 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` + +___ + + +## 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` + +___ + + +## 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` + +___ + + +## 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` + +___ + + +## 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` + +___ + + +## 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` + +___ + + +## 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) + +___ + + +## 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` + +___ + + +## 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` + +___ + diff --git a/docs/ui-keyring/classes/_options_keypair_.keypair.html b/docs/ui-keyring/classes/_options_keypair_.keypair.html new file mode 100644 index 00000000..47c8b48f --- /dev/null +++ b/docs/ui-keyring/classes/_options_keypair_.keypair.html @@ -0,0 +1,21 @@ + + + + + + Type parameters | polkadot-js/ui + + + + + + + +
polkadot-js/ui

Type parameters

S

SS

Hierarchy

PureComponent<Props>

↳ KeyPair

Methods

<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

see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns: void

<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

see: 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

<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

see: 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

<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

<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

<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

<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

see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns: void

<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

see: 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

<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

<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

see: 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

<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

render

▸ render(): Element

Defined in options/KeyPair.tsx:53

Returns: Element

<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

+ + + diff --git a/docs/ui-keyring/classes/_options_keypair_.keypair.md b/docs/ui-keyring/classes/_options_keypair_.keypair.md new file mode 100644 index 00000000..95132976 --- /dev/null +++ b/docs/ui-keyring/classes/_options_keypair_.keypair.md @@ -0,0 +1,335 @@ + + +# Type parameters +#### S +#### SS +# Hierarchy + + `PureComponent`<`Props`> + +**↳ KeyPair** + +# Methods + + + +## `` 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` + +___ + + +## `` 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` + +___ + + +## `` 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` + +___ + + +## `` 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` + +___ + + +## `` 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` + +___ + + +## `` 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` + +___ + + +## `` 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` + +___ + + +## `` 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` + +___ + + +## `` 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` + +___ + + +## `` 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` + +___ + + +## `` 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` + +___ + + +## 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` + +___ + + +## `` 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` + +___ + diff --git a/docs/ui-keyring/index.html b/docs/ui-keyring/index.html new file mode 100644 index 00000000..d53bced3 --- /dev/null +++ b/docs/ui-keyring/index.html @@ -0,0 +1,123 @@ + + + + + + polkadot-js/ui + + + + + + + +
polkadot-js/ui

@polkadot/ui-keyring

A wrapper extending the base @polkadot/keyring interface for usage in the browser: Key management of user accounts including generation and retrieval of keyring pairs from a variety of input combinations.

Usage Examples

All module methods are exposed through a single default export.

Regular

import keyring from @polkadot/ui-keyring
+
+render () {
+  // encode publicKey to ss58 address
+  const address = keyring.encodeAddress(publicKey);
+
+  // get keyring pair from ss58 address
+  const pair = keyring.getPair(address);
+
+  // ask questions about that particular keyring pair
+  const isLocked = pair.isLocked();
+  const meta = pair.getMeta();
+
+  // save account from pair
+  keyring.saveAccount(pair, password);
+
+  // save address without unlocking it
+  keyring.saveAddress(address, { ...meta });
+}
+
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

Observables

Option 1: Declarative subscribe/unsubscribe w/ react-with-observable (recommended 'React' way)

import accountObservable from '@polkadot/ui-keyring/observable/accounts';
+import { SingleAddress, SubjectInfo } from '@polkadot/ui-keyring/observable/types';
+import React from 'react';
+import { Subscribe } from 'react-with-observable';
+import { map } from 'rxjs/operators';
+
+class MyReactComponent extends React.PureComponent {
+  render () {
+    <Subscribe>
+      {accountObservable.subject.pipe(
+        map((allAccounts: SubjectInfo) =>
+          !allAccounts
+            ? this.renderEmpty()
+            : Object.values(allAccounts).map((account: SingleAddress) =>
+                // Your component goes here
+                console.log(account.json.address)
+            )
+        ))}
+    </Subscribe>
+  }
+
+  renderEmpty () {
+    return (
+      <div> no accounts to display ... </div>
+    );
+  }
+}
+
+
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

Option 2: Imperative subscribe/unsubscribe

import accountObservable from '@polkadot/ui-keyring/observable/accounts';
+import { SingleAddress, SubjectInfo } from '@polkadot/ui-keyring/observable/types';
+import React from 'react';
+import { Subscription } from 'rxjs';
+
+type State = {
+  allAccounts?: SubjectInfo,
+  subscriptions?: [Subscription]
+}
+
+class MyReactComponent extends React.PureComponent<State> {
+  componentDidMount () {
+    const accountSubscription = accountObservable.subject.subscribe((observedAccounts) => {
+      this.setState({
+        accounts: observedAccounts
+      });
+    })
+
+    this.setState({
+      subscriptions: [accountSubscription]
+    });
+  }
+
+  componentWillUnmount () {
+    const { subscriptions } = this.state;
+
+    for (s in subscriptions) {
+      s.subject.unsubscribe();
+    }
+  }
+
+  render () {
+    const { accounts } = this.state;
+
+    return (
+      <h1>All Accounts</h1>
+      {
+        Object.keys(accounts).map((address: SingleAddress) => {
+          return <p> {address} </p>;
+        })
+      }
+    )
+  }
+}
+
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

FAQ

  • Difference between Keyring Accounts and Addresses? +
    • From the perspective of the keyring, it saves a particular user's unlocked identities as an account, a la keyring.saveAccount(pair, password). So with these accounts you are able to send and sign transactions.
    • To save addresses without unlocking them (i.e. because a user might want to have easy access to addresses they frequently transact with), use keyring.saveAddress(address, meta)
  • What are 'external' accounts, i.e. when to set the isExternal meta key to true? +
    • An external account is one where the keys are not managed by keyring, e.g. in Parity Signer or Ledger Nano.
  • SS58 Encode / Decode? +
    • SS58 is a simple address format designed for Substrate based chains. You can read about its specification in more detail in the Parity Wiki.

If you have any unanswered/undocumented questions, please raise an issue here.

Users

Keyring is core to many polkadot/substrate apps.

+ ← + + @polkadot/ui-settings + + → +

+ + + diff --git a/docs/ui-keyring/interfaces/_options_types_.keyringoptioninstance.html b/docs/ui-keyring/interfaces/_options_types_.keyringoptioninstance.html new file mode 100644 index 00000000..99dd22ff --- /dev/null +++ b/docs/ui-keyring/interfaces/_options_types_.keyringoptioninstance.html @@ -0,0 +1,21 @@ + + + + + + Hierarchy | polkadot-js/ui + + + + + + + +
polkadot-js/ui

Hierarchy

KeyringOptionInstance

Properties

createOptionHeader

● createOptionHeader: function

Defined in options/types.ts:30

Type declaration

▸(name: string): KeyringSectionOption

Parameters:

Name Type
name string

Returns: KeyringSectionOption

init

● init: function

Defined in options/types.ts:31

Type declaration

▸(keyring: KeyringStruct): void

Parameters:

Name Type
keyring KeyringStruct

Returns: void

+ + + diff --git a/docs/ui-keyring/interfaces/_options_types_.keyringoptioninstance.md b/docs/ui-keyring/interfaces/_options_types_.keyringoptioninstance.md new file mode 100644 index 00000000..6522ab3f --- /dev/null +++ b/docs/ui-keyring/interfaces/_options_types_.keyringoptioninstance.md @@ -0,0 +1,49 @@ + + +# Hierarchy + +**KeyringOptionInstance** + +# Properties + + + +## createOptionHeader + +**● createOptionHeader**: *`function`* + +*Defined in [options/types.ts:30](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/options/types.ts#L30)* + +#### Type declaration +▸(name: *`string`*): [KeyringSectionOption](../modules/_options_types_.md#keyringsectionoption) + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| name | `string` | + +**Returns:** [KeyringSectionOption](../modules/_options_types_.md#keyringsectionoption) + +___ + + +## init + +**● init**: *`function`* + +*Defined in [options/types.ts:31](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/options/types.ts#L31)* + +#### Type declaration +▸(keyring: *[KeyringStruct](_types_.keyringstruct.md)*): `void` + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| keyring | [KeyringStruct](_types_.keyringstruct.md) | + +**Returns:** `void` + +___ + diff --git a/docs/ui-keyring/interfaces/_types_.keyringstruct.html b/docs/ui-keyring/interfaces/_types_.keyringstruct.html new file mode 100644 index 00000000..31536e0d --- /dev/null +++ b/docs/ui-keyring/interfaces/_types_.keyringstruct.html @@ -0,0 +1,21 @@ + + + + + + Hierarchy | polkadot-js/ui + + + + + + + +
polkadot-js/ui

Hierarchy

KeyringStruct

Implemented by

Properties

accounts

● accounts: AddressSubject

Defined in types.ts:35

addAccountPair

● addAccountPair: function

Defined in types.ts:39

Type declaration

▸(pair: KeyringPair, password: string): KeyringPair

Parameters:

Name Type
pair KeyringPair
password string

Returns: KeyringPair

addresses

● addresses: AddressSubject

Defined in types.ts:36

backupAccount

● backupAccount: function

Defined in types.ts:40

Type declaration

▸(pair: KeyringPair, password: string): KeyringPair$Json

Parameters:

Name Type
pair KeyringPair
password string

Returns: KeyringPair$Json

createAccount

● createAccount: function

Defined in types.ts:41

Type declaration

▸(seed: Uint8Array, password?: undefined | string, meta?: KeyringPair$Meta): KeyringPair

Parameters:

Name Type
seed Uint8Array
Optional password undefined | string
Optional meta KeyringPair$Meta

Returns: KeyringPair

createAccountExternal

● createAccountExternal: function

Defined in types.ts:42

Type declaration

▸(publicKey: Uint8Array, meta?: KeyringPair$Meta): KeyringPair

Parameters:

Name Type
publicKey Uint8Array
Optional meta KeyringPair$Meta

Returns: KeyringPair

createAccountMnemonic

● createAccountMnemonic: function

Defined in types.ts:43

Type declaration

▸(seed: string, password?: undefined | string, meta?: KeyringPair$Meta): KeyringPair

Parameters:

Name Type
seed string
Optional password undefined | string
Optional meta KeyringPair$Meta

Returns: KeyringPair

decodeAddress

● decodeAddress: function

Defined in types.ts:44

Type declaration

▸(key: string | Uint8Array): Uint8Array

Parameters:

Name Type
key string | Uint8Array

Returns: Uint8Array

encodeAddress

● encodeAddress: function

Defined in types.ts:45

Type declaration

▸(key: string | Uint8Array): string

Parameters:

Name Type
key string | Uint8Array

Returns: string

encryptAccount

● encryptAccount: function

Defined in types.ts:46

Type declaration

▸(pair: KeyringPair, password: string): void

Parameters:

Name Type
pair KeyringPair
password string

Returns: void

forgetAccount

● forgetAccount: function

Defined in types.ts:47

Type declaration

▸(address: string): void

Parameters:

Name Type
address string

Returns: void

forgetAddress

● forgetAddress: function

Defined in types.ts:48

Type declaration

▸(address: string): void

Parameters:

Name Type
address string

Returns: void

getAccount

● getAccount: function

Defined in types.ts:49

Type declaration

▸(address: string | Uint8Array): KeyringAddress

Parameters:

Name Type
address string | Uint8Array

Returns: KeyringAddress

getAccounts

● getAccounts: function

Defined in types.ts:50

Type declaration

▸(): Array<KeyringAddress>

Returns: Array<KeyringAddress>

getAddress

● getAddress: function

Defined in types.ts:51

Type declaration

▸(address: string | Uint8Array): KeyringAddress

Parameters:

Name Type
address string | Uint8Array

Returns: KeyringAddress

getAddresses

● getAddresses: function

Defined in types.ts:52

Type declaration

▸(): Array<KeyringAddress>

Returns: Array<KeyringAddress>

getPair

● getPair: function

Defined in types.ts:53

Type declaration

▸(address: string | Uint8Array): KeyringPair

Parameters:

Name Type
address string | Uint8Array

Returns: KeyringPair

getPairs

● getPairs: function

Defined in types.ts:54

Type declaration

▸(): Array<KeyringPair>

Returns: Array<KeyringPair>

isAvailable

● isAvailable: function

Defined in types.ts:55

Type declaration

▸(address: string | Uint8Array): boolean

Parameters:

Name Type
address string | Uint8Array

Returns: boolean

isPassValid

● isPassValid: function

Defined in types.ts:56

Type declaration

▸(password: string): boolean

Parameters:

Name Type
password string

Returns: boolean

keyring

● keyring: BaseKeyringInstance | undefined

Defined in types.ts:37

loadAll

● loadAll: function

Defined in types.ts:57

Type declaration

▸(options: KeyringOptions): void

Parameters:

Name Type
options KeyringOptions

Returns: void

restoreAccount

● restoreAccount: function

Defined in types.ts:58

Type declaration

▸(json: KeyringPair$Json, password: string): KeyringPair

Parameters:

Name Type
json KeyringPair$Json
password string

Returns: KeyringPair

saveAccount

● saveAccount: function

Defined in types.ts:59

Type declaration

▸(pair: KeyringPair, password?: undefined | string): void

Parameters:

Name Type
pair KeyringPair
Optional password undefined | string

Returns: void

saveAccountMeta

● saveAccountMeta: function

Defined in types.ts:60

Type declaration

▸(pair: KeyringPair, meta: KeyringPair$Meta): void

Parameters:

Name Type
pair KeyringPair
meta KeyringPair$Meta

Returns: void

saveAddress

● saveAddress: function

Defined in types.ts:61

Type declaration

▸(address: string, meta: KeyringPair$Meta): void

Parameters:

Name Type
address string
meta KeyringPair$Meta

Returns: void

saveRecent

● saveRecent: function

Defined in types.ts:62

Type declaration

▸(address: string): SingleAddress

Parameters:

Name Type
address string

Returns: SingleAddress

setDevMode

● setDevMode: function

Defined in types.ts:63

Type declaration

▸(isDevelopment: boolean): void

Parameters:

Name Type
isDevelopment boolean

Returns: void

+ + + diff --git a/docs/ui-keyring/interfaces/_types_.keyringstruct.md b/docs/ui-keyring/interfaces/_types_.keyringstruct.md new file mode 100644 index 00000000..358938f5 --- /dev/null +++ b/docs/ui-keyring/interfaces/_types_.keyringstruct.md @@ -0,0 +1,534 @@ + + +# Hierarchy + +**KeyringStruct** + +# Implemented by + +* [Keyring](../classes/_keyring_.keyring.md) + +# Properties + + + +## accounts + +**● accounts**: *[AddressSubject](../modules/_observable_types_.md#addresssubject)* + +*Defined in [types.ts:35](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L35)* + +___ + + +## addAccountPair + +**● addAccountPair**: *`function`* + +*Defined in [types.ts:39](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L39)* + +#### Type declaration +▸(pair: *`KeyringPair`*, password: *`string`*): `KeyringPair` + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| pair | `KeyringPair` | +| password | `string` | + +**Returns:** `KeyringPair` + +___ + + +## addresses + +**● addresses**: *[AddressSubject](../modules/_observable_types_.md#addresssubject)* + +*Defined in [types.ts:36](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L36)* + +___ + + +## backupAccount + +**● backupAccount**: *`function`* + +*Defined in [types.ts:40](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L40)* + +#### Type declaration +▸(pair: *`KeyringPair`*, password: *`string`*): `KeyringPair$Json` + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| pair | `KeyringPair` | +| password | `string` | + +**Returns:** `KeyringPair$Json` + +___ + + +## createAccount + +**● createAccount**: *`function`* + +*Defined in [types.ts:41](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L41)* + +#### Type declaration +▸(seed: *`Uint8Array`*, password?: *`undefined` \| `string`*, meta?: *`KeyringPair$Meta`*): `KeyringPair` + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| seed | `Uint8Array` | +| `Optional` password | `undefined` \| `string` | +| `Optional` meta | `KeyringPair$Meta` | + +**Returns:** `KeyringPair` + +___ + + +## createAccountExternal + +**● createAccountExternal**: *`function`* + +*Defined in [types.ts:42](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L42)* + +#### Type declaration +▸(publicKey: *`Uint8Array`*, meta?: *`KeyringPair$Meta`*): `KeyringPair` + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| publicKey | `Uint8Array` | +| `Optional` meta | `KeyringPair$Meta` | + +**Returns:** `KeyringPair` + +___ + + +## createAccountMnemonic + +**● createAccountMnemonic**: *`function`* + +*Defined in [types.ts:43](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L43)* + +#### Type declaration +▸(seed: *`string`*, password?: *`undefined` \| `string`*, meta?: *`KeyringPair$Meta`*): `KeyringPair` + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| seed | `string` | +| `Optional` password | `undefined` \| `string` | +| `Optional` meta | `KeyringPair$Meta` | + +**Returns:** `KeyringPair` + +___ + + +## decodeAddress + +**● decodeAddress**: *`function`* + +*Defined in [types.ts:44](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L44)* + +#### Type declaration +▸(key: *`string` \| `Uint8Array`*): `Uint8Array` + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| key | `string` \| `Uint8Array` | + +**Returns:** `Uint8Array` + +___ + + +## encodeAddress + +**● encodeAddress**: *`function`* + +*Defined in [types.ts:45](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L45)* + +#### Type declaration +▸(key: *`string` \| `Uint8Array`*): `string` + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| key | `string` \| `Uint8Array` | + +**Returns:** `string` + +___ + + +## encryptAccount + +**● encryptAccount**: *`function`* + +*Defined in [types.ts:46](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L46)* + +#### Type declaration +▸(pair: *`KeyringPair`*, password: *`string`*): `void` + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| pair | `KeyringPair` | +| password | `string` | + +**Returns:** `void` + +___ + + +## forgetAccount + +**● forgetAccount**: *`function`* + +*Defined in [types.ts:47](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L47)* + +#### Type declaration +▸(address: *`string`*): `void` + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| address | `string` | + +**Returns:** `void` + +___ + + +## forgetAddress + +**● forgetAddress**: *`function`* + +*Defined in [types.ts:48](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L48)* + +#### Type declaration +▸(address: *`string`*): `void` + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| address | `string` | + +**Returns:** `void` + +___ + + +## getAccount + +**● getAccount**: *`function`* + +*Defined in [types.ts:49](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L49)* + +#### Type declaration +▸(address: *`string` \| `Uint8Array`*): [KeyringAddress](../modules/_types_.md#keyringaddress) + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| address | `string` \| `Uint8Array` | + +**Returns:** [KeyringAddress](../modules/_types_.md#keyringaddress) + +___ + + +## getAccounts + +**● getAccounts**: *`function`* + +*Defined in [types.ts:50](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L50)* + +#### Type declaration +▸(): `Array`<[KeyringAddress](../modules/_types_.md#keyringaddress)> + +**Returns:** `Array`<[KeyringAddress](../modules/_types_.md#keyringaddress)> + +___ + + +## getAddress + +**● getAddress**: *`function`* + +*Defined in [types.ts:51](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L51)* + +#### Type declaration +▸(address: *`string` \| `Uint8Array`*): [KeyringAddress](../modules/_types_.md#keyringaddress) + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| address | `string` \| `Uint8Array` | + +**Returns:** [KeyringAddress](../modules/_types_.md#keyringaddress) + +___ + + +## getAddresses + +**● getAddresses**: *`function`* + +*Defined in [types.ts:52](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L52)* + +#### Type declaration +▸(): `Array`<[KeyringAddress](../modules/_types_.md#keyringaddress)> + +**Returns:** `Array`<[KeyringAddress](../modules/_types_.md#keyringaddress)> + +___ + + +## getPair + +**● getPair**: *`function`* + +*Defined in [types.ts:53](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L53)* + +#### Type declaration +▸(address: *`string` \| `Uint8Array`*): `KeyringPair` + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| address | `string` \| `Uint8Array` | + +**Returns:** `KeyringPair` + +___ + + +## getPairs + +**● getPairs**: *`function`* + +*Defined in [types.ts:54](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L54)* + +#### Type declaration +▸(): `Array`<`KeyringPair`> + +**Returns:** `Array`<`KeyringPair`> + +___ + + +## isAvailable + +**● isAvailable**: *`function`* + +*Defined in [types.ts:55](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L55)* + +#### Type declaration +▸(address: *`string` \| `Uint8Array`*): `boolean` + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| address | `string` \| `Uint8Array` | + +**Returns:** `boolean` + +___ + + +## isPassValid + +**● isPassValid**: *`function`* + +*Defined in [types.ts:56](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L56)* + +#### Type declaration +▸(password: *`string`*): `boolean` + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| password | `string` | + +**Returns:** `boolean` + +___ + + +## keyring + +**● keyring**: *`BaseKeyringInstance` \| `undefined`* + +*Defined in [types.ts:37](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L37)* + +___ + + +## loadAll + +**● loadAll**: *`function`* + +*Defined in [types.ts:57](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L57)* + +#### Type declaration +▸(options: *[KeyringOptions](../modules/_types_.md#keyringoptions)*): `void` + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| options | [KeyringOptions](../modules/_types_.md#keyringoptions) | + +**Returns:** `void` + +___ + + +## restoreAccount + +**● restoreAccount**: *`function`* + +*Defined in [types.ts:58](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L58)* + +#### Type declaration +▸(json: *`KeyringPair$Json`*, password: *`string`*): `KeyringPair` + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| json | `KeyringPair$Json` | +| password | `string` | + +**Returns:** `KeyringPair` + +___ + + +## saveAccount + +**● saveAccount**: *`function`* + +*Defined in [types.ts:59](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L59)* + +#### Type declaration +▸(pair: *`KeyringPair`*, password?: *`undefined` \| `string`*): `void` + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| pair | `KeyringPair` | +| `Optional` password | `undefined` \| `string` | + +**Returns:** `void` + +___ + + +## saveAccountMeta + +**● saveAccountMeta**: *`function`* + +*Defined in [types.ts:60](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L60)* + +#### Type declaration +▸(pair: *`KeyringPair`*, meta: *`KeyringPair$Meta`*): `void` + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| pair | `KeyringPair` | +| meta | `KeyringPair$Meta` | + +**Returns:** `void` + +___ + + +## saveAddress + +**● saveAddress**: *`function`* + +*Defined in [types.ts:61](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L61)* + +#### Type declaration +▸(address: *`string`*, meta: *`KeyringPair$Meta`*): `void` + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| address | `string` | +| meta | `KeyringPair$Meta` | + +**Returns:** `void` + +___ + + +## saveRecent + +**● saveRecent**: *`function`* + +*Defined in [types.ts:62](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L62)* + +#### Type declaration +▸(address: *`string`*): [SingleAddress](../modules/_observable_types_.md#singleaddress) + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| address | `string` | + +**Returns:** [SingleAddress](../modules/_observable_types_.md#singleaddress) + +___ + + +## setDevMode + +**● setDevMode**: *`function`* + +*Defined in [types.ts:63](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L63)* + +#### Type declaration +▸(isDevelopment: *`boolean`*): `void` + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| isDevelopment | `boolean` | + +**Returns:** `void` + +___ + diff --git a/docs/ui-keyring/modules/_base_.html b/docs/ui-keyring/modules/_base_.html new file mode 100644 index 00000000..fe7c002b --- /dev/null +++ b/docs/ui-keyring/modules/_base_.html @@ -0,0 +1,21 @@ + + + + + + Index | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-keyring/modules/_base_.md b/docs/ui-keyring/modules/_base_.md new file mode 100644 index 00000000..9f5be911 --- /dev/null +++ b/docs/ui-keyring/modules/_base_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Base](../classes/_base_.base.md) + +--- + diff --git a/docs/ui-keyring/modules/_defaults_.html b/docs/ui-keyring/modules/_defaults_.html new file mode 100644 index 00000000..2aaf267c --- /dev/null +++ b/docs/ui-keyring/modules/_defaults_.html @@ -0,0 +1,21 @@ + + + + + + polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-keyring/modules/_defaults_.md b/docs/ui-keyring/modules/_defaults_.md new file mode 100644 index 00000000..139597f9 --- /dev/null +++ b/docs/ui-keyring/modules/_defaults_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/ui-keyring/modules/_keyring_.html b/docs/ui-keyring/modules/_keyring_.html new file mode 100644 index 00000000..68e7ec2d --- /dev/null +++ b/docs/ui-keyring/modules/_keyring_.html @@ -0,0 +1,21 @@ + + + + + + Index | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-keyring/modules/_keyring_.md b/docs/ui-keyring/modules/_keyring_.md new file mode 100644 index 00000000..04ce80f9 --- /dev/null +++ b/docs/ui-keyring/modules/_keyring_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Keyring](../classes/_keyring_.keyring.md) + +--- + diff --git a/docs/ui-keyring/modules/_observable_accounts_.html b/docs/ui-keyring/modules/_observable_accounts_.html new file mode 100644 index 00000000..00f53249 --- /dev/null +++ b/docs/ui-keyring/modules/_observable_accounts_.html @@ -0,0 +1,21 @@ + + + + + + polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-keyring/modules/_observable_accounts_.md b/docs/ui-keyring/modules/_observable_accounts_.md new file mode 100644 index 00000000..139597f9 --- /dev/null +++ b/docs/ui-keyring/modules/_observable_accounts_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/ui-keyring/modules/_observable_addresses_.html b/docs/ui-keyring/modules/_observable_addresses_.html new file mode 100644 index 00000000..75eb2956 --- /dev/null +++ b/docs/ui-keyring/modules/_observable_addresses_.html @@ -0,0 +1,21 @@ + + + + + + polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-keyring/modules/_observable_addresses_.md b/docs/ui-keyring/modules/_observable_addresses_.md new file mode 100644 index 00000000..139597f9 --- /dev/null +++ b/docs/ui-keyring/modules/_observable_addresses_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/ui-keyring/modules/_observable_development_.html b/docs/ui-keyring/modules/_observable_development_.html new file mode 100644 index 00000000..f79396ba --- /dev/null +++ b/docs/ui-keyring/modules/_observable_development_.html @@ -0,0 +1,21 @@ + + + + + + polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-keyring/modules/_observable_development_.md b/docs/ui-keyring/modules/_observable_development_.md new file mode 100644 index 00000000..139597f9 --- /dev/null +++ b/docs/ui-keyring/modules/_observable_development_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/ui-keyring/modules/_observable_genericsubject_.html b/docs/ui-keyring/modules/_observable_genericsubject_.html new file mode 100644 index 00000000..6506d21a --- /dev/null +++ b/docs/ui-keyring/modules/_observable_genericsubject_.html @@ -0,0 +1,21 @@ + + + + + + Functions | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-keyring/modules/_observable_genericsubject_.md b/docs/ui-keyring/modules/_observable_genericsubject_.md new file mode 100644 index 00000000..6b7b9bf2 --- /dev/null +++ b/docs/ui-keyring/modules/_observable_genericsubject_.md @@ -0,0 +1,23 @@ + + +# Functions + + + +## genericSubject + +▸ **genericSubject**(keyCreator: *`function`*, withTest?: *`boolean`*): [AddressSubject](_observable_types_.md#addresssubject) + +*Defined in [observable/genericSubject.ts:30](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/observable/genericSubject.ts#L30)* + +**Parameters:** + +| Name | Type | Default value | +| ------ | ------ | ------ | +| keyCreator | `function` | - | +| `Default value` withTest | `boolean` | false | + +**Returns:** [AddressSubject](_observable_types_.md#addresssubject) + +___ + diff --git a/docs/ui-keyring/modules/_observable_types_.html b/docs/ui-keyring/modules/_observable_types_.html new file mode 100644 index 00000000..6b0f839a --- /dev/null +++ b/docs/ui-keyring/modules/_observable_types_.html @@ -0,0 +1,21 @@ + + + + + + Type aliases | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-keyring/modules/_observable_types_.md b/docs/ui-keyring/modules/_observable_types_.md new file mode 100644 index 00000000..f5806b17 --- /dev/null +++ b/docs/ui-keyring/modules/_observable_types_.md @@ -0,0 +1,40 @@ + + +# Type aliases + + + +## AddressSubject + +**Ƭ AddressSubject**: *`object`* + +*Defined in [observable/types.ts:18](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/observable/types.ts#L18)* + +#### Type declaration + +___ + + +## SingleAddress + +**Ƭ SingleAddress**: *`object`* + +*Defined in [observable/types.ts:9](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/observable/types.ts#L9)* + +#### Type declaration + +___ + + +## SubjectInfo + +**Ƭ SubjectInfo**: *`object`* + +*Defined in [observable/types.ts:14](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/observable/types.ts#L14)* + +#### Type declaration + +[index: `string`]: [SingleAddress](_observable_types_.md#singleaddress) + +___ + diff --git a/docs/ui-keyring/modules/_options_item_.html b/docs/ui-keyring/modules/_options_item_.html new file mode 100644 index 00000000..c985063b --- /dev/null +++ b/docs/ui-keyring/modules/_options_item_.html @@ -0,0 +1,21 @@ + + + + + + Functions | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-keyring/modules/_options_item_.md b/docs/ui-keyring/modules/_options_item_.md new file mode 100644 index 00000000..a45f8ed1 --- /dev/null +++ b/docs/ui-keyring/modules/_options_item_.md @@ -0,0 +1,23 @@ + + +# Functions + + + +## createItem + +▸ **createItem**(address: *`string`*, _name?: *`undefined` \| `string`*): [KeyringSectionOption](_options_types_.md#keyringsectionoption) + +*Defined in [options/item.tsx:12](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/options/item.tsx#L12)* + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| address | `string` | +| `Optional` _name | `undefined` \| `string` | + +**Returns:** [KeyringSectionOption](_options_types_.md#keyringsectionoption) + +___ + diff --git a/docs/ui-keyring/modules/_options_keypair_.html b/docs/ui-keyring/modules/_options_keypair_.html new file mode 100644 index 00000000..c6831627 --- /dev/null +++ b/docs/ui-keyring/modules/_options_keypair_.html @@ -0,0 +1,21 @@ + + + + + + Index | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-keyring/modules/_options_keypair_.md b/docs/ui-keyring/modules/_options_keypair_.md new file mode 100644 index 00000000..0fd706f5 --- /dev/null +++ b/docs/ui-keyring/modules/_options_keypair_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [KeyPair](../classes/_options_keypair_.keypair.md) + +--- + diff --git a/docs/ui-keyring/modules/_options_types_.html b/docs/ui-keyring/modules/_options_types_.html new file mode 100644 index 00000000..530e7092 --- /dev/null +++ b/docs/ui-keyring/modules/_options_types_.html @@ -0,0 +1,21 @@ + + + + + + Index | polkadot-js/ui + + + + + + + +
polkadot-js/ui

Index

Interfaces

Type aliases

Type aliases

KeyringOption$Type

Ƭ KeyringOption$Type: keyof KeyringOptions

Defined in options/types.ts:27

KeyringOptions

Ƭ KeyringOptions: object

Defined in options/types.ts:19

Type declaration

KeyringSectionOption

Ƭ KeyringSectionOption: object

Defined in options/types.ts:7

Type declaration

KeyringSectionOptions

Ƭ KeyringSectionOptions: Array<KeyringSectionOption>

Defined in options/types.ts:17

+ + + diff --git a/docs/ui-keyring/modules/_options_types_.md b/docs/ui-keyring/modules/_options_types_.md new file mode 100644 index 00000000..d3e267bb --- /dev/null +++ b/docs/ui-keyring/modules/_options_types_.md @@ -0,0 +1,60 @@ + + +# Index + +### Interfaces + +* [KeyringOptionInstance](../interfaces/_options_types_.keyringoptioninstance.md) + +### Type aliases + +* [KeyringOption$Type](_options_types_.md#keyringoption_type) +* [KeyringOptions](_options_types_.md#keyringoptions) +* [KeyringSectionOption](_options_types_.md#keyringsectionoption) +* [KeyringSectionOptions](_options_types_.md#keyringsectionoptions) + +--- + +# Type aliases + + + +## KeyringOption$Type + +**Ƭ KeyringOption$Type**: *`keyof KeyringOptions`* + +*Defined in [options/types.ts:27](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/options/types.ts#L27)* + +___ + + +## KeyringOptions + +**Ƭ KeyringOptions**: *`object`* + +*Defined in [options/types.ts:19](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/options/types.ts#L19)* + +#### Type declaration + +___ + + +## KeyringSectionOption + +**Ƭ KeyringSectionOption**: *`object`* + +*Defined in [options/types.ts:7](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/options/types.ts#L7)* + +#### Type declaration + +___ + + +## KeyringSectionOptions + +**Ƭ KeyringSectionOptions**: *`Array`<[KeyringSectionOption](_options_types_.md#keyringsectionoption)>* + +*Defined in [options/types.ts:17](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/options/types.ts#L17)* + +___ + diff --git a/docs/ui-keyring/modules/_types_.html b/docs/ui-keyring/modules/_types_.html new file mode 100644 index 00000000..8ee784e6 --- /dev/null +++ b/docs/ui-keyring/modules/_types_.html @@ -0,0 +1,21 @@ + + + + + + Index | polkadot-js/ui + + + + + + + +
polkadot-js/ui

Index

Interfaces

Type aliases

Type aliases

KeyringAddress

Ƭ KeyringAddress: object

Defined in types.ts:27

Type declaration

KeyringJson

Ƭ KeyringJson: object

Defined in types.ts:22

Type declaration

KeyringJson$Meta

Ƭ KeyringJson$Meta: object

Defined in types.ts:12

Type declaration

KeyringOptions

Ƭ KeyringOptions: KeyringOptionsBase & object

Defined in types.ts:8

+ + + diff --git a/docs/ui-keyring/modules/_types_.md b/docs/ui-keyring/modules/_types_.md new file mode 100644 index 00000000..9a109a08 --- /dev/null +++ b/docs/ui-keyring/modules/_types_.md @@ -0,0 +1,64 @@ + + +# Index + +### Interfaces + +* [KeyringStruct](../interfaces/_types_.keyringstruct.md) + +### Type aliases + +* [KeyringAddress](_types_.md#keyringaddress) +* [KeyringJson](_types_.md#keyringjson) +* [KeyringJson$Meta](_types_.md#keyringjson_meta) +* [KeyringOptions](_types_.md#keyringoptions) + +--- + +# Type aliases + + + +## KeyringAddress + +**Ƭ KeyringAddress**: *`object`* + +*Defined in [types.ts:27](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L27)* + +#### Type declaration + +___ + + +## KeyringJson + +**Ƭ KeyringJson**: *`object`* + +*Defined in [types.ts:22](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L22)* + +#### Type declaration + +___ + + +## KeyringJson$Meta + +**Ƭ KeyringJson$Meta**: *`object`* + +*Defined in [types.ts:12](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L12)* + +#### Type declaration + +[index: `string`]: `any` + +___ + + +## KeyringOptions + +**Ƭ KeyringOptions**: *`KeyringOptionsBase` & `object`* + +*Defined in [types.ts:8](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-keyring/src/types.ts#L8)* + +___ + diff --git a/docs/ui-settings/README.md b/docs/ui-settings/README.md new file mode 100644 index 00000000..a621a3d0 --- /dev/null +++ b/docs/ui-settings/README.md @@ -0,0 +1,45 @@ + +@polkadot/ui-settings +===================== + +Manages app settings including endpoints, themes and prefixes + +Usage Examples +-------------- + +User preferences are set as a settings object in the browser's local storage. + +```js +import settings from '@polkadot/ui-settings'; + +render () { + // get api endpoint for the selected chain + const WS_URL = settings.apiUrl(); + + // get the selected il8n language + const language = settings.il8nLang(); + + // get all available il8n languages + const languages = settings.availableLanguages(); + + // update settings + const updatedSettings = { + ...settings, + i18nLang: 'Arabic' + } + settings.set(updatedSettings); + + // NOTE: API currently does not handle hot reconnecting properly, + so you need to manually reload the page after updating settings. + window.location.reload(); +} +``` + +Used by +------- + +Apps that currently use the settings package + +* [polkadot-js/apps](https://www.github.com/polkadot-js/apps) +* [paritytech/substrate-light-ui](https://github.com/paritytech/substrate-light-ui) + diff --git a/docs/ui-settings/SUMMARY.html b/docs/ui-settings/SUMMARY.html new file mode 100644 index 00000000..c447e0ea --- /dev/null +++ b/docs/ui-settings/SUMMARY.html @@ -0,0 +1,21 @@ + + + + + + polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-settings/SUMMARY.md b/docs/ui-settings/SUMMARY.md new file mode 100644 index 00000000..b7be3fbf --- /dev/null +++ b/docs/ui-settings/SUMMARY.md @@ -0,0 +1,5 @@ +* ["Settings"](modules/_settings_.md) + * [Settings](classes/_settings_.settings.md) +* ["defaults"](modules/_defaults_.md) +* ["types"](modules/_types_.md) + * [SettingsStruct](interfaces/_types_.settingsstruct.md) diff --git a/docs/ui-settings/classes/_settings_.settings.html b/docs/ui-settings/classes/_settings_.settings.html new file mode 100644 index 00000000..d5bacd0b --- /dev/null +++ b/docs/ui-settings/classes/_settings_.settings.html @@ -0,0 +1,21 @@ + + + + + + Hierarchy | polkadot-js/ui + + + + + + + +
polkadot-js/ui

Hierarchy

Settings

Implements

Constructors

constructor

⊕ new Settings(): Settings

Defined in Settings.ts:14

Returns: Settings

Accessors

apiUrl

get apiUrl(): string

Defined in Settings.ts:25

Returns: string

availableLanguages

get availableLanguages(): Options

Defined in Settings.ts:45

Returns: Options

availableNodes

get availableNodes(): Options

Defined in Settings.ts:41

Returns: Options

availableUIModes

get availableUIModes(): Options

Defined in Settings.ts:49

Returns: Options

availableUIThemes

get availableUIThemes(): Options

Defined in Settings.ts:53

Returns: Options

i18nLang

get i18nLang(): string

Defined in Settings.ts:29

Returns: string

uiMode

get uiMode(): string

Defined in Settings.ts:33

Returns: string

uiTheme

get uiTheme(): string

Defined in Settings.ts:37

Returns: string

Methods

get

▸ get(): SettingsStruct

Defined in Settings.ts:57

Returns: SettingsStruct

set

▸ set(settings: Partial<SettingsStruct>): void

Defined in Settings.ts:66

Parameters:

Name Type
settings Partial<SettingsStruct>

Returns: void

+ + + diff --git a/docs/ui-settings/classes/_settings_.settings.md b/docs/ui-settings/classes/_settings_.settings.md new file mode 100644 index 00000000..51503fd3 --- /dev/null +++ b/docs/ui-settings/classes/_settings_.settings.md @@ -0,0 +1,146 @@ + + +# Hierarchy + +**Settings** + +# Implements + +* [SettingsStruct](../interfaces/_types_.settingsstruct.md) + +# Constructors + + + +## constructor + +⊕ **new Settings**(): [Settings](_settings_.settings.md) + +*Defined in [Settings.ts:14](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L14)* + +**Returns:** [Settings](_settings_.settings.md) + +___ + +# Accessors + + + +## apiUrl + +**get apiUrl**(): `string` + +*Defined in [Settings.ts:25](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L25)* + +**Returns:** `string` + +___ + + +## availableLanguages + +**get availableLanguages**(): [Options](../modules/_types_.md#options) + +*Defined in [Settings.ts:45](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L45)* + +**Returns:** [Options](../modules/_types_.md#options) + +___ + + +## availableNodes + +**get availableNodes**(): [Options](../modules/_types_.md#options) + +*Defined in [Settings.ts:41](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L41)* + +**Returns:** [Options](../modules/_types_.md#options) + +___ + + +## availableUIModes + +**get availableUIModes**(): [Options](../modules/_types_.md#options) + +*Defined in [Settings.ts:49](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L49)* + +**Returns:** [Options](../modules/_types_.md#options) + +___ + + +## availableUIThemes + +**get availableUIThemes**(): [Options](../modules/_types_.md#options) + +*Defined in [Settings.ts:53](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L53)* + +**Returns:** [Options](../modules/_types_.md#options) + +___ + + +## i18nLang + +**get i18nLang**(): `string` + +*Defined in [Settings.ts:29](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L29)* + +**Returns:** `string` + +___ + + +## uiMode + +**get uiMode**(): `string` + +*Defined in [Settings.ts:33](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L33)* + +**Returns:** `string` + +___ + + +## uiTheme + +**get uiTheme**(): `string` + +*Defined in [Settings.ts:37](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L37)* + +**Returns:** `string` + +___ + +# Methods + + + +## get + +▸ **get**(): [SettingsStruct](../interfaces/_types_.settingsstruct.md) + +*Defined in [Settings.ts:57](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L57)* + +**Returns:** [SettingsStruct](../interfaces/_types_.settingsstruct.md) + +___ + + +## set + +▸ **set**(settings: *`Partial`<[SettingsStruct](../interfaces/_types_.settingsstruct.md)>*): `void` + +*Defined in [Settings.ts:66](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/Settings.ts#L66)* + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| settings | `Partial`<[SettingsStruct](../interfaces/_types_.settingsstruct.md)> | + +**Returns:** `void` + +___ + diff --git a/docs/ui-settings/index.html b/docs/ui-settings/index.html new file mode 100644 index 00000000..fdc8ee78 --- /dev/null +++ b/docs/ui-settings/index.html @@ -0,0 +1,52 @@ + + + + + + polkadot-js/ui + + + + + + + +
polkadot-js/ui

@polkadot/ui-settings

Manages app settings including endpoints, themes and prefixes

Usage Examples

User preferences are set as a settings object in the browser's local storage.

import settings from '@polkadot/ui-settings';
+
+render () {
+  // get api endpoint for the selected chain
+  const WS_URL = settings.apiUrl();
+
+  // get the selected il8n language
+  const language = settings.il8nLang();
+
+  // get all available il8n languages
+  const languages = settings.availableLanguages();
+
+  // update settings
+  const updatedSettings = {
+    ...settings,
+    i18nLang: 'Arabic'
+  }
+  settings.set(updatedSettings);
+
+  // NOTE: API currently does not handle hot reconnecting properly,
+  so you need to manually reload the page after updating settings.
+  window.location.reload();
+}
+
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

Used by

Apps that currently use the settings package

+ ← + + @polkadot/ui-util + + → +

+ + + diff --git a/docs/ui-settings/interfaces/_types_.settingsstruct.html b/docs/ui-settings/interfaces/_types_.settingsstruct.html new file mode 100644 index 00000000..13f14691 --- /dev/null +++ b/docs/ui-settings/interfaces/_types_.settingsstruct.html @@ -0,0 +1,21 @@ + + + + + + Hierarchy | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-settings/interfaces/_types_.settingsstruct.md b/docs/ui-settings/interfaces/_types_.settingsstruct.md new file mode 100644 index 00000000..15df2279 --- /dev/null +++ b/docs/ui-settings/interfaces/_types_.settingsstruct.md @@ -0,0 +1,49 @@ + + +# Hierarchy + +**SettingsStruct** + +# Implemented by + +* [Settings](../classes/_settings_.settings.md) + +# Properties + + + +## apiUrl + +**● apiUrl**: *`string`* + +*Defined in [types.ts:12](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/types.ts#L12)* + +___ + + +## i18nLang + +**● i18nLang**: *`string`* + +*Defined in [types.ts:13](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/types.ts#L13)* + +___ + + +## uiMode + +**● uiMode**: *`string`* + +*Defined in [types.ts:14](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/types.ts#L14)* + +___ + + +## uiTheme + +**● uiTheme**: *`string`* + +*Defined in [types.ts:15](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/types.ts#L15)* + +___ + diff --git a/docs/ui-settings/modules/_defaults_.html b/docs/ui-settings/modules/_defaults_.html new file mode 100644 index 00000000..62617b28 --- /dev/null +++ b/docs/ui-settings/modules/_defaults_.html @@ -0,0 +1,21 @@ + + + + + + polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-settings/modules/_defaults_.md b/docs/ui-settings/modules/_defaults_.md new file mode 100644 index 00000000..139597f9 --- /dev/null +++ b/docs/ui-settings/modules/_defaults_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/ui-settings/modules/_settings_.html b/docs/ui-settings/modules/_settings_.html new file mode 100644 index 00000000..a6650c1c --- /dev/null +++ b/docs/ui-settings/modules/_settings_.html @@ -0,0 +1,21 @@ + + + + + + Index | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-settings/modules/_settings_.md b/docs/ui-settings/modules/_settings_.md new file mode 100644 index 00000000..ef81c035 --- /dev/null +++ b/docs/ui-settings/modules/_settings_.md @@ -0,0 +1,10 @@ + + +# Index + +### Classes + +* [Settings](../classes/_settings_.settings.md) + +--- + diff --git a/docs/ui-settings/modules/_types_.html b/docs/ui-settings/modules/_types_.html new file mode 100644 index 00000000..cd181857 --- /dev/null +++ b/docs/ui-settings/modules/_types_.html @@ -0,0 +1,21 @@ + + + + + + Index | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-settings/modules/_types_.md b/docs/ui-settings/modules/_types_.md new file mode 100644 index 00000000..76a2f92d --- /dev/null +++ b/docs/ui-settings/modules/_types_.md @@ -0,0 +1,26 @@ + + +# Index + +### Interfaces + +* [SettingsStruct](../interfaces/_types_.settingsstruct.md) + +### Type aliases + +* [Options](_types_.md#options) + +--- + +# Type aliases + + + +## Options + +**Ƭ Options**: *`Array`<`object`>* + +*Defined in [types.ts:5](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-settings/src/types.ts#L5)* + +___ + diff --git a/docs/ui-util/README.md b/docs/ui-util/README.md new file mode 100644 index 00000000..d8ee9ecd --- /dev/null +++ b/docs/ui-util/README.md @@ -0,0 +1,28 @@ + +@polkadot/ui-util +================= + +Various utility and formatting functions + +formatBalance +------------- + +```js +const props = await api.rpc.system.properties(); + +formatBalance.setDefaults({ + decimals: props.tokenDecimals, + unit: props.tokenSymbol +}); + +formatBalance('12345'); // 12.345z DOT +``` + +calcSi +------ + +```js +// calculates the SI unit applicable +formatBalance.calcSi('12345'); // { power: 3, value: 'k', text: 'Kilo' } +``` + diff --git a/docs/ui-util/SUMMARY.html b/docs/ui-util/SUMMARY.html new file mode 100644 index 00000000..d086561b --- /dev/null +++ b/docs/ui-util/SUMMARY.html @@ -0,0 +1,21 @@ + + + + + + polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-util/SUMMARY.md b/docs/ui-util/SUMMARY.md new file mode 100644 index 00000000..e251eea9 --- /dev/null +++ b/docs/ui-util/SUMMARY.md @@ -0,0 +1,6 @@ +* ["formatBalance"](modules/_formatbalance_.md) +* ["formatDecimal"](modules/_formatdecimal_.md) +* ["formatElapsed"](modules/_formatelapsed_.md) +* ["formatNumber"](modules/_formatnumber_.md) +* ["isTestChain"](modules/_istestchain_.md) +* ["si"](modules/_si_.md) diff --git a/docs/ui-util/index.html b/docs/ui-util/index.html new file mode 100644 index 00000000..eb08d33c --- /dev/null +++ b/docs/ui-util/index.html @@ -0,0 +1,39 @@ + + + + + + polkadot-js/ui + + + + + + + +
polkadot-js/ui

@polkadot/ui-util

Various utility and formatting functions

formatBalance

const props = await api.rpc.system.properties();
+
+formatBalance.setDefaults({
+  decimals: props.tokenDecimals,
+  unit: props.tokenSymbol
+});
+
+formatBalance('12345'); // 12.345z DOT
+
1
2
3
4
5
6
7
8

calcSi

// calculates the SI unit applicable
+formatBalance.calcSi('12345'); // { power: 3, value: 'k', text: 'Kilo' }
+
1
2

+ ← + + Contributing + + → +

+ + + diff --git a/docs/ui-util/modules/_formatbalance_.html b/docs/ui-util/modules/_formatbalance_.html new file mode 100644 index 00000000..a845e35d --- /dev/null +++ b/docs/ui-util/modules/_formatbalance_.html @@ -0,0 +1,21 @@ + + + + + + polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-util/modules/_formatbalance_.md b/docs/ui-util/modules/_formatbalance_.md new file mode 100644 index 00000000..139597f9 --- /dev/null +++ b/docs/ui-util/modules/_formatbalance_.md @@ -0,0 +1,2 @@ + + diff --git a/docs/ui-util/modules/_formatdecimal_.html b/docs/ui-util/modules/_formatdecimal_.html new file mode 100644 index 00000000..fd3ba724 --- /dev/null +++ b/docs/ui-util/modules/_formatdecimal_.html @@ -0,0 +1,21 @@ + + + + + + Functions | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-util/modules/_formatdecimal_.md b/docs/ui-util/modules/_formatdecimal_.md new file mode 100644 index 00000000..2d5091b7 --- /dev/null +++ b/docs/ui-util/modules/_formatdecimal_.md @@ -0,0 +1,22 @@ + + +# Functions + + + +## formatDecimal + +▸ **formatDecimal**(value: *`string`*): `string` + +*Defined in [formatDecimal.ts:7](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-util/src/formatDecimal.ts#L7)* + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| value | `string` | + +**Returns:** `string` + +___ + diff --git a/docs/ui-util/modules/_formatelapsed_.html b/docs/ui-util/modules/_formatelapsed_.html new file mode 100644 index 00000000..0dc82b11 --- /dev/null +++ b/docs/ui-util/modules/_formatelapsed_.html @@ -0,0 +1,21 @@ + + + + + + Functions | polkadot-js/ui + + + + + + + +
polkadot-js/ui

Functions

formatElapsed

▸ formatElapsed(now?: Date | null, value?: BN | Compact | Date | number | null): string

Defined in formatElapsed.ts:20

Parameters:

Name Type
Optional now Date | null
Optional value BN | Compact | Date | number | null

Returns: string

+ + + diff --git a/docs/ui-util/modules/_formatelapsed_.md b/docs/ui-util/modules/_formatelapsed_.md new file mode 100644 index 00000000..d8cc6a15 --- /dev/null +++ b/docs/ui-util/modules/_formatelapsed_.md @@ -0,0 +1,23 @@ + + +# Functions + + + +## formatElapsed + +▸ **formatElapsed**(now?: *`Date` \| `null`*, value?: *`BN` \| `Compact` \| `Date` \| `number` \| `null`*): `string` + +*Defined in [formatElapsed.ts:20](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-util/src/formatElapsed.ts#L20)* + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| `Optional` now | `Date` \| `null` | +| `Optional` value | `BN` \| `Compact` \| `Date` \| `number` \| `null` | + +**Returns:** `string` + +___ + diff --git a/docs/ui-util/modules/_formatnumber_.html b/docs/ui-util/modules/_formatnumber_.html new file mode 100644 index 00000000..1c6680d4 --- /dev/null +++ b/docs/ui-util/modules/_formatnumber_.html @@ -0,0 +1,21 @@ + + + + + + Functions | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-util/modules/_formatnumber_.md b/docs/ui-util/modules/_formatnumber_.md new file mode 100644 index 00000000..d462636e --- /dev/null +++ b/docs/ui-util/modules/_formatnumber_.md @@ -0,0 +1,22 @@ + + +# Functions + + + +## formatNumber + +▸ **formatNumber**(_value?: *`Compact` \| `BN` \| `number` \| `null`*): `string` + +*Defined in [formatNumber.ts:11](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-util/src/formatNumber.ts#L11)* + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| `Optional` _value | `Compact` \| `BN` \| `number` \| `null` | + +**Returns:** `string` + +___ + diff --git a/docs/ui-util/modules/_istestchain_.html b/docs/ui-util/modules/_istestchain_.html new file mode 100644 index 00000000..5f42b8bf --- /dev/null +++ b/docs/ui-util/modules/_istestchain_.html @@ -0,0 +1,21 @@ + + + + + + Functions | polkadot-js/ui + + + + + + + + + + + diff --git a/docs/ui-util/modules/_istestchain_.md b/docs/ui-util/modules/_istestchain_.md new file mode 100644 index 00000000..abb310c7 --- /dev/null +++ b/docs/ui-util/modules/_istestchain_.md @@ -0,0 +1,22 @@ + + +# Functions + + + +## isTestChain + +▸ **isTestChain**(chain?: *`string` \| `null`*): `boolean` + +*Defined in [isTestChain.ts:7](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-util/src/isTestChain.ts#L7)* + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| `Optional` chain | `string` \| `null` | + +**Returns:** `boolean` + +___ + diff --git a/docs/ui-util/modules/_si_.html b/docs/ui-util/modules/_si_.html new file mode 100644 index 00000000..34a64d10 --- /dev/null +++ b/docs/ui-util/modules/_si_.html @@ -0,0 +1,39 @@ + + + + + + Type aliases | polkadot-js/ui + + + + + + + +
polkadot-js/ui

Type aliases

SiDef

Ƭ SiDef: object

Defined in si.ts:5

Type declaration

Variables

<Const> SI

● SI: Array<SiDef> = [ +{ power: -24, value: 'y', text: 'yocto' }, +{ power: -21, value: 'z', text: 'zepto' }, +{ power: -18, value: 'a', text: 'atto' }, +{ power: -15, value: 'f', text: 'femto' }, +{ power: -12, value: 'p', text: 'pico' }, +{ power: -9, value: 'n', text: 'nano' }, +{ power: -6, value: 'µ', text: 'micro' }, +{ power: -3, value: 'm', text: 'milli' }, +{ power: 0, value: '-', text: 'Unit' }, // position 8 +{ power: 3, value: 'k', text: 'Kilo' }, +{ power: 6, value: 'M', text: 'Mega' }, +{ power: 9, value: 'G', text: 'Giga' }, +{ power: 12, value: 'T', text: 'Tera' }, +{ power: 15, value: 'P', text: 'Peta' }, +{ power: 18, value: 'E', text: 'Exa' }, +{ power: 21, value: 'Z', text: 'Zeta' }, +{ power: 24, value: 'Y', text: 'Yotta' } +]

Defined in si.ts:13

<Const> SI_MID

● SI_MID: 8 = 8

Defined in si.ts:11

Functions

calcSi

▸ calcSi(text: string, decimals: number): SiDef

Defined in si.ts:33

Parameters:

Name Type
text string
decimals number

Returns: SiDef

findSi

▸ findSi(type: string): SiDef

Defined in si.ts:38

Parameters:

Name Type
type string

Returns: SiDef

+ + + diff --git a/docs/ui-util/modules/_si_.md b/docs/ui-util/modules/_si_.md new file mode 100644 index 00000000..7e860b1c --- /dev/null +++ b/docs/ui-util/modules/_si_.md @@ -0,0 +1,93 @@ + + +# Type aliases + + + +## SiDef + +**Ƭ SiDef**: *`object`* + +*Defined in [si.ts:5](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-util/src/si.ts#L5)* + +#### Type declaration + +___ + +# Variables + + + +## `` SI + +**● SI**: *`Array`<[SiDef](_si_.md#sidef)>* = [ + { power: -24, value: 'y', text: 'yocto' }, + { power: -21, value: 'z', text: 'zepto' }, + { power: -18, value: 'a', text: 'atto' }, + { power: -15, value: 'f', text: 'femto' }, + { power: -12, value: 'p', text: 'pico' }, + { power: -9, value: 'n', text: 'nano' }, + { power: -6, value: 'µ', text: 'micro' }, + { power: -3, value: 'm', text: 'milli' }, + { power: 0, value: '-', text: 'Unit' }, // position 8 + { power: 3, value: 'k', text: 'Kilo' }, + { power: 6, value: 'M', text: 'Mega' }, + { power: 9, value: 'G', text: 'Giga' }, + { power: 12, value: 'T', text: 'Tera' }, + { power: 15, value: 'P', text: 'Peta' }, + { power: 18, value: 'E', text: 'Exa' }, + { power: 21, value: 'Z', text: 'Zeta' }, + { power: 24, value: 'Y', text: 'Yotta' } +] + +*Defined in [si.ts:13](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-util/src/si.ts#L13)* + +___ + + +## `` SI_MID + +**● SI_MID**: *`8`* = 8 + +*Defined in [si.ts:11](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-util/src/si.ts#L11)* + +___ + +# Functions + + + +## calcSi + +▸ **calcSi**(text: *`string`*, decimals: *`number`*): [SiDef](_si_.md#sidef) + +*Defined in [si.ts:33](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-util/src/si.ts#L33)* + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| text | `string` | +| decimals | `number` | + +**Returns:** [SiDef](_si_.md#sidef) + +___ + + +## findSi + +▸ **findSi**(type: *`string`*): [SiDef](_si_.md#sidef) + +*Defined in [si.ts:38](https://github.com/polkadot-js/ui/blob/28b991d/packages/ui-util/src/si.ts#L38)* + +**Parameters:** + +| Name | Type | +| ------ | ------ | +| type | `string` | + +**Returns:** [SiDef](_si_.md#sidef) + +___ + diff --git a/lerna.json b/lerna.json index afe1e5ef..9fd30225 100644 --- a/lerna.json +++ b/lerna.json @@ -10,5 +10,5 @@ "packages": [ "packages/*" ], - "version": "0.28.3" + "version": "0.28.4" } diff --git a/package.json b/package.json index 5260d022..e2d8aa54 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "version": "0.28.3", + "version": "0.28.4", "private": true, "engines": { "node": "^10.13.0", diff --git a/packages/ui-assets/package.json b/packages/ui-assets/package.json index 879aa993..244bc292 100644 --- a/packages/ui-assets/package.json +++ b/packages/ui-assets/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/ui-assets", - "version": "0.28.3", + "version": "0.28.4", "description": "Static assets shared accross projects", "main": "index.js", "author": "Jaco Greeff ", diff --git a/packages/ui-identicon/package.json b/packages/ui-identicon/package.json index 0af4c5fc..76378c7c 100644 --- a/packages/ui-identicon/package.json +++ b/packages/ui-identicon/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/ui-identicon", - "version": "0.28.3", + "version": "0.28.4", "description": "Renders an SVG picture representing an address", "main": "index.js", "author": "Jaco Greeff ", @@ -10,7 +10,7 @@ "license": "Apache-2.0", "dependencies": { "@babel/runtime": "^7.3.1", - "@polkadot/ui-settings": "^0.28.3", + "@polkadot/ui-settings": "^0.28.4", "@types/color": "^3.0.0", "@types/react-copy-to-clipboard": "^4.2.6", "color": "^3.0.0", diff --git a/packages/ui-keyring/package.json b/packages/ui-keyring/package.json index a862741e..73f6a39b 100644 --- a/packages/ui-keyring/package.json +++ b/packages/ui-keyring/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/ui-keyring", - "version": "0.28.3", + "version": "0.28.4", "main": "index.js", "repository": "https://github.com/polkadot-js/apps.git", "author": "Jaco Greeff ", diff --git a/packages/ui-settings/package.json b/packages/ui-settings/package.json index d7f0e81c..d8bd74b0 100644 --- a/packages/ui-settings/package.json +++ b/packages/ui-settings/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/ui-settings", - "version": "0.28.3", + "version": "0.28.4", "description": "Manages app settings", "main": "index.js", "author": "Jaco Greeff ", diff --git a/packages/ui-util/package.json b/packages/ui-util/package.json index 4f1966fa..8d60f2b4 100644 --- a/packages/ui-util/package.json +++ b/packages/ui-util/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/ui-util", - "version": "0.28.3", + "version": "0.28.4", "description": "Utility functions (non-React) that aid in display, formats and determination", "main": "index.js", "author": "Jaco Greeff ",