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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add accDescription field to state diagrams #2917

Merged
merged 7 commits into from Apr 12, 2022

Conversation

therzka
Copy link
Contributor

@therzka therzka commented Apr 7, 2022

馃搼 Summary

This PR furthers the effort to make charts accessible (#2732) by adding a accDescription field with the end effect of adding a aria-label-by node in the state diagram SVG. This PR additionally adds a title field, since this is what is expected by the functions in accessibility.js, but does not yet actually display the title. I can add this in a followup PR.

image

馃搹 Design Decisions

Same implementation as #2747

I've also added tests for the stateDiagram-v2 renderer since they didn't exist, and added an example page using both renderers

馃搵 Tasks

Make sure you

  • 馃摉 have read the contribution guidelines
  • 馃捇 have added unit/e2e tests (if appropriate)
  • 馃敄 targeted develop branch

@therzka therzka marked this pull request as ready for review April 8, 2022 18:02
@knsv knsv changed the title Add accDescription field to state diagrams feat: add accDescription field to state diagrams Apr 12, 2022
Copy link
Collaborator

@knsv knsv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR. Appreciate that you also added tests! 馃憤

@knsv knsv merged commit 7aa037e into mermaid-js:develop Apr 12, 2022
@gwincr11 gwincr11 mentioned this pull request Apr 12, 2022
9 tasks
@knsv knsv mentioned this pull request May 6, 2022
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants