mui / mui/material-ui

[autocomplete][docs] Playground Examples are... too similar?

Open
#38,549 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

docs scope: autocomplete
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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.