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.

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

[docs][Select] placeholder prop is omitted #44821

Open
thany opened this issue Dec 20, 2024 · 2 comments
Open

[docs][Select] placeholder prop is omitted #44821

thany opened this issue Dec 20, 2024 · 2 comments
Assignees
Labels
component: select This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation scope: docs-infra Specific to the docs-infra product support: docs-feedback Feedback from documentation page

Comments

@thany
Copy link

thany commented Dec 20, 2024

Related page

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

Kind of issue

Missing information

Issue description

Following issue #44502, the placeholder prop has been removed from the Select component for having no effect. While I'm inclined to disagree (MUI could render a placeholder, and the Select documentation event suggests on how to render one) the API documentation should at least reflect that decision.

As of the time of writing, the Select API documentation makes no mention of the omission of the placeholder prop. In fact, it refers to OutlinedInput:

Props of the OutlinedInput component are also available.

Which is where it is rightfully listed, leading developers to believe it should be available in Select.

I was ready to file a bug report, but having found that issue, I discovered placeholder was omitted intentionally. At first I went to the documentation to figure out what's what with this prop, but no mention of it was made, which lead me to create the issue you're reading now.

Context

No response

Search keywords: select placeholder

@thany thany added status: waiting for maintainer These issues haven't been looked at yet by a maintainer support: docs-feedback Feedback from documentation page labels Dec 20, 2024
@aarongarciah
Copy link
Member

@thany thanks for reporting! We should update the docs to reflect this.

@aarongarciah aarongarciah changed the title [docs] Select placeholder prop is omitted [docs][Select] placeholder prop is omitted Dec 24, 2024
@aarongarciah aarongarciah added the ready to take Help wanted. Guidance available. There is a high chance the change will be accepted label Dec 24, 2024
@aarongarciah aarongarciah removed the ready to take Help wanted. Guidance available. There is a high chance the change will be accepted label Dec 26, 2024
@ZeeshanTamboli ZeeshanTamboli added docs Improvements or additions to the documentation component: select This is the name of the generic UI component, not the React module! and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer labels Dec 27, 2024
@aarongarciah aarongarciah added the scope: docs-infra Specific to the docs-infra product label Dec 27, 2024
@aarongarciah
Copy link
Member

#44856 updated the Select docs page with a callout to point out that the placeholder prop is not available in Select.

The Select API docs page still needs to be updated, but it probably requires some docs infra work as the info for what props from the component it inherits from are part of an abstraction: https://mui.com/material-ui/api/select/#props

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: select This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation scope: docs-infra Specific to the docs-infra product support: docs-feedback Feedback from documentation page
Projects
None yet
Development

No branches or pull requests

3 participants