feat!: Expose ComboBox component ref with a clearSelection method #1236
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
ghost
requested review from
ahobson,
brandonlenz,
gidjin,
haworku,
sarboc,
SirenaBorracha,
suzubara and
tinyels
as code owners
ghost
added
type: breaking
ghost
removed a link to an issue
ghost
mentioned this pull request
brandonlenz
changed the title
brandonlenz
reviewed
Jun 2, 2021
brandonlenz
approved these changes
Jun 3, 2021
Merged
This pull request was closed.
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
This changes the
ComboBoxcomponent to useforwardRefand theuseImperativeHandlehook. It allows users to pass in a ref to a component instance and then call aclearSelectionmethod on it, which will clear any existing value.This change is deeply indebted to the pattern established in PR #1165.
As this changes an existing component to use
forwardRef, this should be considered a BREAKING CHANGE.Related Issues or PRs
Closes #1137 .
How To Test
In the application, try passing a
refto the ComboBox component, selecting a value for the component, and usingref.current.clearSelection()to reset the value.