Widget V2 Migration Guide
This guide provides a concise overview of the changes needed to migrate your existing Widget V1 implementation to Widget V2.
1. Update Dependency (latest
or ^3.0.0
)
If you’re using yarn
(or another package manager that doesn’t install peer dependencies by default)
you may need to install these peer dependencies as well:
2. theme
Prop Changes
More Customization Options
You can pass either light
, dark
, or a custom theme object with granular
control over the widget’s appearance.
Before:
After:
The custom theme object has the following structure:
3. Prop Spelling Changes
chainID
Renamed to chainId
apiURL
Renamed to apiUrl
Update all instances of chainID
to chainId
, notably in the defaultRoute
prop.
Before:
After:
4. Temporarily Disabled Features
The following props will be reintroduced in future versions of Widget
.
a. connectedWallet
Prop
The connectedWallet prop, which allowed passing a custom wallet provider, isn’t currently supported.
b. CallbackStore
Callback Props
The onWalletConnected
, onWalletDisconnected
, onTransactionBroadcasted
, onTransactionComplete
, and onTransactionFailed
callback props aren’t currently supported.
5. Removed Features
a. persistWidgetState
This prop is no longer supported, as the Widget
persists state by default.
b. toasterProps
The toasterProps
prop has been removed because the Widget
no longer generates notifications.
c. makeDestinationWallets
The makeDestinationWallets
prop has been removed. The Widget
now automatically generates destination wallets from connected wallets or manual user entry.
By implementing these changes, you can successfully migrate your application from Widget V1 to Widget V2. For further assistance, refer to the official documentation or reach out to the support team.