chore(packages) avoid data-lgid and data-testid attributes being duplicated in components
#3184
Conversation
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
🦋 Changeset detectedLatest commit: 148ee52 The changes in this PR will be included in the next version bump. This PR includes changesets to release 96 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 |
|
Size Change: +930 B (+0.06%) Total Size: 1.6 MB
ℹ️ View Unchanged
|
shaneeza
reviewed
Oct 2, 2025
| })} | ||
| data-lgid={lgIds.root} | ||
| data-testid={lgIds.root} | ||
| data-lgid={lgIds.label} |
There was a problem hiding this comment.
One of the reasons we pass the root to label and description is because <Label> and <Description> already generate their own specific lgids internally.
leafygreen-ui/packages/typography/src/Label/Label.tsx
Lines 38 to 39 in 9b2d156
So if you pass lgids.root, the root is lg-checkbox and the id generated in <Label> will be lg-checkbox-label.
However, if we pass lgIds.label, that will pass lg-checkbox-label to <Label>, which will generate lg-checkbox-label-label.
The first approach allows us to avoid duplication in the id string
There was a problem hiding this comment.
Ahh I see. Wouldn't it make more sense (and in alignment with the style-guide / BEM-like) for the Label component to have its own getLgIds function? 🤔 I mean, Label is not a "child element" of some "typography block".
I've pushed a suggestion to work around this in the simplest possible way I could imagine.
leafygreen-ui/packages/typography/src/Description/Description.tsx
Lines 36 to 41 in 148ee52
kraenhansen
force-pushed
the
kh/avoid-duplicate-ids
branch
from
06a802e to
bb28eaa
Compare
kraenhansen
force-pushed
the
kh/avoid-duplicate-ids
branch
from
b004364 to
148ee52
Compare
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.
✍️ Proposed changes
Merging this PR will:
data-lgidordata-testidattributes are referencing the same id.✅ Checklist
For new components
For bug fixes, new features & breaking changes
pnpm changesetand documented my changes🧪 How to test changes