Merge branch 'dev' into docs

node-real · Nov 9, 2023 · ef217be · ef217be
2 parents 1da32b9 + aaf6846
commit ef217be
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/packages/walletkit/package.json b/packages/walletkit/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@totejs/walletkit",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "type": "module",
   "files": [
     "dist",

diff --git a/website/src/pages/index.mdx b/website/src/pages/index.mdx
@@ -117,13 +117,19 @@ export default function App() {
 
 ## useModal
 
+Use hook `useModal` to show/dismiss the specific modal. Must be used within a `<WalletKitProvider>`.
+
+- `onOpen`: open the connect wallet modal
+- `onOpenProfile`: open the connected modal
+- `onOpenSwitchNetwork`: open the switch network modal
+
 ```tsx live=false
 import { useModal } from '@totejs/walletkit';
 
 const { isOpen, onOpen, onClose, onOpenProfile, onOpenSwitchNetwork } = useModal();
 
 <button onClick={onOpen}>Open Connect Modal</button>
-<button onClick={onOpenProfile}>Open Profile Modal</button>
+<button onClick={onOpenProfile}>Open Connected Modal</button>
 <button onClick={onOpenSwitchNetwork}>Open SwitchNetwork Modal</button>
 ```