React hooks for Web3Auth Modal
Embedded Wallets offers a comprehensive suite of React hooks to streamline integration and state management within your React applications. These hooks abstract away common authentication and wallet operations, enabling you to implement Embedded Wallets' features with minimal boilerplate. Each hook is focused on a specific aspect of Embedded Wallets' functionality, making it easy to implement authentication, wallet operations, and blockchain interactions in your React projects.
List of React hooks
tip
For detailed usage, configuration options, and code examples, refer to the dedicated documentation page for each hook.
Web3Auth hooks
| Hook Name | Description |
|---|---|
useWeb3Auth | Core hook for Embedded Wallets initialization and state management. |
Authentication hooks
| Hook Name | Description |
|---|---|
useWeb3AuthConnect | Handles Embedded Wallets connection processes. |
useWeb3AuthDisconnect | Manages disconnection from Embedded Wallets. |
Identity hooks
| Hook Name | Description |
|---|---|
useAuthTokenInfo | Retrieves and manages identity tokens. |
useWeb3AuthUser | Provides access to the authenticated user's information. |
Blockchain hooks
| Hook Name | Description |
|---|---|
useChain | Returns the active chain ID and chain namespace. |
useSwitchChain | Allows switching between different blockchain networks. |
Wallet and account linking hooks
| Hook Name | Description |
|---|---|
useWallets | Lists the wallets connected in the user's session. |
useLinkAccount | Links or unlinks external wallets. Import from account-linking/react. |
useSwitchAccount | Switches the active wallet to a linked account. Import from account-linking/react. |
Multi-Factor Authentication hooks
| Hook Name | Description |
|---|---|
useEnableMFA | Enables Multi-Factor Authentication (MFA) for enhanced security. |
useManageMFA | Provides functionality to manage MFA settings. |
Wallet Services plugin hooks
| Hook Name | Description |
|---|---|
useWalletConnectScanner | Integrates WalletConnect scanner functionality. |
useWalletUI | Manages wallet UI components and user interactions. |
useCheckout | Facilitates cryptocurrency checkout processes. |
useSwap | Enables token swapping capabilities. |
useFunding | Opens the Wallet Services funding interface. |
useReceive | Opens the Wallet Services receive interface. |
useWalletServicesPlugin | Provides access to Wallet Services plugins. |
Payment hooks
| Hook Name | Description |
|---|---|
useX402Fetch | Makes x402 payment-gated fetch requests. Import from @web3auth/modal/x402/react. |