[LG-5942]: Add customContent field to Combobox #3505
Merged
gargantia-prime merged 1 commit intomainfrom Feb 10, 2026
Merged
Conversation
🦋 Changeset detectedLatest commit: 9146e03 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 |
Contributor
|
Size Change: +41 B (0%) Total Size: 1.84 MB
ℹ️ View Unchanged
|
gargantia-prime
commented
Feb 3, 2026
| }); | ||
|
|
||
| test('Option aria-label falls back to displayName text content', () => { | ||
| test('Option aria-label falls back to displayName', () => { |
Collaborator
Author
There was a problem hiding this comment.
removed the previous unit test
| ref={optionRef} | ||
| highlighted={isFocused} | ||
| disabled={disabled} | ||
| aria-label={ariaLabel || getNodeTextContent(displayName) || value} |
Collaborator
Author
There was a problem hiding this comment.
removed this function since displayName is now string!
| chromatic: { disableSnapshot: true }, | ||
| }; | ||
|
|
||
| export const WithCustomContent = () => { |
Collaborator
Author
There was a problem hiding this comment.
added a new Story!
| ### Minor Changes | ||
|
|
||
| - aac0fd8: `ComboboxOption` now accepts a `ReactNode` for the `displayName` prop, enabling custom content like badges. Also refactored internal styles for better organization. | ||
| - aac0fd8: `ComboboxOption` now accepts a `customContent` prop (ReactNode) for rendering custom option content, while `displayName` remains a string for filtering, chips, and internal logic. Also refactored internal styles for better organization. |
Collaborator
There was a problem hiding this comment.
we shouldn't be retroactively changing the changelog.
Can you just mention in your changeset that you're adding a prop to fix what this was supposed to do?
adamrasheed
approved these changes
Feb 6, 2026
Comment on lines
+338
to
+339
| expect(optionEl).toHaveTextContent('New Feature'); | ||
| expect(optionEl).toHaveTextContent('New'); |
Collaborator
There was a problem hiding this comment.
Can we have the badge use different text? (or remove the text "New" from the display name?)
| expect(optionEl).toHaveAttribute('aria-label', 'New Feature'); | ||
| }); | ||
|
|
||
| test('New flow: option with customContent can be selected', () => { |
Collaborator
There was a problem hiding this comment.
Can we assert that "when an element with customContent is selected, the combobox should only render the displayName"
| * When undefined, this is set to `value` | ||
| */ | ||
| displayName?: ReactNode; | ||
| displayName?: string; |
Collaborator
There was a problem hiding this comment.
I think we can keep this as a ReactNode. That way this will only be a minor change
Collaborator
Author
There was a problem hiding this comment.
Will file a followup ticket!
Collaborator
There was a problem hiding this comment.
Would love it if we can make the update in this PR
Collaborator
Author
There was a problem hiding this comment.
Made the change! Will file a follow up ticket on the leafygreen team once this gets merged.
Comment on lines
+1
to
+5
| --- | ||
| '@leafygreen-ui/combobox': major | ||
| --- | ||
|
|
||
| Added customContent field to render React.Node |
Collaborator
There was a problem hiding this comment.
- If we keep
displayName: ReactNodethis can just beminor - Can we add more details to this changeset?
gargantia-prime
force-pushed
the
jt/LG-5942-FixCombobox
branch
from
b5d5fb1 to
d746f9e
Compare
gargantia-prime
force-pushed
the
jt/LG-5942-FixCombobox
branch
from
d746f9e to
16a7cb4
Compare
gargantia-prime
changed the title
gargantia-prime
force-pushed
the
jt/LG-5942-FixCombobox
branch
from
16a7cb4 to
aa69286
Compare
gargantia-prime
force-pushed
the
jt/LG-5942-FixCombobox
branch
from
97108d1 to
9146e03
Compare
Contributor
|
Coverage after merging jt/LG-5942-FixCombobox into main will be
Coverage Report for Changed Files
|
|||||||||||||||||||||||||||||||
Collaborator
Author
|
Filed a ticket to follow up on fixing the displayName prop situation https://jira.mongodb.org/browse/LG-5968 @TheSonOfThomp @adamrasheed |
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.
✍️ Proposed changes
Context
We need a way to render a custom Node on Combobox. Slack conversation: https://mongodb.slack.com/archives/CFFA5BS79/p1767382709151629
We originally made a change to make displayNode a React.Node but it does not work. The root cause is because Combobox relies on
displayNameto track component state, so changing its type breaks that behavior.Solution
To support custom rendering, instead pass an optional custom field to each option. In the
ComboboxOption’s render function, check for this custom field and render it when present; otherwise, fall back to rendering the legacy displayName string. The new field is calledCustomContentIt follows the same pattern that Material UI uses: https://github.com/mui/material-ui/blob/10517bb1681da5a4fdbe0d6b7f4ca1e801066e98/packages/mui-material/src/Autocomplete/Autocomplete.js#L649 so should be industry standard.Also, I kept the change in https://github.com/mongodb/leafygreen-ui/pull/3434/changes that made
displayNamea ReactNode. Will file a follow up ticket on leafygreen to fix this. This will make it a minor release!Risk
Should be very low risk since
CustomContentis an optional prop.🎟️ Jira ticket: LG-5942
✅ Checklist
For bug fixes, new features & breaking changes
pnpm changesetand documented my changes🧪 How to test changes
Added unit tests.
Verified that this new field works as intended downstream on MMS
The New label is custom component added as part of
customContentScreen.Recording.2026-01-30.at.8.11.21.PM.mov