| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271 |
- <!doctype html>
- <html class="default no-js">
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <title>@solana/wallet-adapter-react | @solana/wallet-adapter</title>
- <meta name="description" content="Documentation for @solana/wallet-adapter">
- <meta name="viewport" content="width=device-width, initial-scale=1">
- <link rel="stylesheet" href="../assets/css/main.css">
- <script async src="../assets/js/search.js" id="search-script"></script>
- </head>
- <body>
- <header>
- <div class="tsd-page-toolbar">
- <div class="container">
- <div class="table-wrap">
- <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
- <div class="field">
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
- <input id="tsd-search-field" type="text" />
- </div>
- <ul class="results">
- <li class="state loading">Preparing search index...</li>
- <li class="state failure">The search index is not available</li>
- </ul>
- <a href="../index.html" class="title">@solana/wallet-adapter</a>
- </div>
- <div class="table-cell" id="tsd-widgets">
- <div id="tsd-filter">
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
- <div class="tsd-filter-group">
- <div class="tsd-select" id="tsd-filter-visibility">
- <span class="tsd-select-label">All</span>
- <ul class="tsd-select-list">
- <li data-value="public">Public</li>
- <li data-value="protected">Public/Protected</li>
- <li data-value="private" class="selected">All</li>
- </ul>
- </div>
- <input type="checkbox" id="tsd-filter-inherited" checked />
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
- <input type="checkbox" id="tsd-filter-externals" checked />
- <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
- </div>
- </div>
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
- </div>
- </div>
- </div>
- </div>
- <div class="tsd-page-title">
- <div class="container">
- <ul class="tsd-breadcrumb">
- <li>
- <a href="../modules.html">@solana/wallet-adapter</a>
- </li>
- <li>
- <a href="_solana_wallet_adapter_react.html">@solana/wallet-adapter-react</a>
- </li>
- </ul>
- <h1>Module @solana/wallet-adapter-react</h1>
- </div>
- </div>
- </header>
- <div class="container container-main">
- <div class="row">
- <div class="col-8 col-content">
- <section class="tsd-panel-group tsd-index-group">
- <h2>Index</h2>
- <section class="tsd-panel tsd-index-panel">
- <div class="tsd-index-content">
- <section class="tsd-index-section ">
- <h3>Classes</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/_solana_wallet_adapter_react.WalletNotSelectedError.html" class="tsd-kind-icon">Wallet<wbr>Not<wbr>Selected<wbr>Error</a></li>
- </ul>
- </section>
- <section class="tsd-index-section ">
- <h3>Interfaces</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_solana_wallet_adapter_react.WalletContextState.html" class="tsd-kind-icon">Wallet<wbr>Context<wbr>State</a></li>
- <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_solana_wallet_adapter_react.WalletProviderProps.html" class="tsd-kind-icon">Wallet<wbr>Provider<wbr>Props</a></li>
- </ul>
- </section>
- <section class="tsd-index-section ">
- <h3>Variables</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-variable tsd-parent-kind-module"><a href="_solana_wallet_adapter_react.html#WalletContext" class="tsd-kind-icon">Wallet<wbr>Context</a></li>
- <li class="tsd-kind-variable tsd-parent-kind-module"><a href="_solana_wallet_adapter_react.html#WalletProvider" class="tsd-kind-icon">Wallet<wbr>Provider</a></li>
- </ul>
- </section>
- <section class="tsd-index-section ">
- <h3>Functions</h3>
- <ul class="tsd-index-list">
- <li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="_solana_wallet_adapter_react.html#useLocalStorage" class="tsd-kind-icon">use<wbr>Local<wbr>Storage</a></li>
- <li class="tsd-kind-function tsd-parent-kind-module"><a href="_solana_wallet_adapter_react.html#useWallet" class="tsd-kind-icon">use<wbr>Wallet</a></li>
- </ul>
- </section>
- </div>
- </section>
- </section>
- <section class="tsd-panel-group tsd-member-group ">
- <h2>Variables</h2>
- <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
- <a name="WalletContext" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagConst">Const</span> Wallet<wbr>Context</h3>
- <div class="tsd-signature tsd-kind-icon">Wallet<wbr>Context<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Context</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_solana_wallet_adapter_react.WalletContextState.html" class="tsd-signature-type" data-tsd-kind="Interface">WalletContextState</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/solana-labs/wallet-adapter/blob/49289f4/packages/react/src/useWallet.ts#L25">packages/react/src/useWallet.ts:25</a></li>
- </ul>
- </aside>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
- <a name="WalletProvider" class="tsd-anchor"></a>
- <h3><span class="tsd-flag ts-flagConst">Const</span> Wallet<wbr>Provider</h3>
- <div class="tsd-signature tsd-kind-icon">Wallet<wbr>Provider<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FC</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_solana_wallet_adapter_react.WalletProviderProps.html" class="tsd-signature-type" data-tsd-kind="Interface">WalletProviderProps</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div>
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/solana-labs/wallet-adapter/blob/49289f4/packages/react/src/WalletProvider.tsx#L17">packages/react/src/WalletProvider.tsx:17</a></li>
- </ul>
- </aside>
- </section>
- </section>
- <section class="tsd-panel-group tsd-member-group ">
- <h2>Functions</h2>
- <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
- <a name="useLocalStorage" class="tsd-anchor"></a>
- <h3>use<wbr>Local<wbr>Storage</h3>
- <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
- <li class="tsd-signature tsd-kind-icon">use<wbr>Local<wbr>Storage<T><span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, defaultState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>newValue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">]</span></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/solana-labs/wallet-adapter/blob/49289f4/packages/react/src/useLocalStorage.ts#L3">packages/react/src/useLocalStorage.ts:3</a></li>
- </ul>
- </aside>
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
- <ul class="tsd-type-parameters">
- <li>
- <h4>T</h4>
- </li>
- </ul>
- <h4 class="tsd-parameters-title">Parameters</h4>
- <ul class="tsd-parameters">
- <li>
- <h5>key: <span class="tsd-signature-type">string</span></h5>
- </li>
- <li>
- <h5>defaultState: <span class="tsd-signature-type">T</span></h5>
- </li>
- </ul>
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>newValue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">]</span></h4>
- </li>
- </ul>
- </section>
- <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
- <a name="useWallet" class="tsd-anchor"></a>
- <h3>use<wbr>Wallet</h3>
- <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
- <li class="tsd-signature tsd-kind-icon">use<wbr>Wallet<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_solana_wallet_adapter_react.WalletContextState.html" class="tsd-signature-type" data-tsd-kind="Interface">WalletContextState</a></li>
- </ul>
- <ul class="tsd-descriptions">
- <li class="tsd-description">
- <aside class="tsd-sources">
- <ul>
- <li>Defined in <a href="https://github.com/solana-labs/wallet-adapter/blob/49289f4/packages/react/src/useWallet.ts#L27">packages/react/src/useWallet.ts:27</a></li>
- </ul>
- </aside>
- <h4 class="tsd-returns-title">Returns <a href="../interfaces/_solana_wallet_adapter_react.WalletContextState.html" class="tsd-signature-type" data-tsd-kind="Interface">WalletContextState</a></h4>
- </li>
- </ul>
- </section>
- </section>
- </div>
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
- <nav class="tsd-navigation primary">
- <ul>
- <li class=" ">
- <a href="../modules.html">Modules</a>
- </li>
- <li class=" tsd-kind-module">
- <a href="_solana_wallet_adapter_base.html">@solana/wallet-<wbr>adapter-<wbr>base</a>
- </li>
- <li class=" tsd-kind-module">
- <a href="_solana_wallet_adapter_ledger.html">@solana/wallet-<wbr>adapter-<wbr>ledger</a>
- </li>
- <li class=" tsd-kind-module">
- <a href="_solana_wallet_adapter_material_ui.html">@solana/wallet-<wbr>adapter-<wbr>material-<wbr>ui</a>
- </li>
- <li class=" tsd-kind-module">
- <a href="_solana_wallet_adapter_mathwallet.html">@solana/wallet-<wbr>adapter-<wbr>mathwallet</a>
- </li>
- <li class=" tsd-kind-module">
- <a href="_solana_wallet_adapter_phantom.html">@solana/wallet-<wbr>adapter-<wbr>phantom</a>
- </li>
- <li class="current tsd-kind-module">
- <a href="_solana_wallet_adapter_react.html">@solana/wallet-<wbr>adapter-<wbr>react</a>
- </li>
- <li class=" tsd-kind-module">
- <a href="_solana_wallet_adapter_sollet.html">@solana/wallet-<wbr>adapter-<wbr>sollet</a>
- </li>
- <li class=" tsd-kind-module">
- <a href="_solana_wallet_adapter_solong.html">@solana/wallet-<wbr>adapter-<wbr>solong</a>
- </li>
- <li class=" tsd-kind-module">
- <a href="_solana_wallet_adapter_torus.html">@solana/wallet-<wbr>adapter-<wbr>torus</a>
- </li>
- <li class=" tsd-kind-module">
- <a href="_solana_wallet_adapter_wallets.html">@solana/wallet-<wbr>adapter-<wbr>wallets</a>
- </li>
- </ul>
- </nav>
- <nav class="tsd-navigation secondary menu-sticky">
- <ul class="before-current">
- <li class=" tsd-kind-class tsd-parent-kind-module">
- <a href="../classes/_solana_wallet_adapter_react.WalletNotSelectedError.html" class="tsd-kind-icon">Wallet<wbr>Not<wbr>Selected<wbr>Error</a>
- </li>
- <li class=" tsd-kind-interface tsd-parent-kind-module">
- <a href="../interfaces/_solana_wallet_adapter_react.WalletContextState.html" class="tsd-kind-icon">Wallet<wbr>Context<wbr>State</a>
- </li>
- <li class=" tsd-kind-interface tsd-parent-kind-module">
- <a href="../interfaces/_solana_wallet_adapter_react.WalletProviderProps.html" class="tsd-kind-icon">Wallet<wbr>Provider<wbr>Props</a>
- </li>
- <li class=" tsd-kind-variable tsd-parent-kind-module">
- <a href="_solana_wallet_adapter_react.html#WalletContext" class="tsd-kind-icon">Wallet<wbr>Context</a>
- </li>
- <li class=" tsd-kind-variable tsd-parent-kind-module">
- <a href="_solana_wallet_adapter_react.html#WalletProvider" class="tsd-kind-icon">Wallet<wbr>Provider</a>
- </li>
- <li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
- <a href="_solana_wallet_adapter_react.html#useLocalStorage" class="tsd-kind-icon">use<wbr>Local<wbr>Storage</a>
- </li>
- <li class=" tsd-kind-function tsd-parent-kind-module">
- <a href="_solana_wallet_adapter_react.html#useWallet" class="tsd-kind-icon">use<wbr>Wallet</a>
- </li>
- </ul>
- </nav>
- </div>
- </div>
- </div>
- <footer class="with-border-bottom">
- <div class="container">
- <h2>Legend</h2>
- <div class="tsd-legend-group">
- <ul class="tsd-legend">
- <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
- <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
- </ul>
- <ul class="tsd-legend">
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
- </ul>
- </div>
- </div>
- </footer>
- <div class="container tsd-generator">
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
- </div>
- <div class="overlay"></div>
- <script src="../assets/js/main.js"></script>
- </body>
- </html>
|