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

[Autocomplete][docs] Playground Examples are... too similar? #38549

Open
1 task done
AlbinoGeek opened this issue Aug 19, 2023 · 3 comments
Open
1 task done

[Autocomplete][docs] Playground Examples are... too similar? #38549

AlbinoGeek opened this issue Aug 19, 2023 · 3 comments
Assignees
Labels
component: autocomplete This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation

Comments

@AlbinoGeek
Copy link

Duplicates

  • I have searched the existing issues

Related page

https://mui.com/material-ui/react-autocomplete/#playground

Kind of issue

Unclear explanations

Issue description

While exploring the Autocomplete component's documentation, I noticed the playground playground section (https://mui.com/material-ui/react-autocomplete/#playground) doesn't seem to adequately demonstrate the differences between the various properties.

Most of the examples, irrespective of the selected properties, appear functionally identical. This makes it challenging to discern the unique behaviors and benefits of each property just from the playground.

I typed "as" in every one of the fields, and the same list of options was presented, even with the "includeInputInList" examples, which I would have expected to add "as" into the options list; did not appear to do anything differently from the others.

Context 🔦

No response

@AlbinoGeek AlbinoGeek added status: waiting for maintainer These issues haven't been looked at yet by a maintainer support: docs-feedback Feedback from documentation page labels Aug 19, 2023
@zannager zannager added the component: autocomplete This is the name of the generic UI component, not the React module! label Aug 21, 2023
@michaldudak
Copy link
Member

Thanks for your feedback. We feel the need to overhaul Autocomplete docs as well.
cc @samuelsycamore

@michaldudak michaldudak added docs Improvements or additions to the documentation and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer support: docs-feedback Feedback from documentation page labels Aug 21, 2023
@oliviertassinari
Copy link
Member

oliviertassinari commented Aug 21, 2023

@AlbinoGeek How does this one feel in comparison https://mui.com/joy-ui/react-autocomplete/#introduction?

For me, this is a perfect use case for a playground with buttons to click, it's all about behavior, so you will need to click on stuff anyway, and plus, it explains what each prop is about. The only thing missing (and important) is to see the source.

@AlbinoGeek
Copy link
Author

@AlbinoGeek How does this one feel in comparison https://mui.com/joy-ui/react-autocomplete/#introduction?

For me, this is a perfect use case for a playground with buttons to click, it's all about behavior, so you will need to click on stuff anyway, and plus, it explains what each prop is about. The only thing missing (and important) is to see the source.

I think the playground is a wonderful approach, and would ease the learning curve for new users of the framework.

However, it seems as if some of the options are either wrong or counter to the default behavior. For example, if you select nothing, and use the auto complete as is, select on focus at least as it is described, happens whether or not it is checked.

There are a few other things, but it is hard to test on mobile. And if that matters, I'm on mobile for this message.

@oliviertassinari oliviertassinari changed the title [docs] [Autocomplete] Playground Examples are... too similar? [Autocomplete][docs] Playground Examples are... too similar? Sep 1, 2023
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
Projects
None yet
Development

No branches or pull requests

4 participants