department-of-veterans-affairs / va.gov-team

Public resources for building on and in support of VA.gov. Visit complete Knowledge Hub:
https://depo-platform-documentation.scrollhelp.site/index.html
281 stars 202 forks source link

[a11y Support & CAIA Content Support] Consider adding $ and other info to table cells #52594

Open laurwill opened 1 year ago

laurwill commented 1 year ago

CAIA Assignees

Issue Description

Laura Flannery suggested adding more information to table cells to help screen reader users understand what the cell data means. She suggested:

We need to assess the impact of this style update across our tables, decide if other info is useful in cells, and make any needed updates consistently.


Tasks

Acceptance Criteria

sara-amanda commented 1 year ago

@laurwill is this something @coforma-jamie can assist with?

coforma-jamie commented 1 year ago

I can help evaluate this! Could you provide an example of a table with the old pattern?

laurwill commented 1 year ago

Hi @coforma-jamie , this VALife insurance page has the old pattern in the rates tables in the accordions.

coforma-jamie commented 1 year ago

Hi @laurwill, reviewed this a bit.

I definitely recommend adding "$" to dollar amounts. In VoiceOver, adding "$" gives the string some context.

Without "$":

Monthly premium rate for $30,000 coverage (in U.S. dollars), 32 point 70. Row X of Y.

With "$":

Monthly premium rate for $30,000 coverage (in U.S. dollars), 32 dollars and 70 cents. Row X of Y.

Adding "$" tells VO that we're talking about dollars, and so it reads the number off as dollars/cents and not a standard decimal. That seems very helpful to me! It reads similarly in other screen readers (see this Deque article).

As for "age" or "years," I think that's a bit less clear. Compare these two VoiceOver read-outs:

Age when you apply, 31. Row X of Y. Age when you apply, 31 years. Row X of Y.

I can really see that going either way. It's probably not necessary given these examples on WebAIM. The number "31" doesn't read out any differently because you've added "years" to it, like a dollar amount does.

So in short: $ yes, age/years (probably) not.

I hope this is helpful, let me know if you have any questions!

laurwill commented 1 year ago

@coforma-jamie that's very helpful! I agree that the benefit of adding $ is clear, so we'll make that our style going forward. But we don't need to worry about ages, etc.

@strelichl could you open a content backlog ticket to add $ to table cells in existing rates pages? This can be a "chipper" priority ticket that content people can pick up as time allows. Steps would be auditing pages to get a list of tables that need this update, updating the tables in drupal, tagging copy editor to review and publish. We can also note this update in all current and future tickets where we're updating rates, so we make this change at the same time.

And @megzehn I'm not sure if this would go in the style guide or in the design system table component page. Maybe add to list of style guide updates for now?

sara-amanda commented 9 months ago

Changing priority from Low to Chipper per @laurwill comments above:

This can be a "chipper" priority ticket that content people can pick up as time allows. Steps would be auditing pages to get a list of tables that need this update, updating the tables in drupal, tagging copy editor to review and publish. We can also note this update in all current and future tickets where we're updating rates, so we make this change at the same time.

And @megzehn I'm not sure if this would go in the style guide or in the design system table component page. Maybe add to list of style guide updates for now?

@coforma-jamie since you did work on this ticket, feel free to self-assign, so that you receive credit for this work. : )

@coforma-terry @strelichl

megzehn commented 3 months ago

This guidance is now updated in the style guide.

These are some places on live pages where we need to update the table cells:

Current rates pages

Dollar signs added (MZ to add):

Reviewed and published (ST to review):

We should also check on the priority level of updating all past rates pages.