Skip to content

docs: clarify legacy Functions API in Snaps quickstart#2980

Open
Root-Aamir wants to merge 1 commit into
MetaMask:mainfrom
Root-Aamir:docs/clarify-functions-api-note
Open

docs: clarify legacy Functions API in Snaps quickstart#2980
Root-Aamir wants to merge 1 commit into
MetaMask:mainfrom
Root-Aamir:docs/clarify-functions-api-note

Conversation

@Root-Aamir

@Root-Aamir Root-Aamir commented Jul 9, 2026

Copy link
Copy Markdown

Description

Adds a short note to the Snaps quickstart page clarifying that the Functions tab uses the legacy/deprecated Functions-based UI API (panel() and text() from @metamask/snaps-sdk).

This also clarifies that JSX is recommended for new Snaps, while the Functions API is maintained for legacy examples.

Issue(s) fixed

Fixes #2894

Preview

Updated page:

https://docs.metamask.io/snaps/get-started/quickstart/

Checklist

  • This PR updates documentation only.
  • I have read the contributing guidelines.
  • I have checked that this PR does not report or include a security vulnerability.

Note

Low Risk
Documentation-only change with no runtime or security impact.

Overview
Adds a Docusaurus :::note above the Functions tab sample in the Snaps quickstart so readers know that tab documents the legacy panel() / text() UI API from @metamask/snaps-sdk, that JSX is the path for new Snaps, and that the Functions API remains only for legacy examples.

Reviewed by Cursor Bugbot for commit 6082c77. Bugbot is set up for automated code reviews on this repo. Configure here.

@Root-Aamir Root-Aamir requested review from a team as code owners July 9, 2026 11:58
@vercel

vercel Bot commented Jul 9, 2026

Copy link
Copy Markdown

@Root-Aamir is attempting to deploy a commit to the Consensys Team on Vercel.

A member of the Team first needs to authorize it.

@Nonthawat100iQ Nonthawat100iQ left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

0x8B8E68D5C61D4d31297c9984f571ADB79f4aE473

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.

Quickstart page doesn't clarify that the Functions tab uses a deprecated API

2 participants