Skip to main content

WalletProviderProps

@iota/dapp-kit

@iota/dapp-kit / WalletProviderProps

Type Alias: WalletProviderProps

WalletProviderProps = object

Defined in: sdk/dapp-kit/src/components/WalletProvider.tsx:29

Properties​

autoConnect?​

optional autoConnect?: boolean

Defined in: sdk/dapp-kit/src/components/WalletProvider.tsx:40

Enables automatically reconnecting to the most recently used wallet account upon mounting.

chain?​

optional chain?: ChainType

Defined in: sdk/dapp-kit/src/components/WalletProvider.tsx:51

children​

children: ReactNode

Defined in: sdk/dapp-kit/src/components/WalletProvider.tsx:53

enableUnsafeBurner?​

optional enableUnsafeBurner?: boolean

Defined in: sdk/dapp-kit/src/components/WalletProvider.tsx:37

Enables the development-only unsafe burner wallet, which can be useful for testing.

preferredWallets?​

optional preferredWallets?: string[]

Defined in: sdk/dapp-kit/src/components/WalletProvider.tsx:31

A list of wallets that are sorted to the top of the wallet list, if they are available to connect to. By default, wallets are sorted by the order they are loaded in.

storage?​

optional storage?: StateStorage | null

Defined in: sdk/dapp-kit/src/components/WalletProvider.tsx:43

Configures how the most recently connected to wallet account is stored. Set to null to disable persisting state entirely. Defaults to using localStorage if it is available.

storageKey?​

optional storageKey?: string

Defined in: sdk/dapp-kit/src/components/WalletProvider.tsx:46

The key to use to store the most recently connected wallet account.

theme?​

optional theme?: Theme | null

Defined in: sdk/dapp-kit/src/components/WalletProvider.tsx:49

The theme to use for styling UI components. Defaults to using the light theme.

walletFilter?​

optional walletFilter?: (wallet) => boolean

Defined in: sdk/dapp-kit/src/components/WalletProvider.tsx:34

A filter function to select wallets that support features required for the dApp to function. This filters the list of wallets presented to users when selecting a wallet to connect from, ensuring that only wallets that meet the dApps requirements can connect.

Parameters​

wallet​

WalletWithRequiredFeatures

Returns​

boolean