docs: HeaderBase migration (mobile)#1100
Conversation
📖 Storybook Preview |
georgewrmarshall
left a comment
There was a problem hiding this comment.
Could we maybe make some improvements to this component based on this thread https://consensys.slack.com/archives/C02VD8QG0LT/p1776890507679999
|
@georgewrmarshall was it handled in #1103? |
Yes but it's a rough draft needs to be refined I'll work on it tomorrow. Apologies for the blocker. |
georgewrmarshall
left a comment
There was a problem hiding this comment.
Approved for the current HeaderBase API on main.
One follow-up note: this migration guide is documenting the pre-refactor HeaderBase shape, so it will need to be revisited if/when #1103 lands first. That refactor removes HeaderBaseVariant/variant and replaces titleTestID with textProps, so this section should be refreshed to match the final API after the refactor settles.
|
|
||
| The `HeaderBase` component is a flexible header with optional start/end accessories and a configurable title variant. Migration is nearly a drop-in swap — most consumers change the import, remove two constant imports, and switch any affected test IDs to explicit props. | ||
|
|
||
| #### Breaking Changes |
There was a problem hiding this comment.
non-blocking: This looks correct for the current HeaderBase API on main, but #1103 is changing this contract pretty substantially by removing HeaderBaseVariant / variant and moving string-title passthrough onto textProps. If that refactor merges first, this migration section will need a follow-up refresh so the docs keep describing the final target API rather than the transitional one.
📖 Storybook Preview |
Description
Added migration docs for
HeaderBasecomponent (mobile).Related issues
Fixes: https://consensyssoftware.atlassian.net/browse/DSYS-282
Manual testing steps
MIGRATION.MDfile;HeaderBasesection;Screenshots/Recordings
Before
N/A
After
Pre-merge author checklist
Pre-merge reviewer checklist
Note
Low Risk
Low risk docs-only change; no runtime behavior or public API is modified in this PR.
Overview
Adds a new
HeaderBasesection toMIGRATION.mddescribing how to migrate from the mobile component-library to@metamask/design-system-react-native, including import changes, removal ofHEADERBASE_TEST_ID/HEADERBASE_TITLE_TEST_IDin favor of explicittestID/titleTestID, and the fixed-heightDisplayvariant behavior.Updates the
HeaderBasecomponent README to link to the new migration guide for downstream consumers.Reviewed by Cursor Bugbot for commit 72fcc79. Bugbot is set up for automated code reviews on this repo. Configure here.