[Autocomplete] Add docs interface for the hook #36242
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
…se-autocomplete-hook
…se-autocomplete-hook
oliviertassinari
changed the title
oliviertassinari
added
docs
The type was wrongly spelled, it fixes the generation. -AutoComplete
+Autocomplete |
15 tasks
|
Thanks for reviewing and fixing those up Olivier! Much appreciated |
github-actions
bot
added
the
PR: out-of-date
…se-autocomplete-hook
github-actions
bot
removed
the
PR: out-of-date
| value: AutocompleteValue<T, Multiple, DisableClearable, FreeSolo>; | ||
| /** | ||
| * If `true`, the component has valid values selected. |
There was a problem hiding this comment.
I think this should be:
Suggested change
| * If `true`, the component has valid values selected. | |
| * If `true`, the component input has some values. |
Because in freeSolo mode, it can be any value.
There was a problem hiding this comment.
Good call-out, have amended my PR
HeVictor
requested review from
ZeeshanTamboli
and removed request for
mnajdova
mnajdova
approved these changes
Feb 27, 2023
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.
Adds useAutocomplete return value interface
closes useAutocomplete in #35933
I was unable to generate any JS docs from runningyarn docs:apiso I probably missed exporting the new return value type somewhere, but I'm having some trouble figuring it out where that might be as the PR's for the other public hooks all had.tsversions for the hook butuseAutocompleteonly exists in.jsso there must be a different mechanism. Pointers on this would be greatly appreciatedhttps://deploy-preview-36242--material-ui.netlify.app/base/api/use-autocomplete/#return-value