mui / mui/material-ui

[Web][Docs] Search bar content without search string in v5 documentation page

Open
#29,443 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs scope: all components
Dominant language
JavaScript
Stars
99.1k
Forks
32.5k
Avg merge
2d 17h
Merged PRs (30d)
106

Description

  • I have searched the issues of this repository and believe that this is not a duplicate.

Summary 💡

Examples 🌈

I would like to have some (limited) access to your prototyping tool like https://siriwatknp.github.io/mui-docsearch/ to make it clearer and easier during the communication.

  • Old correct behavior
    Old correct behavior

  • Current (mis-)behavior
    Current (mis-)behavior

  • Expected behavior
    Expected behavior

  • In Expected behavior, that ugly thing should be a better designed button acts like a search result.

Motivation 🔦

Usability: to make search easier

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 by reviewing the v5 documentation page search bar behavior, the linked original issue, and the attached old, current, and expected examples. Determine the agreed empty-search guide and content changes before editing. Done means the empty search state shows the intended guide or result-like button without requiring typed text to be deleted.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation, search, web-dev
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.