> ## Documentation Index
> Fetch the complete documentation index at: https://docs.li.fi/llms.txt
> Use this file to discover all available pages before exploring further.

# 组件 API 参考

> 组件和钩子的 API 文档。

## 组件

`LiFiWidget` 组件配置的属性和类型。

## 核心配置

| 名称           | 类型       | 默认值    | 示例           | 描述                            |
| ------------ | -------- | ------ | ------------ | ----------------------------- |
| `apiKey`     | `string` | –      | `integrator` | API 认证密钥                      |
| `integrator` | `string` | –      | `OpenSea`    | 集成商标识符（dApp/公司）               |
| `referrer`   | `string` | –      | –            | 推荐人标识符                        |
| `fee`        | `number` | `0.05` | –            | 0 到 1 之间的浮点数（例如 0.1 = 10% 费用） |

***

## 交换详情

| 名称                    | 类型          | 默认值     | 示例               | 描述        |
| --------------------- | ----------- | ------- | ---------------- | --------- |
| `fromChain`           | `number`    | –       | `42161`          | 源链 ID     |
| `fromToken`           | `string`    | –       | `0x539b...0342`  | 代币合约地址（源） |
| `fromAmount`          | `number`    | `0`     | `69.42`          | 要交换的代币数量  |
| `toChain`             | `number`    | `1`     | `137`            | 目标链 ID    |
| `toToken`             | `string`    | –       | `0xd6df...1c90b` | 目标代币合约地址  |
| `toAddress`           | `ToAddress` | –       | `0x2b56...1401`  | 目标钱包地址    |
| `slippage`            | `number`    | `0.005` | –                | 默认滑点设置    |
| `useRecommendedRoute` | `boolean`   | `false` | `true`           | 仅显示推荐路由   |

***

## 路由和过滤选项

| 名称              | 类型                                                 | 默认值          | 示例 | 描述       |
| --------------- | -------------------------------------------------- | ------------ | -- | -------- |
| `routePriority` | `'CHEAPEST' \| 'FASTEST'`                          | `'CHEAPEST'` | –  | 路由选择优先级  |
| `chains`        | `{ allow?: number[]; deny?: number[] }`            | –            | –  | 允许或拒绝的链  |
| `tokens`        | `{ featured?, include?, popular?, allow?, deny? }` | –            | –  | 代币过滤和优先级 |
| `bridges`       | `{ allow?: string[]; deny?: string[] }`            | –            | –  | 桥接器控制列表  |
| `exchanges`     | `{ allow?: string[]; deny?: string[] }`            | –            | –  | 交易所控制列表  |

***

## UI 外观和行为

| 名称                  | 类型                                             | 默认值         | 示例                            | 描述          |
| ------------------- | ---------------------------------------------- | ----------- | ----------------------------- | ----------- |
| `variant`           | `'compact' \| 'wide' \| 'drawer'`              | `'compact'` | –                             | 组件布局样式      |
| `subvariant`        | `'default' \| 'split' \| 'refuel' \| 'custom'` | `'default'` | –                             | 额外布局自定义     |
| `appearance`        | `'light' \| 'dark' \| 'auto'`                  | `'auto'`    | `'dark'`                      | 主题模式        |
| `disabledUI`        | `DisabledUIType[]`                             | –           | `['fromAmount', 'toAddress']` | 要禁用的 UI 部分  |
| `hiddenUI`          | `HiddenUIType[]`                               | –           | `['appearance', 'language']`  | 要隐藏的 UI 部分  |
| `requiredUI`        | `RequiredUIType[]`                             | –           | `['toAddress']`               | 必需的 UI 字段   |
| `theme`             | `ThemeConfig`                                  | –           | –                             | 主题调色板和排版    |
| `languages`         | `{ default?, allow?, deny? }`                  | –           | –                             | 语言偏好        |
| `languageResources` | `LanguageResources`                            | –           | –                             | 自定义 i18n 翻译 |

***

## 集成钩子和状态

| 名称             | 类型                                                                 | 默认值     | 示例 | 描述             |
| -------------- | ------------------------------------------------------------------ | ------- | -- | -------------- |
| `walletConfig` | `WidgetWalletConfig`                                               | –       | –  | 管理钱包状态的选项      |
| `sdkConfig`    | `WidgetSDKConfig`                                                  | –       | –  | SDK 特定配置       |
| `formRef`      | `MutableRefObject<FormState \| null>`                              | –       | –  | 程序化表单更新的访问     |
| `buildUrl`     | `boolean`                                                          | `false` | –  | 将组件配置附加到页面 URL |
| `explorerUrls` | `Record<number, string[]> & Partial<Record<'internal', string[]>>` | –       | –  | 自定义区块浏览器链接     |