Add data-testid attribute to SplitButton's menu trigger element
#2621
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
🦋 Changeset detectedLatest commit: 6fe917b The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
14 tasks
|
Size Change: +198 B (+0.01%) Total Size: 1.37 MB
ℹ️ View Unchanged
|
shaneeza
requested changes
Jan 7, 2025
| @@ -134,6 +134,7 @@ export const Menu = ({ | |||
| className={cx(triggerBaseStyles, triggerSizeStyles[size], { | |||
| [triggerThemeStyles(theme, variant)]: !disabled, | |||
| })} | |||
| data-testid="lg-split-button-trigger" | |||
There was a problem hiding this comment.
We recently adopted a BEM-ish pattern for testid's.
I would suggest: lg-split_button-trigger.
I’d also recommend creating a constants.ts file to define the testids, following a similar approach as seen in Menu.
I would also add a default testid for the primary button since you're adding one for the trigger.
There was a problem hiding this comment.
I can certainly do that 👍 If I did, should we introduce another breaking change and update
while at it?There was a problem hiding this comment.
What's the different between data-testid and data-lgid? It seems the Menu pass both:
leafygreen-ui/packages/menu/src/Menu/Menu.tsx
Lines 200 to 201 in a3d63cb
There was a problem hiding this comment.
I just rebased and pushed 2bf7dab with changes taking this comment into considerations.
Regarding the difference between testid and lgid I was thinking of an alternative where the testid supplied by the user could serve as "base" for other testids used throughout the component. I.e. if the user sets data-testid="my_thing" on the SplitButton the menu inside would get data-testid="my_thing-menu" instead of (the default) data-testid="lg-split_button-menu". That way the user can provide individual testids when rendering multiple components and more easily target deeply into the individual elements. The alternative (which is what I added with 2bf7dab) the data-testid supplied by the user is only used for the root and the user has to reference nested testid values, relative to this.
kraenhansen
force-pushed
the
kh/add-split-button-trigger-test-id
branch
from
aaba11a to
89fb096
Compare
kraenhansen
force-pushed
the
kh/add-split-button-trigger-test-id
branch
from
89fb096 to
6fe917b
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
In an effort to make out tests more robust to future changes, I suggest adding a
data-testidattribute so theSplitButtontrigger button can be targeted directly.✅ Checklist
For bug fixes, new features & breaking changes
yarn changesetand documented my changesFor new components
🧪 How to test changes