Remove deprecated IconButton API#3745
Open
connor-baer wants to merge 6 commits into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🦋 Changeset detectedLatest commit: 0749e24 The changes in this PR will be included in the next version bump. This PR includes changesets to release 4 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
🚀 Your packages were publishedPublished Packages:
|
Contributor
|
Size Change: -186 B (-0.02%) Total Size: 829 kB 📦 View Changed
ℹ️ View Unchanged
|
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## next #3745 +/- ##
==========================================
- Coverage 93.35% 93.32% -0.04%
==========================================
Files 197 197
Lines 4351 4329 -22
Branches 1752 1741 -11
==========================================
- Hits 4062 4040 -22
Misses 262 262
Partials 27 27
🚀 New features to boost your workflow:
|
connor-baer
commented
Jul 7, 2026
| * one-word object if needed to clarify. | ||
| */ | ||
| children: ReactNode; | ||
| children: string | string[]; |
Member
Author
There was a problem hiding this comment.
I'm debating whether to restrict the children to string or string-like (e.g. numbers, array of strings) values.
Pros: It would ensure that the button label is accessible. It could help catch cases where developers pass an icon as part of the children instead of using the dedicated props.
Cons: Might require significant clean-up efforts in the apps.
Contributor
There was a problem hiding this comment.
How about we start with a warning in dev environment and change the type in the next major ?
Member
Author
There was a problem hiding this comment.
I'll split this out into a separate PR.
connor-baer
force-pushed
the
remove-legacy-icon-button
branch
from
16db009 to
511da54
Compare
connor-baer
force-pushed
the
remove-legacy-icon-button
branch
from
3c6ecaa to
e400eb3
Compare
sirineJ
reviewed
Jul 9, 2026
| ); | ||
| } | ||
| if (process.env.NODE_ENV !== 'production' && !props.icon) { | ||
| throw new CircuitError('IconButton', 'The `icon` prop is missing.'); |
Contributor
There was a problem hiding this comment.
do we need to treat the icon prop differently from any other required prop ? or is this kept intentionally to highlight issues during the migration?
Member
Author
There was a problem hiding this comment.
I initially kept it to help with the migration. I think you're right though that it can be cleaned up since I've completed the migration in all major apps already.
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
3 participants
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.
Addresses DSYS-1667
Purpose
The IconButton’s API was updated to match the Button component and to make it easier to pass props to the icon component.
Approach and changes
labelprop in favor ofchildrenand force passing the icon using theiconproparia-labels from the carousel buttonsimport * as) to improve tree-shakingDefinition of done