[Autocomplete] Add note in JSDoc for non-TextField components in renderInput
#46141
Conversation
This file contains hidden or 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
This addition provides a clear warning to developers about the limitations of the renderInput prop, helping them avoid common pitfalls. Signed-off-by: khllbnomrn <[email protected]>
khllbnomrn
changed the title
ZeeshanTamboli
added
component: autocomplete
ZeeshanTamboli
changed the title
renderInput
ZeeshanTamboli
changed the title
renderInputrenderInput
Netlify deploy previewhttps://deploy-preview-46141--material-ui.netlify.app/ Bundle size report |
ZeeshanTamboli
changed the title
renderInputrenderInput
ZeeshanTamboli
changed the title
renderInputrenderInput
ZeeshanTamboli
approved these changes
May 14, 2025
There was a problem hiding this comment.
@khllbnomrn I made some changes in the wording. Thanks for the PR!
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.
This PR improves the documentation of the Autocomplete component by adding a warning to the renderInput prop's JSDoc. It clarifies that developers should not return non-TextField components (e.g. DatePicker, Select) directly inside renderInput. issue mui/mui-x#17832
I have followed (at least) the PR section of the contributing guide.
Preview: https://deploy-preview-46141--material-ui.netlify.app/material-ui/api/autocomplete/#autocomplete-prop-renderInput