ConnectEmbed
ConnectEmbed component renders a UI to connect to various wallets. it renders the same UI as the ConnectWallet
component's Modal UI.
This is really useful for Implementing a "Sign in" page.
It also renders a UI to Sign in with wallet if it is enabled by setting authConfig
in ThirdwebProvider
component and loginOptional
prop is either not provided or set to false
in ConnectEmbed
component
Because of this use case, It only renders UI if either one of the following conditions are true:
-
wallet is not connected
-
wallet is connected but the user is not signed in and sign in is required
Usage
Configure supportedWallets in ThirdwebProvider
To Configure which wallets to show in the
ConnectEmbed
UI, you need to configure thesupportedWallets
prop in theThirdwebProvider
component which wraps your entire application.To display a
Recommended
tag below a wallet provider, pass in therecommended: true
property in the wallet configurator function.If
supportedWallets
is not configured in theThirdwebProvider
, the ConnectWallet Modal show the default wallets:Configure ConnectEmbed
Render the
ConnectEmbed
component anywhere in your application. Refer to Props to see the configuration options availableYou can use the
useShowConnectEmbed
hook to check if theConnectEmbed
is rendering a UI or not and render something else if it is not rendering anything. It takes an optionalloginOptional
boolean argument to specify whether the<ConnectEmbed />
you want to render has auth enabled or not. If not specified, it is assumed to befalse
( sign in is required )