feat: Add input onChange handler to ComboBox #1689
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
suzubara
requested review from
ahobson,
brandonlenz,
gidjin,
haworku,
sarboc and
SirenaBorracha
as code owners
suzubara
commented
Oct 12, 2021
| @@ -411,13 +416,13 @@ export const ComboBox = forwardRef( | |||
| </button> | |||
| </span> | |||
| <ul | |||
| {...ulProps} | |||
There was a problem hiding this comment.
I also moved the custom props for these elements up, to avoid mistakenly overwriting required props
brandonlenz
previously approved these changes
Oct 13, 2021
| @@ -31,7 +31,7 @@ export { Grid } from './components/grid/Grid/Grid' | |||
| /** Form components */ | |||
| export { CharacterCount } from './components/forms/CharacterCount/CharacterCount' | |||
| export { Checkbox } from './components/forms/Checkbox/Checkbox' | |||
| export { ComboBox } from './components/forms/ComboBox/ComboBox' | |||
| export { ComboBox, ComboBoxOption } from './components/forms/ComboBox/ComboBox' | |||
There was a problem hiding this comment.
My understanding here is that ComboBoxOption used mostly for internal type safety, but now with the onChange handler, we expose it in case someone wants to use that componentinterface with their handler?
There was a problem hiding this comment.
this was actually unrelated to the onChange addition! because the options passed into a ComboBox component have to match this type, I found it helpful to export this type as well to reference in the consumer app.
brandonlenz
approved these changes
Oct 13, 2021
Merged
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 enhances the existing ComboBox component by allowing a user to pass in a custom
onChangehandler to the underlying text input element (usinginputProps). This capability is required by the USSF Portal project, where we want to allow users to add a custom option to the dropdown. I've added a Storybook example to illustrate this use case.I also made some small adjustments to the ComboBox markup, to match the USWDS implementation. This came up while testing, because I found out the ComboBox
idattribute was on the wrong element. Changes include:disabledprop on the correct elementsaria-setsizevalue on list itemsI found a few other discrepancies and noted them in #1690
Related Issues or PRs
There is no existing issue for this ask.
How To Test
View the ComboBox Custom Input Change Handler story in Storybook. Verify existing ComboBox functionality did not break.
Screenshots (optional)