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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

cxalem
Copy link
Contributor

@cxalem cxalem commented Jan 17, 2025

Changes made based on feedback from the MetaMask team:

  • Added a description of the MetaMask Connector's capabilities, including wallet connection management, support for multiple chains, and compatibility with browser and mobile environments.
  • Clarified the distinction between the MetaMask Connector and the Injected Connector.
  • Included a link to the MetaMask SDK documentation for further reference.

… and usage

- Added a description of the MetaMask Connector's capabilities, including wallet connection management, support for multiple chains, and compatibility with browser and mobile environments.
- Clarified the distinction between the MetaMask Connector and the Injected Connector.

- Included a link to the MetaMask SDK documentation for further reference.
Copy link

changeset-bot bot commented Jan 17, 2025

⚠️ No Changeset found

Latest commit: 1959d82

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Jan 17, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
wagmi ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 17, 2025 1:31pm

@@ -92,8 +90,6 @@ const connector = metaMask({

### headless

`boolean | undefined`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep these types around

@@ -63,8 +63,6 @@ const connector = metaMask({

### logging

`SDKLoggingOptions | undefined`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep these types around

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

### dappMetadata

`DappMetadata | undefined`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep these types around (convention we use throughout the docs)

@@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is a shared page for the VanillaJS, Vue, and React docs, let's keep it basic and remove the mention of React.

Suggested change
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.
Check out the [MetaMask SDK docs](https://docs.metamask.io/wallet/connect/metamask-sdk/javascript) for more information.

Comment on lines +119 to +122

## MetaMask SDK Docs

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added further up instead

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants