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

[Console] Add a setting to disable the a11y overlay #158844

Merged
merged 4 commits into from
Jun 5, 2023

Conversation

yuliacech
Copy link
Contributor

@yuliacech yuliacech commented Jun 1, 2023

Summary

Fixes #16139

This PR adds a setting in Console that allows to disable the a11y overlay. The default will be set to enabled so that the default behaviour should not change. A user can disable the overlay in their browser and the setting is saved in local storage. So that other users are not affected by that change.

The reason to allow disabling the overlay is that it can be flaky and sometimes it's displayed when not intended. The code relies on querySelector (see this file) so I think that causes the flakiness and that is very difficult to test reliably.

Screenshot

A11y overlay (no changes)

Screenshot 2023-06-01 at 16 34 23

Settings modal with the new option to disable the a11y overlay

Screenshot 2023-06-01 at 16 29 02

How to test

  1. Start Kibana and navigate to the Console
  2. Press ESC when textarea is focused and now autocomplete popup is displayed to see the a11y overlay
  3. Open the Settings modal and disable the a11y overlay
  4. Press ESC in the textarea again to see that no overlay is now displayed
  5. Check that the value is persisted in the local storage

Flaky test runner
https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/2346

Checklist

@yuliacech yuliacech added Feature:Console Dev Tools Console Feature Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more release_note:skip Skip the PR/issue when compiling release notes v8.9.0 labels Jun 1, 2023
@yuliacech yuliacech marked this pull request as ready for review June 2, 2023 16:53
@yuliacech yuliacech requested a review from a team as a code owner June 2, 2023 16:53
@elasticmachine
Copy link
Contributor

Pinging @elastic/platform-deployment-management (Team:Deployment Management)

@yuliacech yuliacech added the ui-copy Review of UI copy with docs team is recommended label Jun 2, 2023
@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
console 417.9KB 418.5KB +586.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
console 26.7KB 27.2KB +483.0B
esUiShared 154.7KB 154.8KB +45.0B
total +528.0B
Unknown metric groups

ESLint disabled line counts

id before after diff
enterpriseSearch 19 21 +2
securitySolution 414 418 +4
total +6

Total ESLint disabled count

id before after diff
enterpriseSearch 20 22 +2
securitySolution 498 502 +4
total +6

History

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

Copy link
Member

@sabarasaba sabarasaba 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 working on this @yuliacech! I've tested locally and code changes lgtm 🚀

@yuliacech
Copy link
Contributor Author

Thanks a lot for your review, @sabarasaba!

@yuliacech
Copy link
Contributor Author

Merging this after running the flaky test runner https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/2349 twice with 200 iterations.

@yuliacech
Copy link
Contributor Author

Also confirmed the ui copy with @alaudazzi

@yuliacech yuliacech merged commit 3c8b26b into elastic:main Jun 5, 2023
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Jun 5, 2023
@yuliacech yuliacech deleted the console/escape-settings branch February 15, 2024 12:04
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:Console Dev Tools Console Feature release_note:skip Skip the PR/issue when compiling release notes Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more ui-copy Review of UI copy with docs team is recommended v8.9.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Console ESC prompt can be annoying
5 participants