aria-practices icon indicating copy to clipboard operation
aria-practices copied to clipboard

Feature: Search for patterns, toggle grid/list view

Open stalgiag opened this issue 1 year ago • 4 comments

see #2534

This PR adds an input to the patterns index page that filters the patterns as you type. Additionally, a toggle is added that allows users to switch between a list and a grid view for the patterns.

Build repo PR

View an example of this at Build repo's netlify preview provided link. This WAI Preview link will fail to build until wai-aria-practices#1234 is also merged


WAI Preview Link (Last built on Tue, 02 Jul 2024 22:32:14 GMT).

stalgiag avatar Jun 18 '24 22:06 stalgiag

@mcking65 @a11ydoer could you also review this work on the deploy preview's patterns page?

howard-e avatar Jun 24 '24 14:06 howard-e

This is great, really looks good to me! Thanks for tackling this task. I only have a few comments:

  • The suggestion for an accessible h2 from this comment and this comment are missing. Could those still be added?
  • When doing a search with no valid results, I'd prefer some indication of that be shown, eg. No results found or similar. What do you think? I've attached a screenshot below which just shows a blank area

screenshot showing empty results area when using a query that can't be found

Nice call. Didn't notice those comments, too focused on the mockup. Also agree with the need for a "no results" element.

First handled by 4b0a408 & 5626c7b and accompanying build repo commits.

Second addressed in eaf3f2deaf3f2d and accompanying build repo commits.

Screenshot showing an h2 that says No results found when there are no matches

stalgiag avatar Jun 24 '24 18:06 stalgiag

The ARIA Authoring Practices (APG) Task Force just discussed New patterns page filter.

The full IRC log of that discussion <jugglinmike> Topic: New patterns page filter
<jugglinmike> github: https://github.com/w3c/aria-practices/pull/3043
<jugglinmike> Jem: This is awesome!
<jugglinmike> Matt_King: I have a few questions
<jugglinmike> Matt_King: It seems like the filter happens dynamically as you type. That how it feels to me as a screen reader user
<jugglinmike> Matt_King: I didn't have to press the "submit" button, so I don't know what the purpose of the "submit" button is
<jugglinmike> Matt_King: Are there any circumstances where you need that button?
<jugglinmike> howard-e: It doesn't seem like there is a need for that button
<jugglinmike> Matt_King: I do think that a button labeled "Clear Filter" would be very useful. Without it, in order to see all the patterns again, you have to select all the text and delete it
<jugglinmike> arigilmore: Carbon offers a feature like this using an "X" button inside the search bar
<jugglinmike> Matt_King: The "clear" button is visually inside the search bar, but not in terms of the DOM, right?
<jugglinmike> arigilmore: That's right
<arigilmore> https://carbondesignsystem.com/components/search/code
<jugglinmike> Matt_King: We should change the placeholder text to read "Filter patterns"
<jugglinmike> Jem: Maybe the heading should read "Search patterns" instead of "Filter"
<jugglinmike> Matt_King: That may be misleading. Some folks may read the worth "Search" and expect that their query will be evaluated against the entire content of each pattern
<jugglinmike> Matt_King: As it stands, the query is only matching against the titles of the patterns that are present on the page
<jugglinmike> Matt_King: I think that's more generally recognized as a "filter" operation
<jugglinmike> Jem: Okay; could we also change the heading to "Filter patterns" instead of just "Filter"?
<jugglinmike> Matt_King: Sure

css-meeting-bot avatar Jun 25 '24 18:06 css-meeting-bot

Updates based on @isaacdurazo 's mockups from the feedback in the APG Task Force meeting:

  • Remove submit search button
  • Clear button based on this UX
  • "Filter patterns" for placeholder and h2

stalgiag avatar Jul 02 '24 23:07 stalgiag

cc @a11ydoer @mcking65 this should be ready for your review again

howard-e avatar Jul 10 '24 13:07 howard-e

@a11ydoer if you agree it is ready to ship, I will merge.

mcking65 avatar Jul 27 '24 23:07 mcking65

@stalgiag thank you for all the work on this! We finally have this long-awaited feature!

mcking65 avatar Jul 30 '24 07:07 mcking65