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

[joy-ui][docs] Document missing Autocomplete props #39979

Conversation

ZeeshanTamboli
Copy link
Member

@ZeeshanTamboli ZeeshanTamboli commented Nov 24, 2023

I found that these Autocomplete props are available in Joy UI, but they're not documented on the API page. I observed this during my work on #36426.

We should destructure them inline in the component props for our documentation script to recognize them. I don't see a need for a separate excludeUseAutocompleteParams method.

Preview - https://deploy-preview-39979--material-ui.netlify.app/joy-ui/api/autocomplete/

@ZeeshanTamboli ZeeshanTamboli added docs Improvements or additions to the documentation component: autocomplete This is the name of the generic UI component, not the React module! package: joy-ui Specific to @mui/joy labels Nov 24, 2023
@mui-bot
Copy link

mui-bot commented Nov 24, 2023

Netlify deploy preview

https://deploy-preview-39979--material-ui.netlify.app/

Bundle size report

Details of bundle changes (Toolpad)
Details of bundle changes

Generated by 🚫 dangerJS against bf156be

@ZeeshanTamboli ZeeshanTamboli marked this pull request as ready for review November 24, 2023 10:01
@ZeeshanTamboli
Copy link
Member Author

ZeeshanTamboli commented Dec 13, 2023

Can I get a review on this PR?

Copy link
Contributor

@danilo-leal danilo-leal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great; thanks for working on it! Just dropped a few tiny writing suggestions 😌

@ZeeshanTamboli ZeeshanTamboli merged commit 12f773a into mui:master Dec 13, 2023
22 checks passed
@ZeeshanTamboli ZeeshanTamboli deleted the docs-joy-ui-autocomplete-missing-props-api-documentation branch December 13, 2023 13:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: autocomplete This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation package: joy-ui Specific to @mui/joy
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants