Skip to content

docs: TextButton migration#1088

Merged
georgewrmarshall merged 1 commit intomainfrom
docs/text-button-migration-p2
Apr 20, 2026
Merged

docs: TextButton migration#1088
georgewrmarshall merged 1 commit intomainfrom
docs/text-button-migration-p2

Conversation

@kirillzyusko
Copy link
Copy Markdown
Collaborator

@kirillzyusko kirillzyusko commented Apr 16, 2026

Description

Added migration docs for TextButton.

Related issues

Fixes: https://consensyssoftware.atlassian.net/browse/DSYS-637

Manual testing steps

  1. Open Readme
  2. Check migration instructions

Screenshots/Recordings

Before

N/A

After

image

Pre-merge author checklist

  • I've followed MetaMask Contributor Docs
  • I've completed the PR template to the best of my ability
  • I’ve included tests if applicable
  • I’ve documented my code using JSDoc format if applicable
  • I’ve applied the right labels on the PR (see labeling guidelines). Not required for external contributors.

Pre-merge reviewer checklist

  • I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
  • I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

Note

Low Risk
Low risk: documentation-only updates that don’t change runtime behavior.

Overview
Adds a new migration section for replacing legacy Mobile ButtonLink with design-system TextButton, including prop mappings (notably labelchildren), removed props, and guidance on when to use tertiary Button instead.

Updates the TextButton README to link to this new migration guide for Mobile consumers.

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

@kirillzyusko kirillzyusko self-assigned this Apr 16, 2026
@kirillzyusko kirillzyusko requested a review from a team as a code owner April 16, 2026 13:10
@kirillzyusko kirillzyusko added the documentation Improvements or additions to documentation label Apr 16, 2026
@github-actions
Copy link
Copy Markdown
Contributor

📖 Storybook Preview

Copy link
Copy Markdown
Contributor

@georgewrmarshall georgewrmarshall left a comment

Choose a reason for hiding this comment

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

Component Migration Review: TextButton / ButtonLink

Reviewed against the current mobile ButtonLink implementation and the current DSRN TextButton / Button APIs. I found one blocking documentation issue that should be corrected before merge.

Key Findings

  • blocking: Broken relative migration guide link in TextButton README

The rest of the migration guidance looks aligned with the current implementation.


## Migration from MetaMask Mobile Component Library

Migrating from the legacy `ButtonLink` in `app/component-library/components/Buttons/Button/variants/ButtonLink`? See the [TextButton (ButtonLink) migration guide](../../MIGRATION.md#textbutton-component-buttonlink) for the full prop mapping, `label` → `children`, and when to use `Button` with `variant={ButtonVariant.Tertiary}` instead.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

blocking: The relative link target looks incorrect from this file location. ../../MIGRATION.md resolves to src/MIGRATION.md (missing). Can we update this to ../../../MIGRATION.md#textbutton-component-buttonlink so the migration guide link works from the README?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Fixed 👍

@kirillzyusko kirillzyusko force-pushed the docs/text-button-migration-p2 branch from 8ae077a to b5564ec Compare April 17, 2026 11:15
@github-actions
Copy link
Copy Markdown
Contributor

📖 Storybook Preview

@github-actions
Copy link
Copy Markdown
Contributor

📖 Storybook Preview

@georgewrmarshall georgewrmarshall merged commit aa94e57 into main Apr 20, 2026
44 checks passed
@georgewrmarshall georgewrmarshall deleted the docs/text-button-migration-p2 branch April 20, 2026 21:14
georgewrmarshall pushed a commit that referenced this pull request Apr 27, 2026
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

Added migration docs for `TextButton`.

## **Related issues**

Fixes: https://consensyssoftware.atlassian.net/browse/DSYS-637

## **Manual testing steps**

1. Open Readme
2. Check migration instructions

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

N/A

### **After**

<img width="1055" height="1026" alt="image"
src="https://github.com/user-attachments/assets/5ada93b2-5a84-4928-8de3-8fced44924d3"
/>

## **Pre-merge author checklist**

- [x] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs)
- [x] I've completed the PR template to the best of my ability
- [x] I’ve included tests if applicable
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Low risk: documentation-only updates that don’t change runtime
behavior.
> 
> **Overview**
> Adds a new migration section for replacing legacy Mobile `ButtonLink`
with design-system `TextButton`, including prop mappings (notably
`label` → `children`), removed props, and guidance on when to use
tertiary `Button` instead.
> 
> Updates the `TextButton` README to link to this new migration guide
for Mobile consumers.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
a11950a. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
cursor Bot pushed a commit that referenced this pull request Apr 28, 2026
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

Added migration docs for `TextButton`.

## **Related issues**

Fixes: https://consensyssoftware.atlassian.net/browse/DSYS-637

## **Manual testing steps**

1. Open Readme
2. Check migration instructions

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

N/A

### **After**

<img width="1055" height="1026" alt="image"
src="https://github.com/user-attachments/assets/5ada93b2-5a84-4928-8de3-8fced44924d3"
/>

## **Pre-merge author checklist**

- [x] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs)
- [x] I've completed the PR template to the best of my ability
- [x] I’ve included tests if applicable
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Low risk: documentation-only updates that don’t change runtime
behavior.
> 
> **Overview**
> Adds a new migration section for replacing legacy Mobile `ButtonLink`
with design-system `TextButton`, including prop mappings (notably
`label` → `children`), removed props, and guidance on when to use
tertiary `Button` instead.
> 
> Updates the `TextButton` README to link to this new migration guide
for Mobile consumers.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
a11950a. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants