refactor: updated ButtonIcon to have variant prop#948
Merged
Conversation
Contributor
📖 Storybook Preview |
Contributor
📖 Storybook Preview |
Contributor
📖 Storybook Preview |
Contributor
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
georgewrmarshall
requested changes
Mar 4, 2026
georgewrmarshall
left a comment
Contributor
There was a problem hiding this comment.
LGMT! But blocking until we merge MMDS v24 release #954. I think this change can go into it's own release
Contributor
📖 Storybook Preview |
georgewrmarshall
added a commit
that referenced
this pull request
Mar 10, 2026
## Release 25.0.0 This release includes new components migrated from Extension and Mobile, breaking API improvements to ButtonIcon and Input components, and continued ADR-0003/0004 type migrations. ### 📦 Package Versions - `@metamask/design-system-shared`: **0.4.0** - `@metamask/design-system-react`: **0.11.0** - `@metamask/design-system-react-native`: **0.11.0** ### 🔄 Shared Type Updates (0.4.0) #### Component Type Additions (#964, #955) Added shared types for newly migrated components following ADR-0003 and ADR-0004 patterns: **What Changed:** - Added `ButtonFilter` shared types with `ButtonFilterVariant` const object and `ButtonFilterPropsShared` - Added `BannerBase` shared types with `BannerBaseSeverity` const object and `BannerBasePropsShared` **Impact:** - Enables consistent ButtonFilter and BannerBase implementations across React and React Native - Continues ADR-0003/0004 const-object + string-union pattern adoption ### 🌐 React Web Updates (0.11.0) #### Added - Added `ButtonFilter` component for filter button functionality (#964) - Added `BannerBase` component for creating custom banner notifications (#961) #### Changed - **BREAKING:** Updated `ButtonIcon` API to use `variant` prop instead of `isInverse` and `isFloating` boolean props (#948) - Updated `Ai` icon to filled version for visual consistency (#970) ### 📱 React Native Updates (0.11.0) #### Added - Added `ButtonFilter` component (#964) - Added `BottomSheet` component for modal interactions (#963) - Added `MainActionButton` component for primary CTAs (#952) - Added `BannerBase` component for custom banners (#955) - Added `ListItem` component for standardized list rows (#958) - Added `TabEmptyState` component for empty states (#949) - Added `BottomSheetDialog` component for dialogs (#905) #### Changed - **BREAKING:** Updated `ButtonIcon` API to use `variant` prop instead of `isInverse` and `isFloating` boolean props (#948) - **BREAKING:** `Input` component now requires `value` prop and is controlled-only (#960) - Updated `Ai` icon to filled version (#970) #### Fixed - Fixed iOS placeholder alignment issue in `Input` component (#960) - Fixed missing component exports (#967) ###⚠️ Breaking Changes #### ButtonIcon Variant Prop (Both Platforms) **What Changed:** - Removed `isInverse` and `isFloating` boolean props - Added `variant` prop with three options: - `ButtonIconVariant.Default` (transparent background - default) - `ButtonIconVariant.Filled` (muted background with rounded corners - new) - `ButtonIconVariant.Floating` (colored background with inverse icon - replaces `isFloating`) **Migration:** ```tsx // Before <ButtonIcon name={IconName.Add} isFloating /> // After <ButtonIcon name={IconName.Add} variant={ButtonIconVariant.Floating} /> ``` See migration guides for complete instructions: - [React Migration Guide](./packages/design-system-react/MIGRATION.md#from-version-0100-to-0110) - [React Native Migration Guide](./packages/design-system-react-native/MIGRATION.md#from-version-0100-to-0110) #### Input Controlled-Only (React Native Only) **What Changed:** - Removed `defaultValue` prop - `value` prop is now required - All Input instances must be controlled with state management **Migration:** ```tsx // Before <Input placeholder="Enter text" defaultValue="Initial" onChange={handleChange} /> // After const [text, setText] = useState('Initial'); <Input placeholder="Enter text" value={text} onChange={setText} /> ``` **Impact:** - Affects `Input` and `TextField` components - Provides consistent behavior and fixes iOS placeholder alignment See [React Native Migration Guide](./packages/design-system-react-native/MIGRATION.md#from-version-0100-to-0110) for complete instructions. ### ✅ Checklist - [x] Changelogs updated with human-readable descriptions - [x] Changelog validation passed (`yarn changelog:validate`) - [x] Version bumps follow semantic versioning - design-system-shared: minor (0.3.0 → 0.4.0) - new shared types - design-system-react: minor (0.10.0 → 0.11.0) - new components + breaking ButtonIcon change - design-system-react-native: minor (0.10.0 → 0.11.0) - new components + breaking ButtonIcon and Input changes - [x] Breaking changes documented with migration guidance - [x] Migration guides updated with before/after examples - [x] PR references included in changelog entries <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Medium Risk** > Although this PR is mostly versioning/docs, it formalizes breaking public API changes (`ButtonIcon` and RN `Input`) that will require downstream updates and could cause consumer build failures if missed. > > **Overview** > Bumps the monorepo release to `25.0.0` and publishes new package versions (`@metamask/design-system-react@0.11.0`, `@metamask/design-system-react-native@0.11.0`, `@metamask/design-system-shared@0.4.0`) with updated changelogs. > > Documents newly added components/types (`ButtonFilter`, `BannerBase`, plus several React Native-only additions like `BottomSheet`, `ListItem`, etc.) and **breaking API changes**: `ButtonIcon` replaces `isInverse`/`isFloating` with a `variant` prop (React + RN), and React Native `Input` becomes controlled-only (requires `value`, removes `defaultValue`). Migration guides are updated with before/after examples and new compare links. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 0148a27. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY -->
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the ButtonIcon API in both
@metamask/design-system-reactand@metamask/design-system-react-nativeto use a singlevariantprop instead ofisInverseandisFloating, and adds a Filled variant.Reason for change
ButtonVariant).Changes
Removed props
isInverse(removed from both packages).isFloating(replaced byvariant).New
variantprop andButtonIconVariantButtonIconVariant.Default(default): Transparent background,text-icon-default,rounded-lg; hover/pressed usebg-hover/bg-pressed(React: hover + active; RN: pressed).ButtonIconVariant.Filled: Muted background (bg-muted),text-icon-default,rounded-full; hover/pressed use muted tokens (hover:bg-muted-hover,active:bg-muted-pressed/bg-muted-pressed).ButtonIconVariant.Floating: Same as previous “floating” style:rounded-full,bg-icon-default, inverse icon color (text-primary-inverse/text-background-default).Types
ButtonIconVariantenum added in both packages’types(e.g.packages/design-system-react-native/src/types/index.tsand React equivalent).variant?: ButtonIconVariantwith defaultButtonIconVariant.Default.Toast (React Native only)
ButtonIconVariant(valueIcon). That enum is renamed toToastCloseButtonVariantto avoid clashing with the new ButtonIcon style variant.ToastCloseButtonIconOptionsis nowOmit<ButtonIconProps, 'variant'> & { variant: ToastCloseButtonVariant }so the close button stays correctly typed.'iconName' in closeButtonOptionsand passes only ButtonIcon-relevant props (noToastCloseButtonVariantpassed asvarianttoButtonIcon).Docs and tooling
variantAPI and the three variants in both packages.Breaking changes
isInverseandisFloatingare removed. Usevariantinstead:variant={ButtonIconVariant.Default}for the previous default look.variant={ButtonIconVariant.Floating}for the previousisFloatinglook.variant={ButtonIconVariant.Filled}for the new filled style.variant: ToastCloseButtonVariant.Icon; the export name changes fromButtonIconVarianttoToastCloseButtonVariantfor that discriminant.Related issues
Fixes: DSYS-492
Manual testing steps
React Native (Storybook)
yarn storybook:iosoryarn storybook:android.React (Storybook)
yarn storybook.Toast (React Native)
closeButtonOptionswithiconNameandvariant: ToastCloseButtonVariant.Icon).Consumers
isFloating/isInverseusage withvariant={ButtonIconVariant.Default | Filled | Floating}and re-check screens that use ButtonIcon.Screenshots/Recordings
Before
After
DSRN
Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2026-02-26.at.22.16.45.mov
DSR
Screen.Recording.2026-02-26.at.10.17.42.PM.mov
Pre-merge author checklist
Pre-merge reviewer checklist
Note
Medium Risk
Medium risk due to a breaking prop API change (
isInverse/isFloatingremoved) that requires consumer updates and could cause subtle style/interaction regressions across platforms.Overview
Unifies
ButtonIconstyling under a newvariantprop in bothdesign-system-reactanddesign-system-react-native, removingisInverse/isFloatingand introducingButtonIconVariant(Default,Floating, newFilled) with updated pressed/hover behavior.Updates Storybook stories, Figma Code Connect mappings, docs, exports, and tests to reflect the new API and validate the new
Filledstyling.In React Native
Toast, renames the close-button discriminant enum toToastCloseButtonVariantand refactors close-button option typing/rendering so icon close buttons no longer collide with the newButtonIconVariant.Written by Cursor Bugbot for commit 878d183. This will update automatically on new commits. Configure here.