Composables are functions that will help you control the modal, subscribe to wallet events and interact with them and smart contracts.
Composable function for controlling the modal.
open
: Function to open the modalclose
: Function to close the modalYou can also select the modal’s view when calling the open
function
List of views you can select
Composable function for accessing account data and connection status.
Composable function for accessing account data and connection status for each namespace when working in a multi-chain environment.
accountData.value.address
: The current account addressaccountData.value.caipAddress
: The current account address in CAIP formataccountData.value.isConnected
: Boolean that indicates if the user is connectedaccountData.value.status
: The current connection statusWhen working with Bitcoin accounts, you can extract public keys from the connected accounts:
This is particularly useful when you need to access Bitcoin public keys for transaction signing or address derivation.
Composable function for accessing network data and methods.
networkData.caipNetwork
: The current network objectnetworkData.caipNetworkId
: The current network id in CAIP formatnetworkData.chainId
: The current chain idnetworkData.switchNetwork
: Function to switch the network. Accepts a caipNetwork
object as argument.See how to import or create a networks here.
Composable function for getting the current value of the modal’s state.
stateData.initialized
: Boolean that indicates if AppKit has been initialized. This sets to true when all controllers, adapters and internal state is readystateData.loading
: Boolean that indicates if AppKit is loadingstateData.open
: Boolean that indicates if the modal is openstateData.selectedNetworkId
: The current chain id selected by the user in CAIP-2 formatstateData.activeChain
: The active chain namespace (e.g., ‘eip155’, ‘solana’, ‘bip122’)Composable function for controlling the modal’s theme.
themeAction.themeMode
: Get theme Mode.themeAction.themeVariables
: Get theme variables.themeAction.setThemeMode
: Set theme Mode. Accepts a string as parameter (‘dark’ | ‘light’)themeAction.setThemeVariables
: Set theme variables. Check the example usage.Composable function for subscribing to modal events.
events.timestamp
: Get the timestamp of the eventevents.data.event
: Get string of the event.events.data.properties
: get more information from the event.Composable function for disconnecting the session.
namespace
(optional): The specific chain namespace to disconnect from. If not provided, disconnects from all connected namespaces.Composable function for accessing wallet information.
Composable function that returns the walletProvider
and the WalletProviderType
for interacting with the connected wallet across different blockchain adapters.
walletProvider
: The wallet provider instance for the specified chain namespacewalletProviderType
: The type of wallet provider currently connectedYou can use Wagmi actions to sign messages, interact with smart contracts, and much more.
Action for accessing account data and connection status.
Action for signing messages with connected account.
Hook that returns the walletProvider
and the WalletProviderType
.
You can use Wagmi actions to sign messages, interact with smart contracts, and much more.
Action for accessing account data and connection status.
Action for signing messages with connected account.
Hook that returns the walletProvider
and the WalletProviderType
.
Hook that returns the client’s information.
Hook that returns the walletProvider
and the WalletProviderType
.
Hook that returns the client’s information.
Hook that returns the walletProvider
and the WalletProviderType
.
Hook that returns the client’s information.
Hook that returns the walletProvider
and the WalletProviderType
.
Hook that returns the connection object. More info about Connection Class
Hook that returns the client’s information.
Hook that returns the walletProvider
and the WalletProviderType
.
Composables are functions that will help you control the modal, subscribe to wallet events and interact with them and smart contracts.
Composable function for controlling the modal.
open
: Function to open the modalclose
: Function to close the modalYou can also select the modal’s view when calling the open
function
List of views you can select
Composable function for accessing account data and connection status.
Composable function for accessing account data and connection status for each namespace when working in a multi-chain environment.
accountData.value.address
: The current account addressaccountData.value.caipAddress
: The current account address in CAIP formataccountData.value.isConnected
: Boolean that indicates if the user is connectedaccountData.value.status
: The current connection statusWhen working with Bitcoin accounts, you can extract public keys from the connected accounts:
This is particularly useful when you need to access Bitcoin public keys for transaction signing or address derivation.
Composable function for accessing network data and methods.
networkData.caipNetwork
: The current network objectnetworkData.caipNetworkId
: The current network id in CAIP formatnetworkData.chainId
: The current chain idnetworkData.switchNetwork
: Function to switch the network. Accepts a caipNetwork
object as argument.See how to import or create a networks here.
Composable function for getting the current value of the modal’s state.
stateData.initialized
: Boolean that indicates if AppKit has been initialized. This sets to true when all controllers, adapters and internal state is readystateData.loading
: Boolean that indicates if AppKit is loadingstateData.open
: Boolean that indicates if the modal is openstateData.selectedNetworkId
: The current chain id selected by the user in CAIP-2 formatstateData.activeChain
: The active chain namespace (e.g., ‘eip155’, ‘solana’, ‘bip122’)Composable function for controlling the modal’s theme.
themeAction.themeMode
: Get theme Mode.themeAction.themeVariables
: Get theme variables.themeAction.setThemeMode
: Set theme Mode. Accepts a string as parameter (‘dark’ | ‘light’)themeAction.setThemeVariables
: Set theme variables. Check the example usage.Composable function for subscribing to modal events.
events.timestamp
: Get the timestamp of the eventevents.data.event
: Get string of the event.events.data.properties
: get more information from the event.Composable function for disconnecting the session.
namespace
(optional): The specific chain namespace to disconnect from. If not provided, disconnects from all connected namespaces.Composable function for accessing wallet information.
Composable function that returns the walletProvider
and the WalletProviderType
for interacting with the connected wallet across different blockchain adapters.
walletProvider
: The wallet provider instance for the specified chain namespacewalletProviderType
: The type of wallet provider currently connectedYou can use Wagmi actions to sign messages, interact with smart contracts, and much more.
Action for accessing account data and connection status.
Action for signing messages with connected account.
Hook that returns the walletProvider
and the WalletProviderType
.
You can use Wagmi actions to sign messages, interact with smart contracts, and much more.
Action for accessing account data and connection status.
Action for signing messages with connected account.
Hook that returns the walletProvider
and the WalletProviderType
.
Hook that returns the client’s information.
Hook that returns the walletProvider
and the WalletProviderType
.
Hook that returns the client’s information.
Hook that returns the walletProvider
and the WalletProviderType
.
Hook that returns the client’s information.
Hook that returns the walletProvider
and the WalletProviderType
.
Hook that returns the connection object. More info about Connection Class
Hook that returns the client’s information.
Hook that returns the walletProvider
and the WalletProviderType
.