Skip to content
This repository was archived by the owner on Jan 16, 2026. It is now read-only.

Commit ac4bdfd

Browse files
committed
docs(README): add usage documentation to root README
1 parent 9ca1da3 commit ac4bdfd

File tree

1 file changed

+88
-0
lines changed

1 file changed

+88
-0
lines changed

README.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,94 @@ yarn add @txnlab/use-wallet-ui-react
1313
pnpm add @txnlab/use-wallet-ui-react
1414
```
1515

16+
## Usage
17+
18+
There are three main ways to use the wallet UI components:
19+
20+
### Approach 1: Using Default Components (Recommended)
21+
22+
Use the `WalletButton` component for the simplest integration:
23+
24+
```jsx
25+
import { WalletButton } from '@txnlab/use-wallet-ui-react'
26+
27+
function App() {
28+
return (
29+
<div>
30+
<WalletButton />
31+
</div>
32+
)
33+
}
34+
```
35+
36+
The `WalletButton` component automatically handles both connected and disconnected states.
37+
38+
### Approach 2: Using Customized Button Components with Menus
39+
40+
```jsx
41+
import { useWallet } from '@txnlab/use-wallet-react'
42+
import {
43+
ConnectWalletButton,
44+
ConnectWalletMenu,
45+
ConnectedWalletButton,
46+
ConnectedWalletMenu,
47+
} from '@txnlab/use-wallet-ui-react'
48+
49+
function App() {
50+
const { activeAddress } = useWallet()
51+
52+
return (
53+
<div>
54+
{activeAddress ? (
55+
<ConnectedWalletMenu>
56+
<ConnectedWalletButton className="border-2 border-blue-500" />
57+
</ConnectedWalletMenu>
58+
) : (
59+
<ConnectWalletMenu>
60+
<ConnectWalletButton className="bg-green-500 hover:bg-green-600">
61+
Connect your wallet
62+
</ConnectWalletButton>
63+
</ConnectWalletMenu>
64+
)}
65+
</div>
66+
)
67+
}
68+
```
69+
70+
### Approach 3: Using Completely Custom UI Elements
71+
72+
```jsx
73+
import { useWallet } from '@txnlab/use-wallet-react'
74+
import {
75+
ConnectWalletMenu,
76+
ConnectedWalletMenu,
77+
} from '@txnlab/use-wallet-ui-react'
78+
79+
function App() {
80+
const { activeAddress } = useWallet()
81+
82+
return (
83+
<div>
84+
{activeAddress ? (
85+
<ConnectedWalletMenu>
86+
<button className="custom-connected-button">
87+
My Custom Connected Button
88+
</button>
89+
</ConnectedWalletMenu>
90+
) : (
91+
<ConnectWalletMenu>
92+
<button className="custom-connect-button">
93+
My Custom Connect Button
94+
</button>
95+
</ConnectWalletMenu>
96+
)}
97+
</div>
98+
)
99+
}
100+
```
101+
102+
For more detailed documentation, please refer to the [package README](./packages/react/README.md).
103+
16104
## Example
17105

18106
Check out the [working example](./examples/react) in the `examples/react` directory.

0 commit comments

Comments
 (0)