Skip to content

Commit

Permalink
docs: modify APIs from connector (#498)
Browse files Browse the repository at this point in the history
* feat: fix message prompts

* feat: modify translate content

* feat: specification changesetlog

* feat: revert code

* feat: modify Copied  Capitalization

* docs: Delete Unreferenced APIs from connector

* modify api explain

* docs: modify Unreferenced APIs from connector

* Delete .changeset/chilled-bulldogs-appear.md

---------

Co-authored-by: thinkasany <[email protected]>
  • Loading branch information
shanchuan1 and thinkasany authored Jan 17, 2024
1 parent 6d3fed2 commit 501e477
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion packages/web3/src/connect-button/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The button to connect to the blockchain wallet. Usually, you need to use it with
| avatar | Config avatar, used to display user avatar in profile modal | [AvatarProps](https://ant.design/components/avatar-cn#api) | - | - |
| onMenuItemClick | Menu item click event | `(e: NonNullable<MenuProps['items']>[number]) => void` | - | - |
| balance | Balance | [Balance](#balance) | - | - |
| availableChains | Available chains | [Chain](../types/index.md#chain)\[] | - | - |
| availableChains | List of available chains | [Chain](../types/index.md#chain)\[] | - | - |
| locale | Multilingual settings | `Locale["ConnectButton"]` | - | - |

### Balance
Expand Down
2 changes: 1 addition & 1 deletion packages/web3/src/connect-button/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ order: 1
| avatar | 配置头像,用于在个人信息弹框中展示用户头像 | [AvatarProps](https://ant.design/components/avatar-cn#api) | - | - |
| onMenuItemClick | 菜单项点击事件 | `(e: NonNullable<MenuProps['items']>[number]) => void` | - | - |
| balance | 余额 | [Balance](#balance) | - | - |
| availableChains | 可用的链 | [Chain](../types/index.zh-CN.md#chain)\[] | - | - |
| availableChains | 可以连接的链列表 | [Chain](../types/index.zh-CN.md#chain)\[] | - | - |
| locale | 多语言文案设置 | `Locale["ConnectButton"]` | - | - |

### Balance
Expand Down
6 changes: 3 additions & 3 deletions packages/web3/src/connector/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ In addition, `Connector` is usually used with [adapter](../../guide/adapter). Th
| onChainSwitched | Callback when switching networks. | `(chain: Chain) => Promise<viod>` | - | - |
| availableWallets | Available aallet list | `Wallet[]` | - | - |
| account | Current connected account | `Account` | - | - |
| availableChains | Available select chains list | `Chain[]` | - | - |
| availableChains | List of available chains | `Chain[]` | - | - |
| connect | Method to request the account list | `() => Promise<void>` | - | - |
| disconnect | Method to disconnect | `() => Promise<viod>` | - | - |
| switchChain | Method to switch networks | `(chain: Chain) => Promise<viod>` | - | - |
Expand All @@ -54,6 +54,6 @@ The properties of the `children` component of `Connector` are inherited and util
| onConnectClick | Connection event | `() => void;` | - | - |
| onDisconnectClick | Disconnection event | `() => void;` | - | - |
| onSwitchChain | Network switch event | `(chain: Chain) => Promise<viod>` | - | - |
| connected | Is Connected | `boolean` | - | - |
| chains | List of networks currently connected | `ChainSelectItem[]` | - | - |
| balance | Balance of the currently connected account | `Balance[]` \| `Balance` | - | - |
| availableChains | List of available chains | `Chain[]` | - | - |
| chain | Current chain | [Chain](/components/types#chain) | - | |
4 changes: 2 additions & 2 deletions packages/web3/src/connector/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,6 @@ order: 0
| onConnectClick | 连接事件 | `() => void;` | - | - |
| onDisconnectClick | 断开连接事件 | `() => void;` | - | - |
| onSwitchChain | 切换网络事件 | `(chain: Chain) => Promise<viod>` | - | - |
| connected | 是否已连接 | `boolean` | - | - |
| chains | 当前连接的网络列表 | `ChainSelectItem[]` | - | - |
| balance | 当前连接的账户余额 | `Balance[]` \| `Balance` | - | - |
| availableChains | 可以连接的链列表 | `Chain[]` | - | - |
| chain | 当前连接的链 | [Chain](/components/types#chain) | - | |
2 changes: 1 addition & 1 deletion packages/web3/src/types/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ order: 3
| --- | --- | --- | --- | --- |
| account | 当前账户 | [Account](#account) | - | - |
| chain | 当前链 | [Chain](#chain) | - | - |
| availableChains | 可用的链列表 | [Chain](#chain)[] | - | - |
| availableChains | 可以连接的链列表 | [Chain](#chain)[] | - | - |
| availableWallets | 可用的钱包列表 | [Wallet](#wallet)[] | - | - |
| connect | 连接钱包 | `(wallet: Wallet) => Promise<void>` | - | - |
| disconnect | 断开钱包连接 | `() => Promise<void>` | - | - |
Expand Down
2 changes: 1 addition & 1 deletion packages/web3/src/web3-config-provider/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ group:
| chain | 当前连接的链 | [Chain](/components/types#chain) | - | |
| balance | 当前连接的账户余额 | [Balance](/components/connect-button#balance-1) | - | |
| availableWallets | 可用钱包列表 | [Wallet](/components/types#wallet)\[] | - | |
| availableChains | 可用链列表 | [Chain](/components/types#chain)\[] | - | |
| availableChains | 可以连接的链列表 | [Chain](/components/types#chain)\[] | - | |
| extendsContextFromParent | 继承父级 `Provider` 的值 | `boolean` | `true` | |
| connect | 连接链 | `(wallet?: Wallet) => Promise<void>` | - | |
| disconnect | 断开连接 | `() => Promise<void>` | - | |
Expand Down

0 comments on commit 501e477

Please sign in to comment.