department-of-veterans-affairs / va.gov-team

Public resources for building on and in support of VA.gov. Visit complete Knowledge Hub:
https://depo-platform-documentation.scrollhelp.site/index.html
283 stars 204 forks source link

content in closed accordions aren't findable in browser search #38963

Open xiongjaneg opened 2 years ago

xiongjaneg commented 2 years ago

Issue Description

A VA CMS editor reported that on About VA health benefits "under the first drop down is info about covered inpatient services which list kidney dialysis, a search with the find function (CRTL+F) for dialysis when the dropdown is closed did not produce any results"

This is true of both accordions and additional info

Tabs may be affected too... but as they are depricated in the design system, it is probably not a needed to address them.

The editor was in Chrome.

Front end tasks

Acceptance Criteria

Appendix

Ensure your code changes are covered by E2E tests (expand) - Add E2E tests if none exist for this addition/change. - Update existing E2E tests if this code will change functionality. - Include axe checks, including hidden content
Run axe checks using the Chrome or Firefox browser plugin (expand) - Ensure no heading levels are skipped. - Ensure all buttons and labeled inputs use semantic HTML elements. - Ensure all buttons, labeled elements and images are identified using HTML semantic markers or ARIA roles. - Ensure form fields have clearly defined boundaries or outlines. - Ensure form fields do not use placeholder text. - Ensure form fields have highly visible and specific error states.
Test for color contrast and color blindness issues (expand) - All text has appropriate contrast.
Zoom layouts to 400% at 1280px width (expand) - Ensure readability and usability are supported when zoomed up to 400% at 1280px browser width - Ensure no content gets focused offscreen or is hidden from view.
Test with 1 or 2 screen readers (expand) - Ensure the page includes a skip navigation link. - Ensure all links are properly descriptive. - Ensure screen reader users can hear the text equivalent for each image conveying information. - Ensure screen reader users can hear the text equivalent for each image button. - Ensure screen reader users can hear labels and instructions for inputs. - Ensure purely decorative images are not announced by the screenreader.
Navigate using the keyboard only (expand) - Ensure all links (navigation, text and/or image), form controls and page functions can be reached with the tab key in a logical order. - Ensure all links (navigation, text and/or image), form controls and page functions can be triggered with the spacebar, enter key, or arrow keys. - Ensure all interactive elements can be reached with the tab key in a logical order - Ensure all interactive elements can be triggered with the spacebar, enter key, or arrow keys. - Ensure focus is always visible and appears in logical order. - Ensure each interactive element has visible focus state which appears in logical order.

How to configure this issue

swirtSJW commented 2 years ago

A few notes here.

  1. In the VA design system it would be good to add the requirement for a toggle ALL accordions open or closed button.
  2. There are some solutions for in-page find.
    1. js that fires on ctrl-f that expands all example
    2. Use native features added to Chrome that support expand on find. Article and example <- do cntrl-f for "hello" and watch the appropriate accordion autoexpand