[8.15] fix dashboard scroll issue for when lens inline config is opened. (#188236) #194258
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…astic#188236) ## Summary Closes elastic#185895 This PR adds a side effect to opening the inline config editor to disable scroll on the document body, this way the user's scroll interaction if any remains within the open inline lens config editor, whilst keeping ~on~ the panel whose configuration is being modified in focus. #### Previously:  #### After  <!-- ### Checklist Delete any items that are not applicable to this PR. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) - [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### 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](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) | ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --> (cherry picked from commit fdd67f7)
dej611
approved these changes
Sep 27, 2024
💛 Build succeeded, but was flaky
Failed CI StepsMetrics [docs]Async chunks
Page load bundle
To update your PR or re-run it, just comment with: cc @eokoneyo |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Backport
This will backport the following commits from
mainto8.15:Questions ?
Please refer to the Backport tool documentation
","sha":"fdd67f7070037a548494b3830f9cfde64873f1be","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Presentation","loe:small","release_note:skip","impact:medium","backport:skip","Project:Dashboard Usability","v8.16.0"],"number":188236,"url":"https://github.com//pull/188236","mergeCommit":{"message":"fix dashboard scroll issue for when lens inline config is opened. (#188236)\n\n## Summary\r\n\r\nCloses https://github.com//issues/185895\r\n\r\nThis PR adds a side effect to opening the inline config editor to\r\ndisable scroll on the document body, this way the user's scroll\r\ninteraction if any remains within the open inline lens config editor,\r\nwhilst keeping ~on~ the panel whose configuration is being modified in\r\nfocus.\r\n\r\n#### Previously:\r\n\r\n\r\n\r\n#### After\r\n\r\n\r\n\r\n\r\n","sha":"fdd67f7070037a548494b3830f9cfde64873f1be"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.16.0","labelRegex":"^v8.16.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com//pull/188236","number":188236,"mergeCommit":{"message":"fix dashboard scroll issue for when lens inline config is opened. (#188236)\n\n## Summary\r\n\r\nCloses https://github.com//issues/185895\r\n\r\nThis PR adds a side effect to opening the inline config editor to\r\ndisable scroll on the document body, this way the user's scroll\r\ninteraction if any remains within the open inline lens config editor,\r\nwhilst keeping ~on~ the panel whose configuration is being modified in\r\nfocus.\r\n\r\n#### Previously:\r\n\r\n\r\n\r\n#### After\r\n\r\n\r\n\r\n\r\n","sha":"fdd67f7070037a548494b3830f9cfde64873f1be"}}]}] BACKPORT-->