Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(metaMask): enhance documentation for MetaMask Connector features… #4511

Merged
merged 5 commits into from
Feb 12, 2025
Merged

docs(metaMask): enhance documentation for MetaMask Connector features… #4511

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1959d82
docs(metaMask): enhance documentation for MetaMask Connector features…
cxalem Jan 17, 2025
b53cc22
Update site/shared/connectors/metaMask.md
cxalem Feb 6, 2025
74346bf
Update site/shared/connectors/metaMask.md
cxalem Feb 6, 2025
02d5c7d
Merge branch 'wevm:main' into main
cxalem Feb 6, 2025
7402522
docs: add type and description for MetaMask connector options
cxalem Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions site/shared/connectors/metaMask.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ const connectorsPackageName = 'wagmi/connectors'

Connector for [MetaMask SDK](https://github.com/MetaMask/metamask-sdk).

The MetaMask Connector helps you manage wallet connections in your React applications. It supports essential features like connecting, disconnecting, and handling multiple chains, while maintaining compatibility with browser and mobile environments. You can choose between the MetaMask Connector and the Injected Connector—but keep in mind that using the Injected Connector limits your app to the MetaMask browser extension only.

## Import

```ts-vue
Expand Down Expand Up @@ -41,8 +43,6 @@ Check out the [MetaMask SDK docs](https://docs.metamask.io/wallet/connect/3rd-pa

### dappMetadata

`DappMetadata | undefined`

Metadata is used to fill details for the UX on confirmation screens in MetaMask, including the following fields:

- `name`: `string` - The name of the dapp.
Expand All @@ -63,8 +63,6 @@ const connector = metaMask({

### logging

`SDKLoggingOptions | undefined`

Enables SDK-side logging to provide visibility into:

- RPC methods being called.
Expand Down Expand Up @@ -92,8 +90,6 @@ const connector = metaMask({

### headless

`boolean | undefined`

- Enables headless mode, disabling MetaMask's built-in modal.
- Allows developers to create their own modal, such as for displaying a QR code.

Expand All @@ -120,3 +116,7 @@ EIP-6963 defines a standard way for dapps to interact with multiple wallets simu
When MetaMask SDK detects an EIP-6963-compliant provider (such as MetaMask itself), the connector will automatically replace the default injected provider (like `window.ethereum`) with the one provided by MetaMask SDK.

See the [`rdns` property](https://wagmi.sh/dev/creating-connectors#properties) for more information.

## MetaMask SDK Docs

Check out the [MetaMask SDK docs](https://docs.metamask.io/wallet/connect/metamask-sdk/javascript/react/) for more information.
Loading