_solana_wallet_adapter_react.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271
  1. <!doctype html>
  2. <html class="default no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  6. <title>@solana/wallet-adapter-react | @solana/wallet-adapter</title>
  7. <meta name="description" content="Documentation for @solana/wallet-adapter">
  8. <meta name="viewport" content="width=device-width, initial-scale=1">
  9. <link rel="stylesheet" href="../assets/css/main.css">
  10. <script async src="../assets/js/search.js" id="search-script"></script>
  11. </head>
  12. <body>
  13. <header>
  14. <div class="tsd-page-toolbar">
  15. <div class="container">
  16. <div class="table-wrap">
  17. <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
  18. <div class="field">
  19. <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
  20. <input id="tsd-search-field" type="text" />
  21. </div>
  22. <ul class="results">
  23. <li class="state loading">Preparing search index...</li>
  24. <li class="state failure">The search index is not available</li>
  25. </ul>
  26. <a href="../index.html" class="title">@solana/wallet-adapter</a>
  27. </div>
  28. <div class="table-cell" id="tsd-widgets">
  29. <div id="tsd-filter">
  30. <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
  31. <div class="tsd-filter-group">
  32. <div class="tsd-select" id="tsd-filter-visibility">
  33. <span class="tsd-select-label">All</span>
  34. <ul class="tsd-select-list">
  35. <li data-value="public">Public</li>
  36. <li data-value="protected">Public/Protected</li>
  37. <li data-value="private" class="selected">All</li>
  38. </ul>
  39. </div>
  40. <input type="checkbox" id="tsd-filter-inherited" checked />
  41. <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
  42. <input type="checkbox" id="tsd-filter-externals" checked />
  43. <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
  44. </div>
  45. </div>
  46. <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
  47. </div>
  48. </div>
  49. </div>
  50. </div>
  51. <div class="tsd-page-title">
  52. <div class="container">
  53. <ul class="tsd-breadcrumb">
  54. <li>
  55. <a href="../modules.html">@solana/wallet-adapter</a>
  56. </li>
  57. <li>
  58. <a href="_solana_wallet_adapter_react.html">@solana/wallet-adapter-react</a>
  59. </li>
  60. </ul>
  61. <h1>Module @solana/wallet-adapter-react</h1>
  62. </div>
  63. </div>
  64. </header>
  65. <div class="container container-main">
  66. <div class="row">
  67. <div class="col-8 col-content">
  68. <section class="tsd-panel-group tsd-index-group">
  69. <h2>Index</h2>
  70. <section class="tsd-panel tsd-index-panel">
  71. <div class="tsd-index-content">
  72. <section class="tsd-index-section ">
  73. <h3>Classes</h3>
  74. <ul class="tsd-index-list">
  75. <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>
  76. </ul>
  77. </section>
  78. <section class="tsd-index-section ">
  79. <h3>Interfaces</h3>
  80. <ul class="tsd-index-list">
  81. <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>
  82. <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>
  83. </ul>
  84. </section>
  85. <section class="tsd-index-section ">
  86. <h3>Variables</h3>
  87. <ul class="tsd-index-list">
  88. <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>
  89. <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>
  90. </ul>
  91. </section>
  92. <section class="tsd-index-section ">
  93. <h3>Functions</h3>
  94. <ul class="tsd-index-list">
  95. <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>
  96. <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>
  97. </ul>
  98. </section>
  99. </div>
  100. </section>
  101. </section>
  102. <section class="tsd-panel-group tsd-member-group ">
  103. <h2>Variables</h2>
  104. <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
  105. <a name="WalletContext" class="tsd-anchor"></a>
  106. <h3><span class="tsd-flag ts-flagConst">Const</span> Wallet<wbr>Context</h3>
  107. <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">&lt;</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">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div>
  108. <aside class="tsd-sources">
  109. <ul>
  110. <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>
  111. </ul>
  112. </aside>
  113. </section>
  114. <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
  115. <a name="WalletProvider" class="tsd-anchor"></a>
  116. <h3><span class="tsd-flag ts-flagConst">Const</span> Wallet<wbr>Provider</h3>
  117. <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">&lt;</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">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div>
  118. <aside class="tsd-sources">
  119. <ul>
  120. <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>
  121. </ul>
  122. </aside>
  123. </section>
  124. </section>
  125. <section class="tsd-panel-group tsd-member-group ">
  126. <h2>Functions</h2>
  127. <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
  128. <a name="useLocalStorage" class="tsd-anchor"></a>
  129. <h3>use<wbr>Local<wbr>Storage</h3>
  130. <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
  131. <li class="tsd-signature tsd-kind-icon">use<wbr>Local<wbr>Storage&lt;T&gt;<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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">]</span></li>
  132. </ul>
  133. <ul class="tsd-descriptions">
  134. <li class="tsd-description">
  135. <aside class="tsd-sources">
  136. <ul>
  137. <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>
  138. </ul>
  139. </aside>
  140. <h4 class="tsd-type-parameters-title">Type parameters</h4>
  141. <ul class="tsd-type-parameters">
  142. <li>
  143. <h4>T</h4>
  144. </li>
  145. </ul>
  146. <h4 class="tsd-parameters-title">Parameters</h4>
  147. <ul class="tsd-parameters">
  148. <li>
  149. <h5>key: <span class="tsd-signature-type">string</span></h5>
  150. </li>
  151. <li>
  152. <h5>defaultState: <span class="tsd-signature-type">T</span></h5>
  153. </li>
  154. </ul>
  155. <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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">]</span></h4>
  156. </li>
  157. </ul>
  158. </section>
  159. <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
  160. <a name="useWallet" class="tsd-anchor"></a>
  161. <h3>use<wbr>Wallet</h3>
  162. <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
  163. <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>
  164. </ul>
  165. <ul class="tsd-descriptions">
  166. <li class="tsd-description">
  167. <aside class="tsd-sources">
  168. <ul>
  169. <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>
  170. </ul>
  171. </aside>
  172. <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>
  173. </li>
  174. </ul>
  175. </section>
  176. </section>
  177. </div>
  178. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  179. <nav class="tsd-navigation primary">
  180. <ul>
  181. <li class=" ">
  182. <a href="../modules.html">Modules</a>
  183. </li>
  184. <li class=" tsd-kind-module">
  185. <a href="_solana_wallet_adapter_base.html">@solana/wallet-<wbr>adapter-<wbr>base</a>
  186. </li>
  187. <li class=" tsd-kind-module">
  188. <a href="_solana_wallet_adapter_ledger.html">@solana/wallet-<wbr>adapter-<wbr>ledger</a>
  189. </li>
  190. <li class=" tsd-kind-module">
  191. <a href="_solana_wallet_adapter_material_ui.html">@solana/wallet-<wbr>adapter-<wbr>material-<wbr>ui</a>
  192. </li>
  193. <li class=" tsd-kind-module">
  194. <a href="_solana_wallet_adapter_mathwallet.html">@solana/wallet-<wbr>adapter-<wbr>mathwallet</a>
  195. </li>
  196. <li class=" tsd-kind-module">
  197. <a href="_solana_wallet_adapter_phantom.html">@solana/wallet-<wbr>adapter-<wbr>phantom</a>
  198. </li>
  199. <li class="current tsd-kind-module">
  200. <a href="_solana_wallet_adapter_react.html">@solana/wallet-<wbr>adapter-<wbr>react</a>
  201. </li>
  202. <li class=" tsd-kind-module">
  203. <a href="_solana_wallet_adapter_sollet.html">@solana/wallet-<wbr>adapter-<wbr>sollet</a>
  204. </li>
  205. <li class=" tsd-kind-module">
  206. <a href="_solana_wallet_adapter_solong.html">@solana/wallet-<wbr>adapter-<wbr>solong</a>
  207. </li>
  208. <li class=" tsd-kind-module">
  209. <a href="_solana_wallet_adapter_torus.html">@solana/wallet-<wbr>adapter-<wbr>torus</a>
  210. </li>
  211. <li class=" tsd-kind-module">
  212. <a href="_solana_wallet_adapter_wallets.html">@solana/wallet-<wbr>adapter-<wbr>wallets</a>
  213. </li>
  214. </ul>
  215. </nav>
  216. <nav class="tsd-navigation secondary menu-sticky">
  217. <ul class="before-current">
  218. <li class=" tsd-kind-class tsd-parent-kind-module">
  219. <a href="../classes/_solana_wallet_adapter_react.WalletNotSelectedError.html" class="tsd-kind-icon">Wallet<wbr>Not<wbr>Selected<wbr>Error</a>
  220. </li>
  221. <li class=" tsd-kind-interface tsd-parent-kind-module">
  222. <a href="../interfaces/_solana_wallet_adapter_react.WalletContextState.html" class="tsd-kind-icon">Wallet<wbr>Context<wbr>State</a>
  223. </li>
  224. <li class=" tsd-kind-interface tsd-parent-kind-module">
  225. <a href="../interfaces/_solana_wallet_adapter_react.WalletProviderProps.html" class="tsd-kind-icon">Wallet<wbr>Provider<wbr>Props</a>
  226. </li>
  227. <li class=" tsd-kind-variable tsd-parent-kind-module">
  228. <a href="_solana_wallet_adapter_react.html#WalletContext" class="tsd-kind-icon">Wallet<wbr>Context</a>
  229. </li>
  230. <li class=" tsd-kind-variable tsd-parent-kind-module">
  231. <a href="_solana_wallet_adapter_react.html#WalletProvider" class="tsd-kind-icon">Wallet<wbr>Provider</a>
  232. </li>
  233. <li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
  234. <a href="_solana_wallet_adapter_react.html#useLocalStorage" class="tsd-kind-icon">use<wbr>Local<wbr>Storage</a>
  235. </li>
  236. <li class=" tsd-kind-function tsd-parent-kind-module">
  237. <a href="_solana_wallet_adapter_react.html#useWallet" class="tsd-kind-icon">use<wbr>Wallet</a>
  238. </li>
  239. </ul>
  240. </nav>
  241. </div>
  242. </div>
  243. </div>
  244. <footer class="with-border-bottom">
  245. <div class="container">
  246. <h2>Legend</h2>
  247. <div class="tsd-legend-group">
  248. <ul class="tsd-legend">
  249. <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
  250. <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
  251. <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
  252. </ul>
  253. <ul class="tsd-legend">
  254. <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
  255. </ul>
  256. <ul class="tsd-legend">
  257. <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
  258. </ul>
  259. <ul class="tsd-legend">
  260. <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
  261. </ul>
  262. </div>
  263. </div>
  264. </footer>
  265. <div class="container tsd-generator">
  266. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  267. </div>
  268. <div class="overlay"></div>
  269. <script src="../assets/js/main.js"></script>
  270. </body>
  271. </html>