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

[Dashboard] (Accessibility) Adds an H1 tag with the dashboard title #135757

Merged

Conversation

Heenawter
Copy link
Contributor

@Heenawter Heenawter commented Jul 5, 2022

Related to #61870.

Summary

@elastic/kibana-presentation This PR adds an <h1> tag with the dashboard title for screen readers only and focuses on that title when navigating to the dashboard for the first time, as well as when the dashboard changes from view to edit mode - this helps give more context to the audio clues as the user switches between view modes.

For example, whereas before clicking the Edit button would not give any audio message stating that the view mode switched, this will now trigger the <h1> tag to be read out which will say something like "Dashboard - Editing <dashboard title name>".

Screen.Recording.2022-07-06.at.9.20.00.AM.mov

@elastic/shared-ux This PR also addresses the issues brought up with the sample dashboards in #61870. All sample dashboards start with a markdown element that has the name of the dashboard as a header of that panel - however, previously, this header was an h3 element. To follow a11y standards, I switched this to an h2 element - note that this has style implications, as follows:

image

Checklist

For maintainers

@Heenawter Heenawter added Feature:Dashboard Dashboard related features Project:Accessibility Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas loe:small Small Level of Effort impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. v8.4.0 labels Jul 5, 2022
@Heenawter Heenawter self-assigned this Jul 5, 2022
@Heenawter Heenawter force-pushed the fix-dashboard-tag-order_2022-06-29 branch from e15e95a to e770c1e Compare July 5, 2022 22:37
@Heenawter Heenawter force-pushed the fix-dashboard-tag-order_2022-06-29 branch 2 times, most recently from a51fb15 to 4958dc3 Compare July 6, 2022 14:42
@Heenawter Heenawter force-pushed the fix-dashboard-tag-order_2022-06-29 branch from 4958dc3 to 942c0c1 Compare July 6, 2022 14:43
Copy link
Contributor

@ThomThomson ThomThomson left a comment

Choose a reason for hiding this comment

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

Very straightforward, presentation team changes LGTM!

@Heenawter Heenawter marked this pull request as ready for review July 6, 2022 15:29
@Heenawter Heenawter requested a review from a team July 6, 2022 15:29
@Heenawter Heenawter requested a review from a team as a code owner July 6, 2022 15:29
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-accessibility (Project:Accessibility)

@Heenawter Heenawter added the release_note:skip Skip the PR/issue when compiling release notes label Jul 6, 2022
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
dashboard 380.7KB 380.9KB +294.0B

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @Heenawter

@sebelga
Copy link
Contributor

sebelga commented Jul 7, 2022

SharedUX changes LGTM 👍

@Heenawter Heenawter merged commit b14046f into elastic:main Jul 7, 2022
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Jul 7, 2022
@Heenawter Heenawter deleted the fix-dashboard-tag-order_2022-06-29 branch July 7, 2022 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting Feature:Dashboard Dashboard related features impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. loe:small Small Level of Effort Project:Accessibility release_note:skip Skip the PR/issue when compiling release notes Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas v8.4.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants