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

Allow passing description props to <canvas> element #1097

Closed
myasonik opened this issue Mar 30, 2021 · 1 comment · Fixed by #1111 or elastic/kibana#97005
Closed

Allow passing description props to <canvas> element #1097

myasonik opened this issue Mar 30, 2021 · 1 comment · Fixed by #1111 or elastic/kibana#97005
Assignees
Labels
:accessibility Accessibility related issue bug Something isn't working released Issue released publicly

Comments

@myasonik
Copy link

Describe the bug

There is no way to set aria-describedby on a chart.

Notes on implementation

  • With the end goal being something akin to this demo, I'd recommend not consuming aria-* props directly because in the long-term we won't use many. Rather, I'd recommend using describedby. This, I hope, is both clear as a standalone prop name and hopefully hints at what their implementation might be/mean.
  • I'd also recommend accepting description as a prop. aria-description is currently a spec'ed property (that isn't implemented anywhere) so it serves to future proof a little and it's easy to shim in Charts to provide a nicer API for consumers. (If a user passes in a description, render their text to a visually hidden <p> with a random ID and add aria-describedby to the <canvas> pointing to that ID.
@myasonik myasonik added bug Something isn't working :accessibility Accessibility related issue labels Mar 30, 2021
@rshen91 rshen91 self-assigned this Apr 2, 2021
nickofthyme pushed a commit that referenced this issue Apr 15, 2021
# [28.2.0](v28.1.0...v28.2.0) (2021-04-15)

### Bug Fixes

* **xy:** consider `useDefaultGroupDomain` on scale config ([#1119](#1119)) ([c1b59f2](c1b59f2)), closes [#1087](#1087)

### Features

* **a11y:** allow user to pass custom description for screen readers ([#1111](#1111)) ([2ee1b91](2ee1b91)), closes [#1097](#1097)
* **partition:** add debuggable state ([#1117](#1117)) ([d7fc206](d7fc206)), closes [#917](#917)
@nickofthyme
Copy link
Collaborator

🎉 This issue has been resolved in version 28.2.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@nickofthyme nickofthyme added the released Issue released publicly label Apr 15, 2021
AMoo-Miki pushed a commit to AMoo-Miki/OpenSearch-Dashboards that referenced this issue Feb 10, 2022
# [28.2.0](elastic/elastic-charts@v28.1.0...v28.2.0) (2021-04-15)

### Bug Fixes

* **xy:** consider `useDefaultGroupDomain` on scale config ([opensearch-project#1119](elastic/elastic-charts#1119)) ([269ff1a](elastic/elastic-charts@269ff1a)), closes [opensearch-project#1087](elastic/elastic-charts#1087)

### Features

* **a11y:** allow user to pass custom description for screen readers ([opensearch-project#1111](elastic/elastic-charts#1111)) ([a0020ba](elastic/elastic-charts@a0020ba)), closes [#1097](elastic/elastic-charts#1097)
* **partition:** add debuggable state ([opensearch-project#1117](elastic/elastic-charts#1117)) ([08f8baf](elastic/elastic-charts@08f8baf)), closes [opensearch-project#917](elastic/elastic-charts#917)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:accessibility Accessibility related issue bug Something isn't working released Issue released publicly
Projects
None yet
3 participants