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

USWDS - Feature: Add instructions to search component #3074

Open
2 tasks done
amycole501 opened this issue May 23, 2024 · 3 comments
Open
2 tasks done

USWDS - Feature: Add instructions to search component #3074

amycole501 opened this issue May 23, 2024 · 3 comments
Assignees
Labels
A11Y Audit Findings Findings from the accessibility audit Package: Search Status: Triage We're triaging this issue and grooming if necessary Type: Feature Request New functionality

Comments

@amycole501
Copy link

Is your feature request related to a problem? Please describe.

The search component needs to clarify what type of content is being searched. I suggest we add "search site" or "search directory" or other example help text to clarify what it is the person is searching.

Some webpages may have more than one search on a page (site search, directory search). Without clear instructions and labels, a someone could be confused as to what results to expect from each search.

Describe the solution you'd like

On the search component page I recommend we add labels or instructions in our example code. This would allow teams to know to specify what content the search component is indexing.

The labels need to be persistent (i.e. not helper text only).

This enhancement follows WCAG's guidance on labels and instructions.

Describe alternatives you've considered

No response

Additional context

No response

Code of Conduct

@amycole501 amycole501 added Type: Feature Request New functionality A11y Audit Issues related to the accessibility audit labels May 23, 2024
@github-actions github-actions bot added the Status: Triage We're triaging this issue and grooming if necessary label May 23, 2024
@mahoneycm
Copy link
Contributor

On the component side of this, what do you think this should look like?

We'll need a label for screen readers. How should the visual instructions be presented? I was considering placeholders but I know those aren't great for usability 🤔

@amycole501
Copy link
Author

I'd suggest it look something like this with the visible label above the field
image

This guidance may only need to be for pages where there are more than one search components. In that case I'd suggest the second, non-template version of the search be the one with a unique label.

@brunerae brunerae removed the Status: Triage We're triaging this issue and grooming if necessary label May 30, 2024
@brunerae brunerae transferred this issue from uswds/uswds May 30, 2024
@github-actions github-actions bot added the Status: Triage We're triaging this issue and grooming if necessary label May 30, 2024
@brunerae brunerae removed the Status: Triage We're triaging this issue and grooming if necessary label May 30, 2024
@brunerae brunerae added the A11Y Audit Findings Findings from the accessibility audit label Sep 11, 2024
@amycole501 amycole501 transferred this issue from uswds/uswds-site Jan 8, 2025
@github-actions github-actions bot added the Status: Triage We're triaging this issue and grooming if necessary label Jan 8, 2025
@mejiaj mejiaj removed Status: Triage We're triaging this issue and grooming if necessary A11y Audit Issues related to the accessibility audit labels Jan 23, 2025
@mejiaj mejiaj transferred this issue from uswds/uswds Jan 23, 2025
@github-actions github-actions bot added the Status: Triage We're triaging this issue and grooming if necessary label Jan 23, 2025
@mejiaj
Copy link
Contributor

mejiaj commented Jan 23, 2025

@amycole501 to discuss in UX sync to come up with guidance to add the appropriate language.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A11Y Audit Findings Findings from the accessibility audit Package: Search Status: Triage We're triaging this issue and grooming if necessary Type: Feature Request New functionality
Projects
Status: Ready to Schedule
Development

No branches or pull requests

4 participants