Hooks - Reown Docs

Hooks are React functions that provide access to wallet connection features, modal controls, blockchain interactions, and wallet event subscriptions. They enable you to manage wallet connections, handle user authentication, interact with smart contracts, and respond to wallet events in your application.

Hook Ecosystem

AppKit provides a comprehensive set of React hooks that work together to provide a complete wallet connection and blockchain interaction experience. These hooks can be categorized into several functional groups:

Connection Hooks: Manage wallet connections and user authentication (useAppKit, useAppKitAccount, useAppKitProvider, useDisconnect)
Network Hooks: Handle blockchain network selection and information (useAppKitNetwork)
UI Control Hooks: Control the modal and UI elements (useAppKitState, useAppKitTheme)
Data Access Hooks: Access wallet and blockchain data (useAppKitBalance, useWalletInfo)
Event Hooks: Subscribe to wallet and connection events (useAppKitEvents)

The diagram below illustrates how these hooks relate to each other and to the core AppKit functionality: These hooks provide a modular way to integrate wallet functionality into your application, allowing you to use only the features you need.

useAppKit

The primary hook for controlling the modal’s visibility and behavior. Use this hook when you need to programmatically open or close the modal, or when you want to show specific views like the connection screen or account details.

import { useAppKit } from "@reown/appkit/react";

export default function Component() {
  const { open, close } = useAppKit();
}

Use Cases

Opening the modal when a user clicks a “Connect Wallet” button
Closing the modal after a successful connection
Opening specific views of the modal (e.g., account view, connect view)
Handling custom wallet connection flows

Returns

open: Function to open the modal
close: Function to close the modal

Parameters

You can also select the modal’s view when calling the open function

open({ view: "Account" });

// to connect and show multi wallets view
open({ view: "Connect" });

// to connect and show only solana wallets
open({ view: "Connect", namespace: "solana" });

// to connect and show only bitcoin wallets
open({ view: "Connect", namespace: "bip122" });

// to connect and show only ethereum wallets
open({ view: "Connect", namespace: "eip155" });

// to open swap with arguments
open({
  view: 'Swap',
  arguments: {
    amount: '321.123',
    fromToken: 'USDC',
    toToken: 'ETH'
  }
})

Available namespaces for the Connect view:

Namespace	Description
solana	For connecting to Solana wallets
bip122	For connecting to Bitcoin wallets
eip155	For connecting to Ethereum wallets

List of views you can select:

Variable	Description
Connect	Principal view of the modal - default view when disconnected. A `namespace` can be selected to connect to a specific network (solana, bip122 or eip155)
Account	User profile - default view when connected
AllWallets	Shows the list of all available wallets
Networks	List of available networks - you can select and target a specific network before connecting
WhatIsANetwork	”What is a network” onboarding view
WhatIsAWallet	”What is a wallet” onboarding view
OnRampProviders	On-Ramp main view
Swap	Swap main view

useAppKitAccount

The essential hook for accessing wallet connection state and user information. Use this hook whenever you need to know if a user is connected, get their wallet address, or access their embedded wallet details.

import { useAppKitAccount } from "@reown/appkit/react";

const { address, isConnected, caipAddress, status, embeddedWalletInfo } =
  useAppKitAccount();

Use Cases

Displaying the connected wallet address in your UI
Checking if a user is connected before showing certain features
Getting user information for embedded wallets
Handling multi-chain scenarios where you need account info for specific chains

Related hooks: useAppKitWallet, useDisconnect

Hook for accessing account data and connection status for each namespace when working in a multi-chain environment.

import { useAppKitAccount } from "@reown/appkit/react";

const eip155Account = useAppKitAccount({ namespace: "eip155" }); // for EVM chains
const solanaAccount = useAppKitAccount({ namespace: "solana" });
const bip122Account = useAppKitAccount({ namespace: "bip122" }); // for bitcoin

Returns

allAccounts: A list of connected accounts
address: The current account address
caipAddress: The current account address in CAIP format
isConnected: Boolean that indicates if the user is connected
status: The current connection status
embeddedWalletInfo: The current embedded wallet information

