patternfly / patternfly/patternfly-react
Bug - [Popover] - [accessibility issues with footer, header, and heading]
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 862
- Forks
- 392
- Avg merge
- 4d 8h
- Merged PRs (30d)
- 9
Description
Describe the problem
Accessibility issues for Popover element:
- with
footerContentprop - with
headerContentprop - with default value
h6ofheaderComponentprop
Heading levels should only increase by one
https://dequeuniversity.com/rules/axe/4.9/heading-order
<h6 class="pf-v5-c-popover__title-text"><div>Popover header</div></h6>
Document should not have more than one banner landmark
https://dequeuniversity.com/rules/axe/4.9/landmark-no-duplicate-banner
<header class="pf-v5-c-masthead pf-m-display-inline ws-masthead">
Related node:
<header class="pf-v5-c-popover__header"><div class="pf-v5-c-popover__title" id="popover-pf-17234753664484trsgdfq2md-header"><h6 class="pf-v5-c-popover__title-text"><div>Popover header</div></h6></div></header>
Document should not have more than one contentinfo landmark
https://dequeuniversity.com/rules/axe/4.9/landmark-no-duplicate-contentinfo
<footer class="pf-v5-c-page__main-section ws-org-pfsite-l-footer">
Related node:
<footer class="pf-v5-c-popover__footer" id="popover-pf-17234753664484trsgdfq2md-footer">Popover footer</footer>
Ensures landmarks are unique
https://dequeuniversity.com/rules/axe/4.9/landmark-unique
<header class="pf-v5-c-masthead pf-m-display-inline ws-masthead">
Related node:
<header class="pf-v5-c-popover__header"><div class="pf-v5-c-popover__title" id="popover-pf-17234753664484trsgdfq2md-header"><h6 class="pf-v5-c-popover__title-text"><div>Popover header</div></h6></div></header>
<footer class="pf-v5-c-page__main-section ws-org-pfsite-l-footer">
Related node:
<footer class="pf-v5-c-popover__footer" id="popover-pf-17234753664484trsgdfq2md-footer">Popover footer</footer>
How do you reproduce the problem?
- Visit https://www.patternfly.org/components/popover/#basic
- Click Toggle popover button.
- Scan page with axe DevTools and ignore the last issue as irrelevant.
Expected behavior
Render markup that passes axe DevTools rules.
Is this issue blocking you?
No, we will fix 10 occurrences as follows:
- Move occurrences of
footerContent, orheaderContent, or both, to props of a pure presentation component that composes them withbodyContentand returns markup forbodyContentprop ofPopoverelement. That is, replacefooterandheaderelements withdivelements that have PatternFly classes for same visual appearance. - Render (instead of heading element)
pelement that has PatternFly class for same visual appearance, but takes out of heading hierarchy of page. Similar solution as our workaroundcomponent="p"prop forAlertelements that do not seem to fit heading hierarchy of page.
Screenshots
What is your environment?
- OS: macOS 14.6.1
- Browser: Chrome 127
- PatternFly: react-core 5.2.2
What is your product and what release date are you targeting?
Red Hat Advanced Cluster Security
Any other information?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Popover component and the basic Popover example at patternfly.org/components/popover/#basic, then reproduce the reported violations with axe DevTools. Update the ten occurrences so footer and header content use non-landmark presentation markup and the default header no longer adds an inappropriate heading level; done means the reported axe rules pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- accessibility, frontend
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100