Skip to content

Commit

Permalink
docs: add version note for wagmi config (#1140)
Browse files Browse the repository at this point in the history
* docs: add version note for wagmi config

* Update packages/web3/src/ethereum/index.md

Co-authored-by: thinkasany <[email protected]>

---------

Co-authored-by: tingzhao.ytz <[email protected]>
Co-authored-by: thinkasany <[email protected]>
  • Loading branch information
3 people authored Sep 9, 2024
1 parent 9fd9da5 commit 078d83c
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions packages/web3/src/ethereum/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,18 +84,18 @@ When the `showQrModal` configuration is not `false`, the built-in [web3modal](ht

| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| config | wagmi config | [WagmiConfig](https://wagmi.sh/core/config) | - | - |
| config | wagmi config | [WagmiConfig](https://wagmi.sh/core/config) | Support for automatically generating configurations such as `chains` and `wallets` is available after `2.8.0` | - |
| queryClient | [React Query](https://react-query.tanstack.com/) queryClient | `new QueryClient()` | - | - |
| wallets | Wallets | [WalletFactory](#walletfactory)[] | - | - |
| chains | Chains | [ChainAssetWithWagmiChain](#chainassetwithwagmichain)\[\] | - | - |
| ens | Whether to display ENS | `boolean` | - | - |
| balance | Whether to display balance | `boolean` | - | - |
| locale | Multilingual settings | [Locale](https://github.com/ant-design/ant-design-web3/blob/main/packages/common/src/locale/en_US.ts) | - | - |
| eip6963 | Whether to use EIP6963 protocol wallet and related configurations | `boolean` \| `EIP6963Config` | `false` | |
| eip6963 | Whether to use EIP6963 protocol wallet and related configurations | `boolean` \| `EIP6963Config` | `false` | `2.2.0` |
| initialState | Initial state to hydrate into the [Wagmi Config](https://wagmi.sh/react/api/createConfig). Useful for SSR. | [State](https://wagmi.sh/react/api/createConfig#state-1) \| `undefined` | - | - |
| reconnectOnMount | Whether or not to reconnect previously connected [connectors](https://wagmi.sh/react/api/createConfig#connectors) on mount. | `boolean` \| `undefined` | `true` | - |
| walletConnect | WalletConnect configuration | `false` \| [WalletConnectOptions](#walletconnectoptions) | - | - |
| transports | [Transport](https://wagmi.sh/core/api/createConfig#transports) configuration | `Transport` | - | - |
| walletConnect | WalletConnect configuration | `false` \| [WalletConnectOptions](#walletconnectoptions) | - | `2.8.0` |
| transports | [Transport](https://wagmi.sh/core/api/createConfig#transports) configuration | `Transport` | - | `2.8.0` |

### WalletFactory

Expand Down

0 comments on commit 078d83c

Please sign in to comment.