For AI agents: a documentation index is available at /llms.txt. A markdown version of this page is available at the same URL with .md appended (or via Accept: text/markdown).
Skip to main content

useReceive

Hook to open the receive interface using the Wallet Services plugin.

info

Please note that this hook doesn't work for external wallet logins. It only works for social login embedded wallets.

Import​

import { useReceive } from '@web3auth/modal/react'

Usage​

import { useReceive } from '@web3auth/modal/react'

function ReceiveButton() {
  const { showReceive, loading, error } = useReceive()

  return (
    <div>
      <button onClick={() => showReceive()} disabled={loading}>
        {loading ? 'Opening...' : 'Open Receive'}
      </button>
      {error && <div>Error: {error.message}</div>}
    </div>
  )
}

Return type​

import { type IUseReceive } from '@web3auth/modal/react'

loading​

boolean

Whether the receive interface is being opened.

error​

Web3AuthError | null

Error that occurred while opening the receive interface.

showReceive​

(showReceiveParams?: BaseEmbedControllerState["showReceive"]) => Promise<void>

Function to open the receive interface. Accepts optional parameters for customizing the view.

On this page