[Docs] Better communicate when it's appropriate to use `SearchField` component variants
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 140
- Forks
- 100
- Avg merge
- 1h 3m
- Merged PRs (30d)
- 30
Description
https://paragon-openedx.netlify.app/components/searchfield/
The top example on the docs site shows
In this screenshot:
- The user has typed "test"
- The 🔍 icon has disappeared
- The ❌ icon is the only thing that displays
- No search has happened (only
onSubmitis wired up, nothing has been submitted)
This example of the component would be fine with search-on-type, but leaving the user in a state of having typed in a query, not searched using the query, and only seeing the ❌ icon isn't reasonable
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 SearchField documentation page linked in the issue and review the top example, including its onSubmit behavior and the displayed search and clear icons. Update the documentation to explain when each SearchField variant is appropriate and make the example's interaction expectations clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100