type EmbeddedWalletInfo {
  user: {
    email?: string | null | undefined
    username?: string | null | undefined
  },
  accountType: 'eoa' | 'smartAccount',
  authProvider: 'google' | 'apple' | 'facebook' | 'x' | 'discord' | 'farcaster' | 'github' | 'email',
  isSmartAccountDeployed: boolean
}

type ConnectionStatus = 'connected' | 'disconnected' | 'connecting' | 'reconnecting'

type UseAppKitAccountReturnType = {
  isConnected: boolean
  allAccounts: Account[]
  status?: ConnectionStatus
  address?: string
  caipAddress?: `${string}:${string}`
  embeddedWalletInfo?: EmbeddedWalletInfo
}

Getting Bitcoin Public Keys

When working with Bitcoin accounts, you can extract public keys from the connected accounts:

import { useAppKitAccount } from "@reown/appkit/react";

function BitcoinComponent() {
  const { allAccounts } = useAppKitAccount({ chainNamespace: 'bip122' });
  const publicKeys = allAccounts.map(acc => acc.publicKey);
  
  return (
    <div>
      {publicKeys.map((key, index) => (
        <div key={index}>Public Key: {key}</div>
      ))}
    </div>
  );
}

This is particularly useful when you need to access Bitcoin public keys for transaction signing or address derivation.

useAppKitWallet

The direct wallet connection hook that enables connectivity to specific wallets without opening the modal. Use this hook when you want to provide direct wallet buttons, create a customized wallet selection interface, or implement social login options. Using the wallet button hooks (Demo in our Lab), you can directly connect to the top 20 wallets, WalletConnect QR and also all the social logins. This hook allows to customize dApps, enabling users to connect their wallets effortlessly, all without the need to open the traditional modal. Execute this command to install the library for use it:

npm install @reown/appkit-wallet-button

Then you have to import the hook in your project:

import { useAppKitWallet } from "@reown/appkit-wallet-button/react";

And finally, you can use the hook in your project:

const { isReady, isPending, connect } = useAppKitWallet({
    onSuccess(parsedCaipAddress) {
      // Access the parsed CAIP address object
      // See: https://github.com/reown-com/appkit/blob/main/packages/common/src/utils/ParseUtil.ts#L3-L7
      // ...
    },
    onError(error) {
      // ...
    }
  })

...

// Connect to WalletConnect
<Button onClick={() => connect("walletConnect")} />

Options for the connect parameter

AppKit supports the top 32 wallets, WalletConnect, social logins, and email authentication:

Type	Options
QR Code	walletConnect
Wallets	metamask, trust, coinbase, rainbow, coinbase, jupiter, solflare, coin98, magic-eden, backpack, frontier, xverse, okx, bitget, leather, binance, uniswap, safepal, bybit, phantom, ledger, timeless-x, safe, zerion, oneinch, crypto-com, imtoken, kraken, ronin, robinhood, exodus, argent and tokenpocket
Social logins	google, github, apple, facebook, x, discord and farcaster
Email	email

Use Cases

useAppKitWallet enables:

Direct Wallet Integration
- Direct connection to specific wallets (e.g., MetaMask, Coinbase)
- Streamlined connection flow without modal
Social Authentication
- Social login options (Google, GitHub, etc.)
- Email-based authentication
Custom Wallet Selection
- Branded wallet selection interface
- Custom styling and filtering options
Network-Specific Access
- Chain-specific wallet options
- Conditional wallet availability
Enhanced UX
- Loading states and error handling
- Custom notifications
- Responsive connection states

useAppKitNetwork

The network management hook that provides access to chain information and network switching capabilities. Use this hook when you need to display the current network, switch between networks, or validate network compatibility.

import { useAppKitNetwork } from "@reown/appkit/react";

export default Component(){
  const { caipNetwork, caipNetworkId, chainId, switchNetwork } = useAppKitNetwork()
}

Use Cases

Displaying the current network/chain in your UI
Switching networks when a user selects a different chain
Validating if a user is on the correct network for your dApp
Handling network-specific features or contracts

Related hooks: useAppKitBalance, useWalletInfo

Returns

caipNetwork: The current network object
caipNetworkId: The current network id in CAIP format
chainId: The current chain id
switchNetwork: Function to switch the network. Accepts a caipNetwork object as argument.

