Skip to content

Add description for onSubmit in SearchAutocomplete #3993

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 2, 2023
Merged

Add description for onSubmit in SearchAutocomplete #3993

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
033a886
add description for onSubmit
reidbarber Feb 1, 2023
3d4e1ea
Merge branch 'main' into searchautocomplete-onSubmit-description
reidbarber Feb 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions packages/@react-types/autocomplete/src/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,14 @@ export interface SearchAutocompleteProps<T> extends CollectionBase<T>, Omit<Aria
* @default 'input'
*/
menuTrigger?: MenuTriggerAction,
/** Handler that is called when the SearchAutocomplete is submitted.
*
* A `value` will be passed if the submission is a custom value (e.g. a user types then presses enter).
* If the input is a selected item, `value` will be null.
*
* A `key` will be passed if the submission is a selected item (e.g. a user clicks or presses enter on an option).
* If the input is a custom value, `key` will be null.
*/
onSubmit?: (value: string | null, key: Key | null) => void,
/** An icon to display at the start of the input. */
icon?: ReactElement | null
Expand Down