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

[Canvas][A11y] Adds an H1 tag with the workpad title when viewing workpads #135504

Merged
merged 14 commits into from
Jul 20, 2022

Conversation

cqliu1
Copy link
Contributor

@cqliu1 cqliu1 commented Jun 30, 2022

Summary

Related to #61870.
Closes #25494.

Screen Shot 2022-06-29 at 4 24 13 PM

This adds an H1 tag with the workpad title for screen readers only and focuses on the title when navigating to this workpad editor page.

I also noticed some strange behavior when you delete your workpad title with the document title and the breadcrumbs, so I made both fallback to displaying the workpad ID when the title is an empty string.

Checklist

Delete any items that are not applicable to this PR.

Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.

When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:

Risk Probability Severity Mitigation/Notes
Multiple Spaces—unexpected behavior in non-default Kibana Space. Low High Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces.
Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. High Low Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure.
Code should gracefully handle cases when feature X or plugin Y are disabled. Medium High Unit tests will verify that any feature flag or plugin combination still results in our service operational.
See more potential risk examples

For maintainers

@cqliu1 cqliu1 added Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas Feature:Canvas labels Jun 30, 2022
@cqliu1 cqliu1 requested a review from a team as a code owner June 30, 2022 01:07
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-presentation (Team:Presentation)

@cqliu1 cqliu1 added review Project:Accessibility 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 Jun 30, 2022
@elasticmachine
Copy link
Contributor

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

@Heenawter Heenawter self-requested a review June 30, 2022 19:10
Copy link
Contributor

@Heenawter Heenawter left a comment

Choose a reason for hiding this comment

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

Tested locally with screen reader on and off. Ensured that the h1 tag updated as the title was changed, and verified that the focus() on mount impacted behaviour as expected.

Left one simple clarifying question and another about confirming whether or not focusing on the h1 tag is the right move from an a11y stand point, but otherwise, works great 👍

@cqliu1
Copy link
Contributor Author

cqliu1 commented Jul 18, 2022

@elasticmachine merge upstream

@cqliu1 cqliu1 added release_note:skip Skip the PR/issue when compiling release notes release_note:enhancement and removed release_note:skip Skip the PR/issue when compiling release notes labels Jul 18, 2022
Copy link
Contributor

@Heenawter Heenawter left a comment

Choose a reason for hiding this comment

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

The changes look good to me - briefly tested plus code review 👍 Left one tiny nit but otherwise looks great

@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
canvas 1.0MB 1.0MB +446.0B

History

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

@cqliu1 cqliu1 merged commit 9f774bd into elastic:main Jul 20, 2022
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Jul 20, 2022
@cqliu1 cqliu1 deleted the canvas/a11y-h1-title branch July 20, 2022 21:35
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:Canvas 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:enhancement review 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.

Canvas page should announce itself on arrival
6 participants