@lifi/widget
v3.13.1
Published
LI.FI Widget for cross-chain bridging and swapping. It will drive your multi-chain strategy and attract new users from everywhere.
Downloads
20,170
Maintainers
Readme
LI.FI Widget is a set of prebuilt UI components that will help you integrate a secure cross-chain bridging and swapping experience that can be styled to match your web app design perfectly and helps drive your multi-chain strategy and attract new users from everywhere.
LI.FI Widget features include:
- All ecosystems, chains, bridges, exchanges, and solvers that LI.FI supports
- Embeddable variants - compact, wide, and drawer
- Options to allow or deny certain chains, tokens, bridges, and exchanges
- Pre-configured themes and lots of customization options with dark mode support so you can match the look and feel of your web app
- Wallet management UI with the option to opt-out and use your own (Wagmi and Solana Wallet Standard support)
- View of transactions in progress and transaction history
- Curated wallet lists and wallet bookmarks
- Route settings for advanced users (stored locally)
- Complete UI translations to match your customer’s preferred language
- Compatibility tested with React, Next.js, Vue, Nuxt.js, Svelte, Remix, Gatsby, Vite, CRA, RainbowKit
Installation
LI.FI Widget
LI.FI Widget is available as an npm package.
pnpm:
pnpm add @lifi/widget
npm:
npm install @lifi/widget
yarn:
yarn add @lifi/widget
LI.FI Wallet Management
LI.FI Wallet Management is available as an npm package.
pnpm:
pnpm add @lifi/wallet-management
npm:
npm install @lifi/wallet-management
yarn:
yarn add @lifi/wallet-management
Getting started with LI.FI Widget
Here is an example of a basic app using LI.FI Widget:
import { LiFiWidget, WidgetConfig } from '@lifi/widget';
const widgetConfig: WidgetConfig = {
theme: {
container: {
border: '1px solid rgb(234, 234, 234)',
borderRadius: '16px',
},
},
};
export const WidgetPage = () => {
return (
<LiFiWidget integrator="Your dApp/company name" config={widgetConfig} />
);
};
Examples
Visit our playground to see how you can customize your LI.FI Widget experience. Additionally, see examples folder in this repository.
Documentation
Please visit LI.FI Widget Documentation.
Contributing Translations
We appreciate your interest in helping translate our project!
If you'd like to contribute translations, please visit our Crowdin project page at Crowdin LI.FI Widget. Register on Crowdin and you can start translating the project into your preferred language. Your contributions will help make our project accessible to a wider audience around the world.
Thank you for your support!
Changelog
The changelog is regularly updated to reflect what's changed in each new release.
License
This project is licensed under the terms of the Apache-2.0.