patternfly / patternfly/patternfly-react
DescriptionList - heading level and heading element invalid in examples
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- TypeScript
- Estrellas
- 862
- Forks
- 392
- Merge medio
- 4 d 8 h
- PR fusionados (30 d)
- 9
Descripción
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
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con el CodeSandbox enlazado e inspecciona los ejemplos de DescriptionList y el Popover renderizado a partir del texto de ayuda del término. Comprueba el DOM resultante y los hallazgos de axe; después, resuelve los problemas del nivel de encabezado y de múltiples landmarks de banner, preservando el comportamiento documentado del Popover. Actualiza los ejemplos afectados y verifica que las comprobaciones de accesibilidad pasen.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- react, typescript
- Área
- accessibility, frontend
- Tipo de issue
- Error
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 35/100