Improve Combobox types to improve false positives
#2411
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
If you use the default `Combobox` component then it defaults to
`Fragment`. This also means that if you provide an additional prop that
it would be forwarded to the `Fragment` but that won't work.
You do get a runtime error, but the types aren't 100% clear on what's
going on. In fact, they make it very confusing because it will use the
last "fallback" in all the `Combobox` definitions which marks the value
as "multiple".
Concretely, this means:
```ts
let [value, setValue] = useState('Tom Cook')
<Combobox
value={value}
onChange={setValue}
placeholder="Hello!"
/>
```
Starts complaining about the `value` and `onChange` not handling the
`multiple` case correctly. But it should complain about the `placeholder`.
Switching the order _does_ solve this, but it is not the cleanest
solution.
Maybe we should be explicit about the `Fragment` case somehow.
However, there is a use case where I don't think TypeScript will be able
to help and it's a bit unfortunate.
```ts
let [value, setValue] = useState('Tom Cook')
<Combobox value={value} onChange={setValue} placeholder="Hello!">
<div>
{/* ... */}
</div>
</Combobox>
```
This is valid because at runtime we will forward all the props to the
`div`. So not 100% sure what we should do here instead.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
| ): JSX.Element | ||
| <TValue, TTag extends ElementType = typeof DEFAULT_COMBOBOX_TAG>( | ||
| props: ComboboxProps<TValue, false, true, TTag> & RefProp<typeof ComboboxFn> | ||
| props: ComboboxProps<TValue, false, false, TTag> & RefProp<typeof ComboboxFn> |
There was a problem hiding this comment.
The fact that this change fixes things amazes me. Thanks TypeScript 😂
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.
If you use the default
Comboboxcomponent then it defaults toFragment. This also means that if you provide an additional prop that it would be forwarded to theFragmentbut that won't work.You do get a runtime error, but the types aren't 100% clear on what's going on. In fact, they make it very confusing because it will use the last "fallback" in all the
Comboboxdefinitions which marks the value as "multiple".Concretely, this means:
Starts complaining about the
valueandonChangenot handling themultiplecase correctly. But it should complain about theplaceholder.Switching the order does solve this, but it is not the cleanest solution.
Maybe we should be explicit about the
Fragmentcase somehow.However, there is a use case where I don't think TypeScript will be able to help and it's a bit unfortunate.
This is valid because at runtime we will forward all the props to the
div. So not 100% sure what we should do here instead.Visually, these changes look like:
vs
Fixes: #2407