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

DSD-1877: Filtering Style Guide #1712

Open
wants to merge 11 commits into
base: development
Choose a base branch
from

Conversation

bigfishdesign13
Copy link
Collaborator

@bigfishdesign13 bigfishdesign13 commented Dec 9, 2024

Fixes JIRA ticket DSD-1877

This PR does the following:

  • Adds the Filtering page to the Style Guide.

How has this been tested?

  • local Storybook

Accessibility concerns or updates

  • n/a

Accessibility Checklist

  • Checked Storybook's "Accessibility" tab for color contrast and other issues.
  • The feature works with keyboard inputs including tabbing back and forward and pressing space, enter, arrow, and esc keys.
  • For hidden text or when aria-live is used, a screenreader was used to verify the text is read.
  • For features that involve UI updates and focusing on DOM refs, focus management was reviewed.
  • The feature works when the page is zoomed in to 200% and 400%.

Open Questions

Checklist:

  • I have updated the Storybook documentation and changelog accordingly.
  • I have added relevant accessibility documentation for this pull request.
  • All new and existing tests passed.

Front End Review:

  • Review the Vercel preview deployment once it is ready.

Copy link

vercel bot commented Dec 9, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
nypl-design-system ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 9, 2024 9:05pm

Copy link
Member

@EdwinGuzman EdwinGuzman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are great. Thank you for writing this and the imagery makes the docs easy to read. Do you think we need some gifs with examples on doc pages such as the accessibility for focus management? Another example, on the pagination page, it could use information about where focus should go after a button is clicked (the total results heading). Focus management is something that comes up a lot so I want to make it clear what our recommendation for that is as well.

Before approving, I want all FE devs to read through this, make sure they understand the approach, and approve it since it's a guideline for their apps: @7emansell @dgcohen @avertrees @charmingduchess @jackiequach @isastettler @Toxiapo

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you create a Filtering subfolder in StyleGuide for all these files? Then you don't have to repeat the prefix for every file.

Comment on lines +50 to +53
## Clearing filters

Filters can be cleared using various methods within the page structure,
including global methods as well as methods for clearing individual filters.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm curious: If a user searches for a term and applies some filters, but then continues typing in the search box without clearing the filters, should the filters be reset? Not sure if this is a accessibility question or a product question.

Comment on lines +30 to +32
## Focus management

### Applying search terms
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We’ll eventually need to build a custom filtering modal (we’re currently using an Ionic component) for the Reader, and this will be a great reference for accessibility!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree, great to see these AC consolidated here.


### Mobile

For mobile viewports, the filter bar will display a "Show result" button and can
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this say "Show results"?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs Review Pull requests that are ready for peer review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants