Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A11y Feedback: Data grid - Row header documentation #1393

Open
orion-cengage opened this issue Aug 21, 2024 · 1 comment
Open

A11y Feedback: Data grid - Row header documentation #1393

orion-cengage opened this issue Aug 21, 2024 · 1 comment
Labels
a11y Issues related to accessibility react-magma-docs Improvements or additions to documentation

Comments

@orion-cengage
Copy link
Contributor

CENG_1954

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

Issue:

In some cases depending on how a table is used, the first column might have information inside of it that would constitute a row header. In these cases developers should use the <th> element along with scope="row" to define the headers scope. This will ensure that screen readers announce the content inside of the row header before announcing the content in the corresponding cells.

Suggestion:

Consider providing an example of a table with row headers and / or guidance for developers to help them determine when and how to define a row header.

@orion-cengage orion-cengage added react-magma-docs Improvements or additions to documentation a11y Issues related to accessibility labels Aug 21, 2024
@silvalaura
Copy link
Collaborator

From Leslie:

(In the docs site) I see this great example of column headers. But I do not see an example of row headers, even though the props ARE provided: TableRow Props. Wondering if we could put an example in that location also?

Here is the example from the Assessment Overview that needs row headers. Notice that 1 of 3, 2 of 3, 3 of 3 are important for the student to know which scores they are looking at.
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a11y Issues related to accessibility react-magma-docs Improvements or additions to documentation
Projects
Status: To Do
Development

No branches or pull requests

2 participants