Skip to content
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

Jump to bottom

[docs] Improve Autocomplete options prop description #41140

Closed
matthias-ccri opened this issue Feb 17, 2024 · 1 comment · Fixed by #41591
Closed

[docs] Improve Autocomplete options prop description #41140

matthias-ccri opened this issue Feb 17, 2024 · 1 comment · Fixed by #41591
Assignees
@mj12albert
Labels
component: autocomplete This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation support: docs-feedback Feedback from documentation page

Comments

@matthias-ccri
Copy link

matthias-ccri commented Feb 17, 2024 •
edited
Loading

Related page

https://mui.com/material-ui/api/autocomplete/

Kind of issue

Unclear explanations

Issue description

Vague description of the options prop

Screenshot from 2024-02-16 18-59-11

It just says "array of options".

Edit: I get it now... these are the autocomplete options. I was confusing them with component options like configuration props (like native input options or something).

Proposal: say "A list of options that will be shown in the autocomplete"

Context

No response

Search keywords: Autocomplete options
@matthias-ccri matthias-ccri added status: waiting for maintainer These issues haven't been looked at yet by a maintainer support: docs-feedback Feedback from documentation page labels Feb 17, 2024
@matthias-ccri matthias-ccri changed the title [docs] [docs] Improve Autocomplete options prop description Feb 17, 2024
@zannager zannager added the component: autocomplete This is the name of the generic UI component, not the React module! label Feb 18, 2024
@mj12albert mj12albert removed the status: waiting for maintainer These issues haven't been looked at yet by a maintainer label Feb 20, 2024
@mj12albert
Copy link
Member

@matthias-ccri Thanks for reporting this ~ I agree the wording could be improved, would you be interested in creating a PR?

@pluvio72 pluvio72 mentioned this issue Mar 21, 2024
Merged
@ZeeshanTamboli ZeeshanTamboli added the docs Improvements or additions to the documentation label Aug 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mj12albert mj12albert

Labels
component: autocomplete This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation support: docs-feedback Feedback from documentation page
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[docs][material-ui][Autocomplete] Improve the options prop description pluvio72/material-ui
4 participants
@mj12albert @matthias-ccri @ZeeshanTamboli @zannager