-
Notifications
You must be signed in to change notification settings - Fork 856
[EuiFlyout] Fix flaky return focus and child flyouts closing their parent flyouts #8878
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
Merged
mgadewoll
merged 6 commits into
elastic:main
from
mgadewoll:flyout/8867-fix-return-focus
Jul 21, 2025
Merged
[EuiFlyout] Fix flaky return focus and child flyouts closing their parent flyouts #8878
mgadewoll
merged 6 commits into
elastic:main
from
mgadewoll:flyout/8867-fix-return-focus
Jul 21, 2025
Conversation
This file contains hidden or 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
491d59e
to
74c66eb
Compare
- the automatic return focus from the FocusTrap works just fine. Using flyoutToggle caused unexpected focus shifts
74c66eb
to
c7e7312
Compare
💚 Build SucceededHistory
cc @mgadewoll |
💚 Build Succeeded
History
cc @mgadewoll |
acstll
approved these changes
Jul 21, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟢 Working as expected and the changes look good. I followed the QA guidelines comprehensively. Cypress test passed 3 times in a row. Flyout behavior is perfect, including the Escape
key fix. (Thanks for taking care of this one!)
weronikaolejniczak
added a commit
to elastic/kibana
that referenced
this pull request
Jul 23, 2025
`@elastic/eui`: `106.0.0` ⏩ `106.1.0` `@elastic/eslint-plugin-eui`: `2.1.0` ⏩ `2.2.1` [Questions? Please see our Kibana upgrade FAQ.](https://github.com/elastic/eui/blob/main/wiki/eui-team-processes/upgrading-kibana.md#faq-for-kibana-teams) New props and defaults have been added to `EuiFlyout`, including `includeSelectorInFocusTrap`, plus new global CSS variables for push mode offset control. Additionally, we introduced a small spacing fix for invalid `EuiDualRange` append component and added support for custom styles on `EuiTreeView` nodes via the css key. :warning: **React 16 is now deprecated:** EUI no longer tests against it or fixes issues specific to it. ## Changes - I removed forced click in: `x-pack/test/security_solution_cypress/cypress/tasks/rule_details.ts` - I removed `{enter}` in: `x-pack/test/security_solution_cypress/cypress/tasks/common/rule_actions.ts` (see #228517) ## Package updates ### `@elastic/eui` #### [`v106.1.0`](https://github.com/elastic/eui/releases/v106.1.0) - Added `--euiPushFlyoutOffsetInlineStart` and `--euiPushFlyoutOffsetInlineEnd` global CSS variables set by the `EuiFlyout` in `push` mode. ([#8872](elastic/eui#8872)) - Reduced the `min-width` for inputs in `EuiRange` and `EuiDualRange` ([#8866](elastic/eui#8866)) - Added `includeSelectorInFocusTrap` prop for `EuiFlyout` ([#8849](elastic/eui#8849)) - Added component defaults for `EuiFlyout` that include `includeSelectorInFocusTrap` and `includeFixedHeadersInFocusTrap` ([#8849](elastic/eui#8849)) **Bug fixes** - Fixed flaky manual return focus behavior on `EuiFlyout` by relying on `FocusTrap` returning focus instead ([#8878](elastic/eui#8878)) - Fixed `EuiFlyoutChild` closing its parent `EuiFlyout` on `Escape` keypress ([#8878](elastic/eui#8878)) - Fixed support for `css` key in items object passed to `EuiTreeView` ([#8864](elastic/eui#8864)) **Deprecations** - Deprecated support for React 16. Please update to a modern version of React or stay on EUI version 106.0.0 if you can't switch right now. ([#8868](elastic/eui#8868)) ### `@elastic/eslint-plugin-eui` #### [`v2.2.1`](https://www.npmjs.com/package/@elastic/eslint-plugin-eui/v/2.2.1) **Bug fixes** - Removed `no-css_color` entry which mapped to a duplicate `no-css-color` rule ([#8888](elastic/eui#8888)) #### [`v2.2.0`](https://www.npmjs.com/package/@elastic/eslint-plugin-eui/v/2.2.0) - Added new `prefer-eui-icon-tip` rule. ([#8877](elastic/eui#8877))
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.
Summary
closes #8867
This PR aims to solve a flaky behavior that we noticed as part of the EUI upgrade for
105.0.0
in Kibana (PR). The flaky behavior was noticed on failing cypress tests (build) where a click event after closing a flyout would not target the correct element anymore.Additionally, the flyout changes also affected another test and made it flaky. This was captured here. Kibana updated the test for now in this PR.
The issue was tracked down to the changed
returnFocus
behavior onEuiFlyout
(code).The manual handling of the return focus is not needed. the
FocusTrap
handles the focus already generally correctly and internally with applied delay (code).Additional changes
Escape
keypressWhy are we making this change?
Fixing flaky closing behavior of flyouts that affected focus behavior of other interactions.
Screenshots
Impact to users
{ force: true}
to the click event. This needs to be removed once this change is released.QA
The fix for the flaky behavior was tested in Kibana, the CI passed with the update applied and
{ force: click }
removed.eui/324-input-visual-refresh-qa
yarn kbn bootstrap
x-pack/test/security_solution_cypress
runyarn cypress:open:serverless --spec './cypress/e2e/detection_response/detection_engine/exceptions/**/*.cy.ts'
and select the testauto_populate_with_alert_data.cy.ts
to runℹ️ Storybook
Escape
key closes the child flyout onlyGeneral checklist
Checked in both light and dark modesChecked in both MacOS and Windows high contrast modesChecked in mobileAdded documentationProps have proper autodocs (using@default
if default values are missing) and playground togglesChecked Code Sandbox works for any docs examplesAdded or updated jest and cypress testsUpdated visual regression testsIf applicable, added the breaking change issue label (and filled out the breaking change checklist)If applicable, file an issue to update EUI's Figma library with any corresponding UI changes. (This is an internal repo, if you are external to Elastic, ask a maintainer to submit this request)