-
Notifications
You must be signed in to change notification settings - Fork 7
DSD-1901: Remove role="search"
from Searchbar
#1807
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
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All looks good, but a minor request on the doc page.
| ----------------- | ---------- | | ||
| Added | `0.0.4` | | ||
| Latest | `3.6.1` | | ||
| Component Version | DS Version | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since you're already updating this doc page.... can you include the new layout styles? Use the ComponentDocsHeader
component and check Banner
(https://nypl-design-system-git-reservoir-v4-nypl.vercel.app/?path=/docs/components-feedback-banner--docs) for an example of the new order for storybook doc pages.
<ComponentDocsHeader | ||
category="Form element" | ||
componentName="SearchBar" | ||
summary="A form container with text input and button that submits a search query" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤨 Don't know if this is a valid summary
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or something along the lines of "a multi-component based UI for searching..." @bigfishdesign13 ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not too concern about the summary right now.
<ComponentDocsHeader | ||
category="Form element" | ||
componentName="SearchBar" | ||
summary="A form container with text input and button that submits a search query" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or something along the lines of "a multi-component based UI for searching..." @bigfishdesign13 ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me, but the ticket says "document how should be used instead." Does this mean should be used instead of role="search"
? Are we no longer recommending that?
We're still recommending using role = search (in #1806) but rarely (if ever) would it be correctly used on just the |
Fixes JIRA ticket DSD-1901
This PR does the following:
search
role fromSearchbar
component wrapperHow has this been tested?
Accessibility concerns or updates
search
landmark correctly (usually includes more elements than just theSearchbar
)Accessibility Checklist
aria-live
is used, a screenreader was used to verify the text is read.ref
s, focus management was reviewed.Open Questions
Checklist:
Front End Review: