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

Added the ability to add victory charts title and desc props for better accessibility #2199

Merged

Conversation

shankstee
Copy link

@shankstee shankstee commented Apr 19, 2022

The Problem:

  • When running the Chrome/Edge Accessibility Insights tool, the VictoryCharts component throws the error below due to missing alternate text:
    image

The solution:

  • Added the ability to add a title and description to the VictoryChart svg component:
    image

image

Tested

  • Tested manually by adding the new title and description props to some of the VictoryCharts components within the victory-chart-demo.js file and running the accessibility tool:
    image

All VictoryChart components with the new title and desc props present pass with no errors, while the rest still fail.

This PR is created to resolve this issue: #2078
Accessibility tool: https://chrome.google.com/webstore/detail/accessibility-insights-fo/pbjjkligggfmakdaogkfomddhfmpjeni?msclkid=e63b5c6bc02e11ec9e1dd5de91f4d99d

@shankstee shankstee changed the title Bugfix/st victory charts title and desc Added the ability to add victory charts title and desc props for better accessibility Apr 19, 2022
@becca-bailey
Copy link
Contributor

Thanks @shankstee, looks good to me! There was also some work in #2191 that addressed this issue, but we must not have fixed VictoryChart yet. I'll get this merged once CI is passing.

@becca-bailey
Copy link
Contributor

@shankstee It looks like CI is failing on formatting. Do you mind running yarn nps format and pushing up again? Thanks!

@shankstee
Copy link
Author

@shankstee It looks like CI is failing on formatting. Do you mind running yarn nps format and pushing up again? Thanks!

Done. Thank you @becca-bailey!

@becca-bailey becca-bailey merged commit a5cc624 into FormidableLabs:main Apr 26, 2022
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.

2 participants