You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Update MetaMask connector doc
Update docs page for the MetaMask SDK connector. This includes removing several options that we don't recommend configuring.
* Address reviewer comments
* update link
* fix dappMetadata description
import { type MetaMaskParameters } from '{{connectorsPackageName}}'
38
38
```
39
-
Check out the [MetaMask SDK docs](https://github.com/MetaMask/metamask-sdk?tab=readme-ov-file#sdk-options) for more info. A few options are omitted that Wagmi manages internally.
40
39
41
-
### communicationLayerPreference
42
-
43
-
`CommunicationLayerPreference | undefined`
44
-
45
-
The preferred communication layer to use for the SDK.
46
-
47
-
### communicationServerUrl
48
-
49
-
`string | undefined`
50
-
51
-
The URL of the communication server to use for the SDK.
40
+
Check out the [MetaMask SDK docs](https://docs.metamask.io/wallet/connect/3rd-party-libraries/wagmi/) for more info. A few options are omitted that Wagmi manages internally.
52
41
53
42
### dappMetadata
54
43
55
44
`DappMetadata | undefined`
56
45
57
-
- Metadata about the dapp using the SDK.
58
-
- Defaults to `{ name: 'wagmi' }`.
59
-
60
-
### enableAnalytics
61
-
62
-
`boolean | undefined`
63
-
64
-
- Send anonymous analytics to MetaMask to help us improve the SDK.
65
-
- Defaults to `false`.
66
-
67
-
### extensionOnly
68
-
69
-
`boolean | undefined`
70
-
71
-
- If MetaMask browser extension is detected, directly use it.
- If `true`, the SDK will use deeplinks to connect with MetaMask Mobile. If `false`, the SDK will use universal links to connect with MetaMask Mobile.
158
-
- Defaults to `true`.
159
-
160
-
::: warning
161
-
Setting `useDeeplink` to `false` can negatively impact performance on iOS Safari as Universal Link connections are canceled if they do not occur within ~500ms of an interaction (e.g. button press).
162
-
:::
77
+
```ts-vue
78
+
import { metaMask } from '{{connectorsPackageName}}'
163
79
164
-
### wakeLockType
80
+
const connector = metaMask({
81
+
headless: true // [!code focus]
82
+
})
83
+
```
165
84
166
-
`WakeLockStatus | undefined`
85
+
## Advanced
167
86
168
-
The type of wake lock to use when the SDK is running in the background.
87
+
By default, if the EIP-6963 MetaMask injected provider is detected, this connector will replace it.
88
+
See the [`rdns` property](https://wagmi.sh/dev/creating-connectors#properties) for more information.
0 commit comments