search

cengage / react-magma

https://react-magma.cengage.com
MIT License
21 stars 12 forks source link

A11y Fail: Table + Data grid - Need to use Caption as title of table #1395

Open orion-cengage opened 3 weeks ago

orion-cengage commented 3 weeks ago

CENG_1953

https://react-magma.cengage.com/version/4.5.0/api/datagrid/

https://react-magma.cengage.com/version/4.5.0/api/table/

Issue:

It is a best practice to ensure that all <table> elements have a <caption> element. A caption functions like a heading for a table. Most screen readers announce the content of captions. Captions help users to find a table and understand what it’s about and decide if they want to read it. If the user uses “Tables Mode”, captions are the primary mechanism to identify tables.

Suggestion:

We need to document and make it easy for devs to use "caption" attribute to title tables and data grids. Additionally, we need to let them know if they want the caption to also be a heading within the structure of the page, they can do both at the same time.

<table><caption><h2>This is the title of the table</h2></caption>...

silvalaura commented 3 weeks ago

We should add a new prop to Table and DataGrid to accept a heading node. We should provide default styling, but we should support any heading type.