Actions - Reown Docs

Actions are functions that will help you control the modal, subscribe to wallet events and interact with them and smart contracts.

import { createAppKit } from '@reown/appkit'import { WagmiAdapter } from '@reown/appkit-adapter-wagmi'import { arbitrum, mainnet } from '@reown/appkit/networks'const wagmiAdapter = new WagmiAdapter({  networks: [mainnet, arbitrum],  projectId})const appKit = createAppKit({  adapters: [wagmiAdapter],  networks: [mainnet, arbitrum],  projectId,});appKit.open();appKit.close();

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

appKit.open({ view: "Account" });// to connect and show multi wallets viewappKit.open({ view: "Connect" });// to connect and show only solana walletsappKit.open({ view: "Connect", namespace: "solana" });// to connect and show only bitcoin walletsappKit.open({ view: "Connect", namespace: "bip122" });// to connect and show only ethereum walletsappKit.open({ view: "Connect", namespace: "eip155" });// to open swap with argumentsappKit.open({  view: 'Swap',  arguments: {    amount: '321.123',    fromToken: 'USDC',    toToken: 'ETH'  }})// to open wallet send interfaceappKit.open({ view: 'WalletSend' })

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.
`WalletSend`	Token sending interface that allows users to send tokens to another address.
`Swap`	Swap main view.
`ProfileWallets`	View for managing connected wallets in the user profile.

Disconnect#

appKit.adapter?.connectionControllerClient?.disconnect();

WalletInfo#

Metadata information from the connected wallet

function handler({ name, icon }) {  console.log(name, icon);}appKit.subscribeWalletInfo(handler);//orconst { name, icon } = appKit.getWalletInfo();

Svelte Store Integration#

You can use Svelte stores to manage AppKit state across your application:

// lib/stores/appkit.tsimport { writable } from 'svelte/store';import { browser } from '$app/environment';let appKit: ReturnType<typeof createAppKit> | undefined = undefined;if (browser) {  // Initialize AppKit only in browser environment  appKit = createAppKit({    adapters: [wagmiAdapter],    networks: [mainnet, arbitrum],    projectId,  });}export const appKitStore = writable(appKit);

Wallet Buttons#

Using the wallet button functions (Demo in our Lab), you can directly connect to more than 40 of the top wallets globally, WalletConnect QR, and all the social logins. This allows to customize dApps, enabling users to connect their wallets effortlessly, all without the need to open the traditional modal.

Follow these steps to use wallet buttons:

Install the package:

npm install @reown/appkit-wallet-button

Import and use in your Svelte project:

<script type="module">  import { createAppKitWalletButton } from '@reown/appkit-wallet-button';  const wb = createAppKitWalletButton();  function connectWallet(id) {    if (wb.isReady()) {      wb.connect(id);    }  }  // Attach it to the global scope so it can be called from inline HTML  window.connectWallet = connectWallet;</script><button onclick="connectWallet('walletConnect')">Open QR modal</button><button onclick="connectWallet('metamask')">Connect to MetaMask</button><button onclick="connectWallet('google')">Connect to Google</button>

Note

Make sure to call wallet button methods after createAppKit has been initialized.

Multichain Support#

You can specify a blockchain namespace to target specific chains:

<script type="module">  import { createAppKitWalletButton } from '@reown/appkit-wallet-button';    // Create wallet buttons for different namespaces  const evmWalletButton = createAppKitWalletButton({ namespace: 'eip155' });  const solanaWalletButton = createAppKitWalletButton({ namespace: 'solana' });  const bitcoinWalletButton = createAppKitWalletButton({ namespace: 'bip122' });  function connectEVMWallet(id) {    if (evmWalletButton.isReady()) {      evmWalletButton.connect(id);    }  }  function connectSolanaWallet(id) {    if (solanaWalletButton.isReady()) {      solanaWalletButton.connect(id);    }  }  function connectBitcoinWallet(id) {    if (bitcoinWalletButton.isReady()) {      bitcoinWalletButton.connect(id);    }  }  // Attach to global scope  window.connectEVMWallet = connectEVMWallet;  window.connectSolanaWallet = connectSolanaWallet;  window.connectBitcoinWallet = connectBitcoinWallet;</script><!-- Connect to Ethereum/EVM chains --><button onclick="connectEVMWallet('metamask')">Connect MetaMask (EVM)</button><!-- Connect to Solana --><button onclick="connectSolanaWallet('phantom')">Connect Phantom (Solana)</button><!-- Connect to Bitcoin --><button onclick="connectBitcoinWallet('leather')">Connect Leather (Bitcoin)</button>

