feat(Badge)!: deprecate name prop on component #1865
Merged
Conversation
This file contains 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
Removing this prop `name` for consistency with other components. The practice is that any component using another component in a prop should use a camelCase version of the component's name. Because both were supported, users of the now-removed `name` component can change the prop to `icon` without any issue.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## v14 #1865 +/- ##
==========================================
- Coverage 96.65% 96.65% -0.01%
==========================================
Files 108 108
Lines 2153 2151 -2
Branches 575 574 -1
==========================================
- Hits 2081 2079 -2
Misses 70 70
Partials 2 2 ☔ View full report in Codecov by Sentry. |
jeremiah-clothier
approved these changes
Feb 28, 2024
Merged
booc0mtaco
added a commit
that referenced
this pull request
Mar 5, 2024
## [14.0.0](v13.12.0...v14.0.0) (2024-03-05) [Storybook](https://61313967cde49b003ae2a860-pjuqfmockf.chromatic.com/) ### ⚠ BREAKING CHANGES * remove Grid and Section from exports (#1876) * **Text:** remove deprecated props (#1873) * **Heading:** remove deprecated props and refactor usages (#1872) * **Link:** remove and reset deprecated props (#1871) * **Select:** remove deprecated props (#1870) * **Label:** remove deprecated props (#1868) * **InputField:** remove unused prop requiredLabel (#1869) * **InlineNotification:** remove deprecated props from component (#1867) * **Card:** deprecate orientation prop (#1866) * **Badge:** deprecate name prop on component (#1865) * **Skeleton:** deprecate .Rect subcomponent mapping (#1864) * **Tag:** remove deprecated props and update API (#1862) * **Tooltip:** remove deprecated props (#1861) * **Tabs:** combine Tab sub-component into Tabs * remove deprecated components * output a single, cjs build ### Features * **Badge:** deprecate name prop on component ([#1865](#1865)) ([cff5d5e](cff5d5e)) * **Card:** deprecate orientation prop ([#1866](#1866)) ([bb160c1](bb160c1)) * **Heading:** remove deprecated props and refactor usages ([#1872](#1872)) ([a5d6f76](a5d6f76)) * **InlineNotification:** remove deprecated props from component ([#1867](#1867)) ([efc6b43](efc6b43)) * **InputField:** remove unused prop requiredLabel ([#1869](#1869)) ([f9d73dd](f9d73dd)) * **Label:** remove deprecated props ([#1868](#1868)) ([907cc39](907cc39)) * **Link:** remove and reset deprecated props ([#1871](#1871)) ([552945a](552945a)) * remove deprecated components ([2538aa6](2538aa6)) * remove Grid and Section from exports ([#1876](#1876)) ([a0ec79a](a0ec79a)) * **Select:** remove deprecated props ([#1870](#1870)) ([e0ad463](e0ad463)) * **Skeleton:** deprecate .Rect subcomponent mapping ([#1864](#1864)) ([9d3ffec](9d3ffec)) * **Tabs:** combine Tab sub-component into Tabs ([0479863](0479863)) * **Tag:** remove deprecated props and update API ([#1862](#1862)) ([dbfbaa3](dbfbaa3)) * **Text:** remove deprecated props ([#1873](#1873)) ([13fbc18](13fbc18)) * **Tooltip:** remove deprecated props ([#1861](#1861)) ([d444607](d444607)) ### Bug Fixes * output a single, cjs build ([523130e](523130e)) * remove unnecessary type definitions script ([be341c0](be341c0))
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.
Summary:
Removing this prop
namefor consistency with other components. The practice is that any component using another component in a prop should use a camelCase version of the component's name. Because both were supported, users of the now-removednamecomponent can change the prop toiconwithout any issue.Test Plan: