[autocomplete][docs] Playground Examples are... too similar?
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 99.1k
- Forks
- 32.5k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 106
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Autocomplete Playground page at https://mui.com/material-ui/react-autocomplete/#playground and compare the examples for the different properties. Determine how each example should visibly demonstrate its property, then update the documentation so the examples have distinct, understandable behavior and verify that the listed properties are observable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation, frontend
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100