patternfly / patternfly/patternfly-react
DescriptionList - heading level and heading element invalid in examples
Personne n'a encore pris cette issue.
- Langage dominant
- TypeScript
- Étoiles
- 862
- Forks
- 392
- Merge moyen
- 4 j 8 h
- PR mergées (30 j)
- 9
Description
Describe the problem
This ranges from example code update to component update:
-
For the Popover that triggers when clicking the term help text, the heading level is not correct for where it is rendered in the DOM. Either the heading should be an
h1element, or the Popover needs to be appended in a way that the currenth6is correct. -
For the Popover that triggers when clicking the term help text, axe complains about multiple banner landmarks. This is due to the Popover being appended to the document body and outside the
mainelement; whenever aheaderis rendered outside of it, it becomes a banner landmark. Some ways to fix this could be:- update the element to a plain div
- change where the Popover is appended (could also help resolve the first issue above)
- since the Popover traps focus and has attributes similar to a Modal, all other content on the page gets set to aria-hidden="true", similar behavior to the Modal component. This might be an issue since we don't render a Backdrop for Popover like we do for Modal, though, so it may not be totally clear that content outside the Popover cannot be interacted with. Also, unlike Modal, you can click outside the Popover to close it, which may not make the
aria-modal="true"attribute totally correct.
How do you reproduce the problem?
Provide steps to reproduce. A codesandbox demonstrating the problem is appreciated.
Expected behavior
A clear and concise description of the expected behavior.
Is this issue blocking you?
List the workaround if there is one.
Screenshots
If applicable, add screenshots to help explain the issue.
What is your environment?
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
What is your product and what release date are you targeting?
Any other information?
Jira Issue: PF-1132
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par le CodeSandbox lié et inspectez les exemples de DescriptionList ainsi que le Popover généré à partir du texte d’aide du terme. Vérifiez le DOM obtenu et les résultats d’axe, puis corrigez les problèmes de niveau de titre et de plusieurs landmarks de type banner, tout en préservant le comportement documenté du Popover ; mettez à jour les exemples concernés et vérifiez que les contrôles d’accessibilité passent.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- react, typescript
- Domaine
- accessibility, frontend
- Type d'issue
- Bug
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 35/100