_solana_wallet_adapter_material_ui.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314
  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-material-ui | @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_material_ui.html">@solana/wallet-adapter-material-ui</a>
  59. </li>
  60. </ul>
  61. <h1>Module @solana/wallet-adapter-material-ui</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>Interfaces</h3>
  74. <ul class="tsd-index-list">
  75. <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_solana_wallet_adapter_material_ui.WalletDialogContextState.html" class="tsd-kind-icon">Wallet<wbr>Dialog<wbr>Context<wbr>State</a></li>
  76. <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_solana_wallet_adapter_material_ui.WalletDialogProps.html" class="tsd-kind-icon">Wallet<wbr>Dialog<wbr>Props</a></li>
  77. <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_solana_wallet_adapter_material_ui.WalletIconProps.html" class="tsd-kind-icon">Wallet<wbr>Icon<wbr>Props</a></li>
  78. </ul>
  79. </section>
  80. <section class="tsd-index-section ">
  81. <h3>Variables</h3>
  82. <ul class="tsd-index-list">
  83. <li class="tsd-kind-variable tsd-parent-kind-module"><a href="_solana_wallet_adapter_material_ui.html#WalletConnectButton" class="tsd-kind-icon">Wallet<wbr>Connect<wbr>Button</a></li>
  84. <li class="tsd-kind-variable tsd-parent-kind-module"><a href="_solana_wallet_adapter_material_ui.html#WalletDialog" class="tsd-kind-icon">Wallet<wbr>Dialog</a></li>
  85. <li class="tsd-kind-variable tsd-parent-kind-module"><a href="_solana_wallet_adapter_material_ui.html#WalletDialogButton" class="tsd-kind-icon">Wallet<wbr>Dialog<wbr>Button</a></li>
  86. <li class="tsd-kind-variable tsd-parent-kind-module"><a href="_solana_wallet_adapter_material_ui.html#WalletDialogContext" class="tsd-kind-icon">Wallet<wbr>Dialog<wbr>Context</a></li>
  87. <li class="tsd-kind-variable tsd-parent-kind-module"><a href="_solana_wallet_adapter_material_ui.html#WalletDialogProvider" class="tsd-kind-icon">Wallet<wbr>Dialog<wbr>Provider</a></li>
  88. <li class="tsd-kind-variable tsd-parent-kind-module"><a href="_solana_wallet_adapter_material_ui.html#WalletDisconnectButton" class="tsd-kind-icon">Wallet<wbr>Disconnect<wbr>Button</a></li>
  89. <li class="tsd-kind-variable tsd-parent-kind-module"><a href="_solana_wallet_adapter_material_ui.html#WalletIcon" class="tsd-kind-icon">Wallet<wbr>Icon</a></li>
  90. <li class="tsd-kind-variable tsd-parent-kind-module"><a href="_solana_wallet_adapter_material_ui.html#WalletMultiButton" class="tsd-kind-icon">Wallet<wbr>Multi<wbr>Button</a></li>
  91. </ul>
  92. </section>
  93. <section class="tsd-index-section ">
  94. <h3>Functions</h3>
  95. <ul class="tsd-index-list">
  96. <li class="tsd-kind-function tsd-parent-kind-module"><a href="_solana_wallet_adapter_material_ui.html#useWalletDialog" class="tsd-kind-icon">use<wbr>Wallet<wbr>Dialog</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="WalletConnectButton" class="tsd-anchor"></a>
  106. <h3><span class="tsd-flag ts-flagConst">Const</span> Wallet<wbr>Connect<wbr>Button</h3>
  107. <div class="tsd-signature tsd-kind-icon">Wallet<wbr>Connect<wbr>Button<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FC</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ButtonProps</span><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/material-ui/src/WalletConnectButton.tsx#L6">packages/material-ui/src/WalletConnectButton.tsx:6</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="WalletDialog" class="tsd-anchor"></a>
  116. <h3><span class="tsd-flag ts-flagConst">Const</span> Wallet<wbr>Dialog</h3>
  117. <div class="tsd-signature tsd-kind-icon">Wallet<wbr>Dialog<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_material_ui.WalletDialogProps.html" class="tsd-signature-type" data-tsd-kind="Interface">WalletDialogProps</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/material-ui/src/WalletDialog.tsx#L71">packages/material-ui/src/WalletDialog.tsx:71</a></li>
  121. </ul>
  122. </aside>
  123. </section>
  124. <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
  125. <a name="WalletDialogButton" class="tsd-anchor"></a>
  126. <h3><span class="tsd-flag ts-flagConst">Const</span> Wallet<wbr>Dialog<wbr>Button</h3>
  127. <div class="tsd-signature tsd-kind-icon">Wallet<wbr>Dialog<wbr>Button<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FC</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ButtonProps</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div>
  128. <aside class="tsd-sources">
  129. <ul>
  130. <li>Defined in <a href="https://github.com/solana-labs/wallet-adapter/blob/49289f4/packages/material-ui/src/WalletDialogButton.tsx#L5">packages/material-ui/src/WalletDialogButton.tsx:5</a></li>
  131. </ul>
  132. </aside>
  133. </section>
  134. <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
  135. <a name="WalletDialogContext" class="tsd-anchor"></a>
  136. <h3><span class="tsd-flag ts-flagConst">Const</span> Wallet<wbr>Dialog<wbr>Context</h3>
  137. <div class="tsd-signature tsd-kind-icon">Wallet<wbr>Dialog<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_material_ui.WalletDialogContextState.html" class="tsd-signature-type" data-tsd-kind="Interface">WalletDialogContextState</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div>
  138. <aside class="tsd-sources">
  139. <ul>
  140. <li>Defined in <a href="https://github.com/solana-labs/wallet-adapter/blob/49289f4/packages/material-ui/src/useWalletDialog.ts#L8">packages/material-ui/src/useWalletDialog.ts:8</a></li>
  141. </ul>
  142. </aside>
  143. </section>
  144. <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
  145. <a name="WalletDialogProvider" class="tsd-anchor"></a>
  146. <h3><span class="tsd-flag ts-flagConst">Const</span> Wallet<wbr>Dialog<wbr>Provider</h3>
  147. <div class="tsd-signature tsd-kind-icon">Wallet<wbr>Dialog<wbr>Provider<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FC</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>children<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReactNode</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div>
  148. <aside class="tsd-sources">
  149. <ul>
  150. <li>Defined in <a href="https://github.com/solana-labs/wallet-adapter/blob/49289f4/packages/material-ui/src/WalletDialogProvider.tsx#L5">packages/material-ui/src/WalletDialogProvider.tsx:5</a></li>
  151. </ul>
  152. </aside>
  153. </section>
  154. <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
  155. <a name="WalletDisconnectButton" class="tsd-anchor"></a>
  156. <h3><span class="tsd-flag ts-flagConst">Const</span> Wallet<wbr>Disconnect<wbr>Button</h3>
  157. <div class="tsd-signature tsd-kind-icon">Wallet<wbr>Disconnect<wbr>Button<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FC</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ButtonProps</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div>
  158. <aside class="tsd-sources">
  159. <ul>
  160. <li>Defined in <a href="https://github.com/solana-labs/wallet-adapter/blob/49289f4/packages/material-ui/src/WalletDisconnectButton.tsx#L6">packages/material-ui/src/WalletDisconnectButton.tsx:6</a></li>
  161. </ul>
  162. </aside>
  163. </section>
  164. <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
  165. <a name="WalletIcon" class="tsd-anchor"></a>
  166. <h3><span class="tsd-flag ts-flagConst">Const</span> Wallet<wbr>Icon</h3>
  167. <div class="tsd-signature tsd-kind-icon">Wallet<wbr>Icon<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_material_ui.WalletIconProps.html" class="tsd-signature-type" data-tsd-kind="Interface">WalletIconProps</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div>
  168. <aside class="tsd-sources">
  169. <ul>
  170. <li>Defined in <a href="https://github.com/solana-labs/wallet-adapter/blob/49289f4/packages/material-ui/src/WalletIcon.tsx#L16">packages/material-ui/src/WalletIcon.tsx:16</a></li>
  171. </ul>
  172. </aside>
  173. </section>
  174. <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
  175. <a name="WalletMultiButton" class="tsd-anchor"></a>
  176. <h3><span class="tsd-flag ts-flagConst">Const</span> Wallet<wbr>Multi<wbr>Button</h3>
  177. <div class="tsd-signature tsd-kind-icon">Wallet<wbr>Multi<wbr>Button<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FC</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ButtonProps</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div>
  178. <aside class="tsd-sources">
  179. <ul>
  180. <li>Defined in <a href="https://github.com/solana-labs/wallet-adapter/blob/49289f4/packages/material-ui/src/WalletMultiButton.tsx#L49">packages/material-ui/src/WalletMultiButton.tsx:49</a></li>
  181. </ul>
  182. </aside>
  183. </section>
  184. </section>
  185. <section class="tsd-panel-group tsd-member-group ">
  186. <h2>Functions</h2>
  187. <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
  188. <a name="useWalletDialog" class="tsd-anchor"></a>
  189. <h3>use<wbr>Wallet<wbr>Dialog</h3>
  190. <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
  191. <li class="tsd-signature tsd-kind-icon">use<wbr>Wallet<wbr>Dialog<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_solana_wallet_adapter_material_ui.WalletDialogContextState.html" class="tsd-signature-type" data-tsd-kind="Interface">WalletDialogContextState</a></li>
  192. </ul>
  193. <ul class="tsd-descriptions">
  194. <li class="tsd-description">
  195. <aside class="tsd-sources">
  196. <ul>
  197. <li>Defined in <a href="https://github.com/solana-labs/wallet-adapter/blob/49289f4/packages/material-ui/src/useWalletDialog.ts#L10">packages/material-ui/src/useWalletDialog.ts:10</a></li>
  198. </ul>
  199. </aside>
  200. <h4 class="tsd-returns-title">Returns <a href="../interfaces/_solana_wallet_adapter_material_ui.WalletDialogContextState.html" class="tsd-signature-type" data-tsd-kind="Interface">WalletDialogContextState</a></h4>
  201. </li>
  202. </ul>
  203. </section>
  204. </section>
  205. </div>
  206. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  207. <nav class="tsd-navigation primary">
  208. <ul>
  209. <li class=" ">
  210. <a href="../modules.html">Modules</a>
  211. </li>
  212. <li class=" tsd-kind-module">
  213. <a href="_solana_wallet_adapter_base.html">@solana/wallet-<wbr>adapter-<wbr>base</a>
  214. </li>
  215. <li class=" tsd-kind-module">
  216. <a href="_solana_wallet_adapter_ledger.html">@solana/wallet-<wbr>adapter-<wbr>ledger</a>
  217. </li>
  218. <li class="current tsd-kind-module">
  219. <a href="_solana_wallet_adapter_material_ui.html">@solana/wallet-<wbr>adapter-<wbr>material-<wbr>ui</a>
  220. </li>
  221. <li class=" tsd-kind-module">
  222. <a href="_solana_wallet_adapter_mathwallet.html">@solana/wallet-<wbr>adapter-<wbr>mathwallet</a>
  223. </li>
  224. <li class=" tsd-kind-module">
  225. <a href="_solana_wallet_adapter_phantom.html">@solana/wallet-<wbr>adapter-<wbr>phantom</a>
  226. </li>
  227. <li class=" tsd-kind-module">
  228. <a href="_solana_wallet_adapter_react.html">@solana/wallet-<wbr>adapter-<wbr>react</a>
  229. </li>
  230. <li class=" tsd-kind-module">
  231. <a href="_solana_wallet_adapter_sollet.html">@solana/wallet-<wbr>adapter-<wbr>sollet</a>
  232. </li>
  233. <li class=" tsd-kind-module">
  234. <a href="_solana_wallet_adapter_solong.html">@solana/wallet-<wbr>adapter-<wbr>solong</a>
  235. </li>
  236. <li class=" tsd-kind-module">
  237. <a href="_solana_wallet_adapter_torus.html">@solana/wallet-<wbr>adapter-<wbr>torus</a>
  238. </li>
  239. <li class=" tsd-kind-module">
  240. <a href="_solana_wallet_adapter_wallets.html">@solana/wallet-<wbr>adapter-<wbr>wallets</a>
  241. </li>
  242. </ul>
  243. </nav>
  244. <nav class="tsd-navigation secondary menu-sticky">
  245. <ul class="before-current">
  246. <li class=" tsd-kind-interface tsd-parent-kind-module">
  247. <a href="../interfaces/_solana_wallet_adapter_material_ui.WalletDialogContextState.html" class="tsd-kind-icon">Wallet<wbr>Dialog<wbr>Context<wbr>State</a>
  248. </li>
  249. <li class=" tsd-kind-interface tsd-parent-kind-module">
  250. <a href="../interfaces/_solana_wallet_adapter_material_ui.WalletDialogProps.html" class="tsd-kind-icon">Wallet<wbr>Dialog<wbr>Props</a>
  251. </li>
  252. <li class=" tsd-kind-interface tsd-parent-kind-module">
  253. <a href="../interfaces/_solana_wallet_adapter_material_ui.WalletIconProps.html" class="tsd-kind-icon">Wallet<wbr>Icon<wbr>Props</a>
  254. </li>
  255. <li class=" tsd-kind-variable tsd-parent-kind-module">
  256. <a href="_solana_wallet_adapter_material_ui.html#WalletConnectButton" class="tsd-kind-icon">Wallet<wbr>Connect<wbr>Button</a>
  257. </li>
  258. <li class=" tsd-kind-variable tsd-parent-kind-module">
  259. <a href="_solana_wallet_adapter_material_ui.html#WalletDialog" class="tsd-kind-icon">Wallet<wbr>Dialog</a>
  260. </li>
  261. <li class=" tsd-kind-variable tsd-parent-kind-module">
  262. <a href="_solana_wallet_adapter_material_ui.html#WalletDialogButton" class="tsd-kind-icon">Wallet<wbr>Dialog<wbr>Button</a>
  263. </li>
  264. <li class=" tsd-kind-variable tsd-parent-kind-module">
  265. <a href="_solana_wallet_adapter_material_ui.html#WalletDialogContext" class="tsd-kind-icon">Wallet<wbr>Dialog<wbr>Context</a>
  266. </li>
  267. <li class=" tsd-kind-variable tsd-parent-kind-module">
  268. <a href="_solana_wallet_adapter_material_ui.html#WalletDialogProvider" class="tsd-kind-icon">Wallet<wbr>Dialog<wbr>Provider</a>
  269. </li>
  270. <li class=" tsd-kind-variable tsd-parent-kind-module">
  271. <a href="_solana_wallet_adapter_material_ui.html#WalletDisconnectButton" class="tsd-kind-icon">Wallet<wbr>Disconnect<wbr>Button</a>
  272. </li>
  273. <li class=" tsd-kind-variable tsd-parent-kind-module">
  274. <a href="_solana_wallet_adapter_material_ui.html#WalletIcon" class="tsd-kind-icon">Wallet<wbr>Icon</a>
  275. </li>
  276. <li class=" tsd-kind-variable tsd-parent-kind-module">
  277. <a href="_solana_wallet_adapter_material_ui.html#WalletMultiButton" class="tsd-kind-icon">Wallet<wbr>Multi<wbr>Button</a>
  278. </li>
  279. <li class=" tsd-kind-function tsd-parent-kind-module">
  280. <a href="_solana_wallet_adapter_material_ui.html#useWalletDialog" class="tsd-kind-icon">use<wbr>Wallet<wbr>Dialog</a>
  281. </li>
  282. </ul>
  283. </nav>
  284. </div>
  285. </div>
  286. </div>
  287. <footer class="with-border-bottom">
  288. <div class="container">
  289. <h2>Legend</h2>
  290. <div class="tsd-legend-group">
  291. <ul class="tsd-legend">
  292. <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
  293. <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
  294. <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
  295. </ul>
  296. <ul class="tsd-legend">
  297. <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
  298. </ul>
  299. <ul class="tsd-legend">
  300. <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
  301. </ul>
  302. <ul class="tsd-legend">
  303. <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
  304. </ul>
  305. </div>
  306. </div>
  307. </footer>
  308. <div class="container tsd-generator">
  309. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  310. </div>
  311. <div class="overlay"></div>
  312. <script src="../assets/js/main.js"></script>
  313. </body>
  314. </html>