fix(combobox): controlled combobox onchange #17858
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
* updated useEffect hook for controlled combobox so onChange doesn't fire twice when selection is made and selectedItem prop changes * updated onSelectedItemChange to not fire onChange if selectedItem is unchanged * unit tests
✅ Deploy Preview for v11-carbon-web-components ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for carbon-elements ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #17858 +/- ##
=======================================
Coverage 81.59% 81.60%
=======================================
Files 406 406
Lines 14047 14049 +2
Branches 4355 4377 +22
=======================================
+ Hits 11462 11464 +2
+ Misses 2422 2421 -1
- Partials 163 164 +1 ☔ View full report in Codecov by Sentry. |
✅ Deploy Preview for v11-carbon-react ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
tay1orjones
requested changes
Oct 23, 2024
* updated comparison of new selectedItem to use react-fast-compare isEqual
guidari
approved these changes
Oct 29, 2024
alisonjoseph
approved these changes
Oct 31, 2024
tay1orjones
approved these changes
Nov 5, 2024
Merged
via the queue into
carbon-design-system:main
with commit Nov 5, 2024
57fce93
40 checks passed
|
Hey there! v11.70.0 was just released that references this issue/PR. |
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.
Closes #17847
In cases where a selection is made to a fully controlled combobox component, and the selectedItem prop updates on this selection, such as in cases where this state is managed externally (probably just about all cases where
selectedItemis being used), the onChange was firing twice. This PR adds a check to see if the selectedItem prop was changed externally before calling the onChange in the useEffect pertaining to controlled comboboxes. It also ensures that onChange is not fired for controlled comboboxes when a selection is made that is the same as the current selection.Testing / Reviewing