See how to import or create a networks here.

useAppKitBalance

The balance management hook that provides functions to fetch the native token balance of the connected wallet. Use this hook when you need to display the user’s balance, check if they have sufficient funds for a transaction, or track balance changes.

import { useAppKitBalance } from "@reown/appkit/react";

function BalanceDisplay() {
  const { fetchBalance } = useAppKitBalance();
  const [balance, setBalance] = useState();
  const { isConnected } = useAppKitAccount();
  
  useEffect(() => {
    if (isConnected) {
      fetchBalance().then(setBalance);
    }
  }, [isConnected, fetchBalance]);

  return (
    <div>
      {balance && (
        <p>Balance: {balance.data?.formatted} {balance.data?.symbol}</p>
      )}
    </div>
  );
}

Use Cases

Displaying the user’s wallet balance in your UI
Checking if a user has sufficient funds before initiating a transaction
Monitoring balance changes after transactions
Implementing balance-based features or UIs

Related hooks: useAppKitAccount, useAppKitNetwork

Returns

fetchBalance: Async function that returns the current balance of the connected wallet

type BalanceResult = {
  data?: {
    formatted: string;
    symbol: string;
  };
  error: string | null;
  isSuccess: boolean;
  isError: boolean;
}

useAppKitState

The state management hook that provides real-time access to the modal’s current state. Use this hook when you need to react to modal state changes or synchronize your UI with the modal’s status.

import { useAppKitState } from "@reown/appkit/react";

const { 
  initialized, 
  loading, 
  open, 
  selectedNetworkId, 
  activeChain 
} = useAppKitState();

Use Cases

Syncing your UI with the modal’s open/closed state
Tracking which network the user has selected
Creating custom UI elements that respond to modal state changes
Implementing custom loading states based on modal state
Checking if AppKit has been fully initialized before rendering components
Displaying chain-specific UI based on the active blockchain namespace

Returns

initialized: Boolean that indicates if AppKit has been initialized. This sets to true when all controllers, adapters and internal state is ready
loading: Boolean that indicates if AppKit is loading
open: Boolean that indicates if the modal is open
selectedNetworkId: The current chain id selected by the user in CAIP-2 format
activeChain: The active chain namespace (e.g., ‘eip155’, ‘solana’, ‘bip122’)

Example Usage

import { useAppKitState } from "@reown/appkit/react";

function AppStatus() {
  const { initialized, loading, open, selectedNetworkId, activeChain } = useAppKitState();

  if (!initialized) {
    return <div>Initializing AppKit...</div>;
  }

  if (loading) {
    return <div>Loading...</div>;
  }

  return (
    <div>
      <p>Modal is {open ? 'open' : 'closed'}</p>
      <p>Selected Network: {selectedNetworkId}</p>
      <p>Active Chain: {activeChain}</p>
    </div>
  );
}

useAppKitTheme

The theming hook that controls the visual appearance of the modal. Use this hook when you need to customize the modal’s colors, implement dark/light mode, or match the modal’s appearance with your application’s theme.

import { useAppKitTheme } from "@reown/appkit/react";
const { themeMode, themeVariables, setThemeMode, setThemeVariables } =
  useAppKitTheme();

setThemeMode("dark");

setThemeVariables({
  "--w3m-color-mix": "#00BB7F",
  "--w3m-color-mix-strength": 40,
});

Use Cases

Implementing dark/light mode in your dApp
Customizing the modal’s appearance to match your brand
Creating theme-specific UI elements
Syncing the modal’s theme with your app’s theme

useAppKitEvents

The event subscription hook that allows you to listen to modal and wallet events. Use this hook when you need to track user interactions, implement analytics, or respond to specific wallet events in your application.

import { useAppKitEvents } from "@reown/appkit/react";

const events = useAppKitEvents();

Use Cases

Tracking user interactions with the modal
Implementing analytics for wallet connections
Creating custom notifications for connection events
Handling specific wallet events in your application

useDisconnect

The session management hook that handles wallet disconnection. Use this hook when implementing logout functionality or when you need to clean up resources after a user disconnects their wallet.

import { useDisconnect } from "@reown/appkit/react";

const { disconnect } = useDisconnect();