Options for wallet property#

Type	Options
QR Code	`walletConnect`
Wallets	`metamask`, `trust`, `coinbase`, `rainbow`, `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`, `tokenpocket`, `haha`, `ambire-wallet`, `bitpay`, `blade-wallet`, `brave`, `coinstats`, `kresus-superapp`, `plena-app`, `status`, `tomo-wallet`, `valora`, and `zengo-wallet`
Social logins	`google`, `github`, `apple`, `facebook`, `x`, `discord`, and `farcaster`

Options for namespace property#

Value	Description
`eip155`	Ethereum and EVM-compatible chains
`solana`	Solana blockchain
`bip122`	Bitcoin blockchain

Ethereum Library#

You can use Wagmi actions to interact with wallets and smart contracts:

import { readContract } from '@wagmi/core'import { USDTAbi } from '../abi/USDTAbi'const USDTAddress = '0x...'const data = readContract(wagmiConfig, {  address: USDTAddress,  abi: USDTAbi,  functionName: 'totalSupply',  args: []})

Read more about Wagmi actions for smart contract interaction here.

Ethers can help us interact with wallets and smart contracts:

import { BrowserProvider, Contract, parseEther } from 'ethers'const provider = await appKit.subscribeProviders((state) => {  return state['eip155']})const addressFrom = await appKit.subscribeAccount((state) => {  return state})if (!provider) throw Error('No provider found')if (!addressFrom) throw Error('No address found')function sendTransaction() {  const tx = {    from: addressFrom,    to: '0x...', // any address    value: parseEther('0.0001')  }  const ethersProvider = new BrowserProvider(provider)  const signer = await ethersProvider.getSigner()  const tx = await signer.sendTransaction(tx)  console.log('transaction:', tx)}

Get the current value of the modal's state

const appKit = createAppKit({  adapters: [wagmiAdapter],  networks: [mainnet, arbitrum],  projectId,});const { open, selectedNetworkId } = appKit.getState();

The modal state is an object of two properties:

Property	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`

You can also subscribe to the modal's state changes.

const appKit = createAppKit({ wagmiConfig, projectId });appKit.subscribeState((newState) => console.log(newState));

ThemeMode#

Set the themeMode after creating the modal

const appKit = createAppKit({ wagmiConfig, projectId });appKit.setThemeMode("dark");

Get the current themeMode value by calling the getThemeMode function

const appKit = createAppKit({ wagmiConfig, projectId });const themeMode = appKit.getThemeMode();

themeVariables#

Set the themeVariables after creating the modal

const appKit = createAppKit({ wagmiConfig, projectId })appKit.setThemeVariables({ ... })

Get the current themeVariables value by calling the getThemeVariables function

const appKit = createAppKit({ wagmiConfig, projectId });const themeMode = appKit.getThemeVariables();

const unsubscribe = appKit.subscribeTheme((newTheme) => console.log(newTheme));

appKit.getEvent(); // get last eventappKit.subscribeEvents((event) => console.log(event)); // subscribe to events

Open and close the modal#

Disconnect#

WalletInfo#

Svelte Store Integration#

Wallet Buttons#

Multichain Support#

Options for wallet property#

Options for namespace property#

Ethereum Library#

Modal State#

ThemeMode#

themeVariables#

Subscribe to theme changes#

Track modal events#