Hooks

useWeb3Modal

Control the modal with the useWeb3Modal hook

Wagmi v1

import { useWeb3Modal } from '@web3modal/wagmi/react'

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

  open()

  //...
}

Wagmi v2

import { useWeb3Modal } from '@web3modal/wagmi/react'

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

  open()

  //...
}

Ethers

import { useWeb3Modal } from '@web3modal/ethers5/react'

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

  open()

  //...
}

Ethers v5

import { useWeb3Modal } from '@web3modal/ethers/react'

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

  open()

  //...
}

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

open({ view: 'Account' })

List of views you can select

Variable	Description
Connect	Principal view of the modal - default view when disconnected
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

useDisconnect

Disconnect currently connected account.

const { disconnect } = useDisconnect()

disconnect()

useWeb3ModalState

Get the current value of the modal's state

Wagmi v1

import { useWeb3ModalState } from '@web3modal/wagmi/react'

const { open, selectedNetworkId } = useWeb3ModalState()

Wagmi v2

import { useWeb3ModalState } from '@web3modal/wagmi/react'

const { open, selectedNetworkId } = useWeb3ModalState()

Ethers

import { useWeb3ModalState } from '@web3modal/ethers5/react'

const { open, selectedNetworkId } = useWeb3ModalState()

Ethers v5

import { useWeb3ModalState } from '@web3modal/ethers/react'

const { open, selectedNetworkId } = useWeb3ModalState()

The modal state consists of two reactive values:

State	Description	Type
open	Open state will be true when the modal is open and false when closed.	boolean
selectedNetworkId	The current chain id selected by the user	number

useWeb3ModalTheme

const { themeMode, themeVariables, setThemeMode, setThemeVariables } = useWeb3ModalTheme()

setThemeMode('dark')

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

Track modal events

import { useWeb3ModalEvents } from '@web3modal/wagmi/react'

const events = useWeb3ModalEvents()

Ethereum Library

Wagmi v1

You can use Wagmi hooks to sign messages, interact with smart contracts, and much more.

useAccount

Hook for accessing account data and connection status.

import { useAccount } from 'wagmi'

function App() {
  const { address, isConnecting, isDisconnected } = useAccount()

  if (isConnecting) return <div>Connecting…</div>
  if (isDisconnected) return <div>Disconnected</div>
  return <div>{address}</div>
}

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>
}

Learn More

Wagmi v2

You can use Wagmi hooks to sign messages, interact with smart contracts, and much more.

useAccount

Hook for accessing account data and connection status.

import { useAccount } from 'wagmi'

function App() {
  const { address, isConnecting, isDisconnected } = useAccount()

  if (isConnecting) return <div>Connecting…</div>
  if (isDisconnected) return <div>Disconnected</div>
  return <div>{address}</div>
}

useSignMessage

Hook for signing messages with connected account.

import { useSignMessage } from 'wagmi'

function App() {
  const { data, isError, isLoading, isSuccess, signMessage } = useSignMessage({
    message: 'gm wagmi frens'
  })

  return (
    <div>
      <button disabled={isLoading} onClick={() => signMessage()}>
        Sign message
      </button>
      {isSuccess && <div>Signature: {data}</div>}
      {isError && <div>Error signing message</div>}
    </div>
  )
}

Learn More

Build Web3 Front-Ends with Wagmi v1

Ethers

useWeb3ModalAccount

Hook that returns the client's information.

import { useWeb3ModalAccount } from '@web3modal/ethers5/react'

function Components() {
  const { address, chainId, isConnected } = useWeb3ModalAccount()

  //...
}

useWeb3ModalProvider

Hook that returns the walletProvider and the WalletProviderType.

import { ethers } from 'ethers'
import { useWeb3ModalProvider } from '@web3modal/ethers5/react'

function Components() {
  const { walletProvider } = useWeb3ModalProvider()

  async function onSignMessage() {
    const provider = new ethers.providers.Web3Provider(walletProvider)
    const signer = provider.getSigner()
    const signature = await signer?.signMessage('Hello Web3Modal Ethers')
    console.log(signature)
  }

  return <button onClick={() => onSignMessage()}>Sign Message</button>
}

useWeb3ModalError

import { useWeb3ModalError } from '@web3modal/ethers/react'

function Components() {
  const { error } = useWeb3ModalError()

  //...
}

Learn More About Ethers

Ethers v5

useWeb3ModalAccount

Hook that returns the client's information.

import { useWeb3ModalAccount } from '@web3modal/ethers/react'

function Components() {
  const { address, chainId, isConnected } = useWeb3ModalAccount()

  //...
}

useWeb3ModalProvider

Hook that returns the walletProvider and the WalletProviderType.

import { BrowserProvider } from 'ethers'
import { useWeb3ModalProvider } from '@web3modal/ethers/react'

function Components() {
  const { walletProvider } = useWeb3ModalProvider()

  async function onSignMessage() {
    const provider = new BrowserProvider(walletProvider)
    const signer = await provider.getSigner()
    const signature = await signer?.signMessage('Hello Web3Modal Ethers')
    console.log(signature)
  }

  return <button onClick={() => onSignMessage()}>Sign Message</button>
}

useWeb3ModalError

import { useWeb3ModalError } from '@web3modal/ethers/react'

function Components() {
  const { error } = useWeb3ModalError()

  //...
}

Learn More About Ethers