Skip to main content

useSwap

Hook to open the Swap interface using the Wallet Services Plugin.

Import

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

Usage

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

function SwapButton() {
const { showSwap, loading, error } = useSwap()

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

Return Type

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

loading

boolean

Whether the swap interface is being opened.

error

Web3AuthError | null

Error that occurred while opening the swap interface.

showSwap

(showSwapParams?: BaseEmbedControllerState["showSwap"]) => Promise<void>

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