// Disconnect from all namespaces
await disconnect();

// Disconnect from specific namespace
await disconnect({ namespace: 'eip155' }); // Disconnect from Ethereum
await disconnect({ namespace: 'solana' }); // Disconnect from Solana  
await disconnect({ namespace: 'bip122' }); // Disconnect from Bitcoin

Parameters

namespace (optional): The specific chain namespace to disconnect from. If not provided, disconnects from all connected namespaces.

Use Cases

Implementing a “Disconnect Wallet” button
Handling logout flows in your application
Cleaning up resources when a user disconnects
Resetting application state after disconnection
Disconnecting from specific chains in multi-chain applications

useWalletInfo

The wallet information hook that provides details about the connected wallet. Use this hook when you need to display wallet-specific information, show wallet branding, or implement wallet-specific features.

import { useWalletInfo } from '@reown/appkit/react'

function WalletDisplay() {
  const { walletInfo } = useWalletInfo();
  
  return (
    <div className="wallet-info">
      {walletInfo?.name && (
        <>
          <img src={walletInfo.icon} alt={walletInfo.name} />
          <span>{walletInfo.name}</span>
        </>
      )}
    </div>
  );
}

Use Cases

Displaying wallet-specific information in your UI
Implementing wallet-specific features
Showing wallet icons or branding
Handling wallet-specific behaviors

useAppKitProvider

Hook that returns the walletProvider and the WalletProviderType for interacting with the connected wallet across different blockchain adapters.

import { useAppKitProvider } from "@reown/appkit/react";
import type { Provider } from "@reown/appkit/react";

const { walletProvider } = useAppKitProvider<Provider>("eip155");

Use Cases

Accessing the wallet provider for direct blockchain interactions
Signing transactions and messages with the connected wallet
Integrating with blockchain-specific libraries (ethers, solana web3, etc.)
Building custom wallet interactions across different chains

Adapter Examples

import { useAppKitProvider } from "@reown/appkit/react";
import type { Provider } from "@reown/appkit/react";

const { walletProvider } = useAppKitProvider<Provider>("eip155");

Related hooks: useAppKitAccount, useAppKitNetwork

Ethereum/Solana Library

useAppKitAccount

Hook that returns the client’s information.

import { useAppKitAccount } from "@reown/appkit/react";

function Components() {
  const { address, caipAddress, isConnected } = useAppKitAccount();

  //...
}

useSignMessage

Hook for signing messages with connected account.

import { useSignMessage } from "wagmi";

function App() {
  const { signMessage } = useSignMessage();

  return (
    <button onClick={() => signMessage({ message: "hello world" })}>
      Sign message
    </button>
  );
}

Fundamentals

Authentication

Early Access

Payments

Transactions

Notifications

Cloud

​Hook Ecosystem

​useAppKit

​Use Cases

​Returns

​Parameters

​useAppKitAccount

​Use Cases

​Returns

​Getting Bitcoin Public Keys

​useAppKitWallet

​Options for the connect parameter

​Use Cases

​useAppKitNetwork

​Use Cases

​Returns

​useAppKitBalance

​Use Cases

​Returns

​useAppKitState

​Use Cases

​Returns

​Example Usage

​useAppKitTheme

​Use Cases

​useAppKitEvents

​Use Cases

​useDisconnect

​Parameters

​Use Cases

​useWalletInfo

​Use Cases

​useAppKitProvider

​Use Cases

​Adapter Examples

​Ethereum/Solana Library

​useAppKitAccount

​useSignMessage

Learn More

Hook Ecosystem

useAppKit

Use Cases

Returns

Parameters

useAppKitAccount

Use Cases

Returns

Getting Bitcoin Public Keys

useAppKitWallet

Options for the connect parameter

Use Cases

useAppKitNetwork

Use Cases

Returns

useAppKitBalance

Use Cases

Returns

useAppKitState

Use Cases

Returns

Example Usage

useAppKitTheme

Use Cases

useAppKitEvents

Use Cases

useDisconnect

Parameters

Use Cases

useWalletInfo

Use Cases

useAppKitProvider

Use Cases

Adapter Examples

Ethereum/Solana Library

useAppKitAccount

useSignMessage