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

Add Role to Block Quote Table Elements in Email Templates #178

Open
4 tasks
EvanParish opened this issue Oct 1, 2024 · 2 comments
Open
4 tasks

Add Role to Block Quote Table Elements in Email Templates #178

EvanParish opened this issue Oct 1, 2024 · 2 comments

Comments

@EvanParish
Copy link

EvanParish commented Oct 1, 2024

User Story - Business Need

We want to update the template formatting in our utils repo for block quotes. For accessibility reasons, we want all <table> tags to include role="presentation". When block quotes are added, a table is created in the template. We need to ensure the proper role is added when this happens.

  • Ticket is understood, and QA has been contacted (if the ticket has a QA label).

User Story(ies)

As a Veteran
I want to be able to access my email via a screen reader
So that I can get the provided information accessibly and accurately.

Additional Info and Resources

  • The html email body is created using the get_html_email_body function.
  • This task can be accomplished by editing the NotifyEmailMarkdownRenderer or creating a post-processing function to be called as part of get_html_email_body function using regex.
    • Editing the renderer would involve adding more custom features to Mistune, which could make the upgrade more difficult.
    • A post-processing function would involve finding the table elements when block quotes exist and adding the requested role. This can be accomplished with regex trickery.
  • ARIA: presentation role
  • The code changes might be as easy as adding the new style here.

Acceptance Criteria

  • When block quote "tables" exist in a template they include role="presentation"
  • This work is added to the sprint review slide deck (key win bullet point and demo slide)

QA Considerations

  • Ensure template previews and sent include role="presentation" in all block quote table tag properties.

Potential Dependencies

Out of Scope

@EvanParish EvanParish changed the title Add Role to List Elements in Email Templates Add Role to Block Quote Table Elements in Email Templates Oct 1, 2024
@cris-oddball
Copy link

@EvanParish is there some sort of figma drawing (or any mock) that shows what this is supposed to look like in a template?

@npmartin-oddball
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants