Options
The following options can be passed to the createAppKit
function:
networks
Array of networks that can be chosen from the @reown/appkit/networks
library. This library retrieves the list of EVM networks from Viem and also includes the Solana networks.
For custom networks, refer to this doc page.
metadata
Metadata for your AppKit. The name
, description
, icons
, and url
are used at certain places like the wallet connection, sign message, etc screens. If not provided, they will be fetched from the metadata of your website’s document object.
For custom networks, refer to this doc page.
defaultNetwork
Desired network for the initial connection as default:
defaultAccountTypes
It allows you to configure the default account selected for the specified networks in AppKit. For example, if you want your EVM networks to use an EOA account by default, you can configure it as shown in the code below.
Here are all the options you have for each network identifier or networks. Network identifier or networks available are eip155
for EVM chains, solana
for Solana, bip122
for Bitcoin, and polkadot
for Polkadot.
featuredWalletIds
Select wallets that are going to be shown on the modal’s main view. Default wallets are MetaMask and Trust Wallet.
Array of wallet ids defined will be prioritized (order is respected).
These wallets will also show up first in All Wallets
view.
You can find the wallets IDs in Wallets List or in WalletGuide
chainImages
Add or override the modal’s network images.
connectorImages
Set or override the images of any connector. The key of each property must match the id of the connector.
Set or override the images of any connector. The key of each property must match the id of the connector.
Set or override the images of any connector.
Set or override the images of any connector.
enableWalletConnect
Enable or disable WalletConnect QR feature. Default is true
.
enableNetworkSwitch
Enables or disables the network switching functionality in the modal. The default is true
.
debug
Enable or disable debug mode in your AppKit. This is useful if you want to see UI alerts when debugging. Default is false
.
enableWalletGuide
Enable or disable the wallet guide text, is useful for people that don’t have a wallet yet. Default is true
.
termsConditionsUrl
You can add an url for the terms and conditions link.
privacyPolicyUrl
A URL for the privacy policy link.
features
Allows you to toggle (enable or disable) additional features provided by AppKit. Features such as analytics, email and social logins, On-ramp, swaps, etc., can be enabled using this parameter.
analytics
Enable analytics to get more insights on your users activity within your Reown Cloud’s dashboard
Learn More
swaps
Enable or disable the swap feature in your AppKit. Swaps feature is enabled by default.
onramp
Enable or disable the onramp feature in your AppKit. Onramp feature is enabled by default.
connectMethodsOrder
Order of the connection methods in the modal. The default order is ['wallet', 'email', 'social']
.
legalCheckbox
Enable or disable the terms of service and/or privacy policy checkbox.
customWallets
Adds custom wallets to the modal. customWallets
is an array of objects, where each object contains specific information of a custom wallet.
AllWallets
If the “All Wallets” button is removed on mobile, all the mobile wallets that were not added on the main view of the modal won’t be able to connect to your website via WalletConnect protocol.
The allWallets
parameter allows you to add or remove the “All Wallets” button on the modal.
Value | Description |
---|---|
SHOW | Shows the “All Wallets” button on AppKit. |
HIDE | Removes the “All Wallets” button from AppKit. |
ONLY_MOBILE | Shows the “All Wallets” button on AppKit only on mobile. |
includeWalletIds & excludeWalletIds
Wallets that are either not included or excluded won’t be able to connect to your website on mobile via WalletConnect protocol.
includeWalletIds
Override default recommended wallets that are fetched from WalletGuide.
Array of wallet ids defined will be shown (order is respected).
Unlike featuredWalletIds
, these wallets will be the only ones shown in All Wallets
view and as recommended wallets.
You can find the wallets IDs in our Wallets List.
excludeWalletIds
Exclude wallets that are fetched from WalletGuide. Array of wallet ids defined will be excluded. All other wallets will be shown in respective places. You can find the wallets IDs in our Wallets List.
Coinbase Smart Wallet
The Coinbase connector now includes a new flag to customize the Smart Wallet behavior.
To enable the Coinbase Smart Wallet feature, ensure that AppKit is updated to version 4.2.3 or higher. Additionally, if you are using Wagmi, verify that it is on the latest version.
The preference
(or coinbasePreference
) flag accepts one of the following string values:
eoaOnly
: Uses EOA Browser Extension or Mobile Coinbase Wallet.smartWalletOnly
: Displays Smart Wallet popup.all
(default): Supports botheoaOnly
andsmartWalletOnly
based on context.
AppKit can be configured in two different ways: Default or Custom
Select your preferred configuration mode below:
Learn more about the Coinbase connector in the Wagmi documentation.
AppKit can be configured in two different ways: Default or Custom
Select your preferred configuration mode below:
Learn more about the Coinbase connector in the Wagmi documentation.
customRpcUrls
This function allows you to add custom RPC URLs to override the default network RPC URLs for native RPC calls. This is useful when you want to use your own RPC endpoints instead of the defaults.
If you are using the Wagmi adapter, you need to pass the same customRpcUrls
configuration to both the WagmiAdapter
and createAppKit
.
When using the Wagmi adapter, you don’t need to configure transports
separately. The WagmiAdapter will automatically configure them based on your customRpcUrls
.
However, if you use both customRpcUrls
and Wagmi’s transports
property, be aware that transports
will take precedence and override any conflicting RPC URLs defined in customRpcUrls
.
universalProviderConfigOverride
Lets you customize specific aspects of the provider’s behavior.
You can override any of the following properties:
methods
: Custom RPC methods for each namespacechains
: Supported chains for each namespaceevents
: Events to subscribe to for each namespacerpcMap
: Custom RPC URLs for specific chainsdefaultChain
: The default chain to connect to
Was this page helpful?