Actions

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

Open and close the modal

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 view
appKit.open({ view: "Connect" });

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

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

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

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

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.

Disconnect

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

WalletInfo

Metadata information from the connected wallet

function handler({ name, icon }) {
  console.log(name, icon);
}

appKit.subscribeWalletInfo(handler);

//or

const { name, icon } = appKit.getWalletInfo();

Svelte Store Integration

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

// lib/stores/appkit.ts
import { 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 the top 20 wallets, 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:

1. Install the package:

npm

npm install @reown/appkit-wallet-button

2. 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>

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

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, and more
Social logins	google, github, apple, facebook, x, discord, and farcaster

Ethereum Library

Wagmi

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.

Modal State

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();

Subscribe to theme changes

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

Track modal events

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