[Autocomplete] Update autoSelect prop description
#36280
Conversation
Netlify deploy previewhttps://deploy-preview-36280--material-ui.netlify.app/ Bundle size report |
| * | ||
| * Set to `true` if you want to save the value when input looses focus. | ||
| * Set to `false` if you don't want to save the value when input looses focus. | ||
| * @default false |
There was a problem hiding this comment.
kept default value as false to not break existing behaviour
| @@ -935,7 +936,7 @@ export default function useAutocomplete(props) { | |||
|
|
|||
| if (autoSelect && highlightedIndexRef.current !== -1 && popupOpen) { | |||
| selectNewValue(event, filteredOptions[highlightedIndexRef.current], 'blur'); | |||
| } else if (autoSelect && freeSolo && inputValue !== '') { | |||
| } else if ((autoSelect || saveOnBlur) && freeSolo && inputValue !== '') { | |||
There was a problem hiding this comment.
@sai6855 This makes me think why not use autoSelect?
There was a problem hiding this comment.
@siriwatknp In reality, using autoSelect to save inputValue on blur works, but description of autoSelect in docs says, autoSelect adds highlighted option to value. docs nowhere indicates autoSelect adds inputValue to value. so maybe should we update docs instead of adding new prop?
There was a problem hiding this comment.
If we go in updation of autoSelect prop description direction, it would be great if you can provide appropriate description, just to avoid further confusion
There was a problem hiding this comment.
From what I tested, adding a description sounds better than adding one more prop that likely does the same thing.
What do you think about this:
/**
* If `true`, the selected option becomes the value of the input
* when the Autocomplete loses focus unless the user chooses
* a different option or changes the character string in the input.
*
* In addition of `freeSolo` mode, the selected option will the input value
* if the Autocomplete loses focus without highlighing an option.
* @default false
*/
autoSelect?: boolean;There was a problem hiding this comment.
- In addition of
freeSolomode, the selected option will the input value- if the Autocomplete loses focus without highlighing an option.
this part is bit unclear to me, if the Autocomplete loses focus **without** highlighing an option then which option will be the value of input as none of options are highlighted ?
should it be ?
* In addition of `freeSolo` mode, the typed value will be the input value
* if the Autocomplete loses focus without highlighing an option.
There was a problem hiding this comment.
@siriwatknp updated description
zannager
added
the
component: autocomplete
github-actions
bot
added
the
PR: out-of-date
github-actions
bot
removed
the
PR: out-of-date
sai6855
changed the title
saveOnBlur propautoSelect prop description
sai6855
changed the title
autoSelect prop descriptionautoSelect prop description
| @@ -66,6 +66,9 @@ export interface UseAutocompleteProps< | |||
| * If `true`, the selected option becomes the value of the input | |||
| * when the Autocomplete loses focus unless the user chooses | |||
| * a different option or changes the character string in the input. | |||
| * | |||
| * In addition of `freeSolo` mode, the typed value will be the input value | |||
There was a problem hiding this comment.
I don't think I understand what this is saying. Is it meant to be "In addition to freeSolo mode", or "When using freeSolo mode"?
There was a problem hiding this comment.
i think when using freeSolo mode sounds much better, as autocomplete saves typed value only in freeSolo mode
There was a problem hiding this comment.
ok that makes sense to me now, thanks!
There was a problem hiding this comment.
@samuelsycamore updated prop description in this commit 4e0edd0
closes #30521