Skip to content

[Flyout System] Deprecate flyout menu hideTitle prop#9502

Merged
angeles-mb merged 4 commits intoelastic:mainfrom
angeles-mb:3017-deprecate-flyout-menu-hideTitle-prop
Mar 13, 2026
Merged

[Flyout System] Deprecate flyout menu hideTitle prop#9502
angeles-mb merged 4 commits intoelastic:mainfrom
angeles-mb:3017-deprecate-flyout-menu-hideTitle-prop

Conversation

@angeles-mb
Copy link
Copy Markdown
Contributor

@angeles-mb angeles-mb commented Mar 13, 2026

Summary

This PR:

  • Deprecates hideTitle prop in EuiFlyoutMenuProps. The menu title is now hidden by default for all flyouts. EuiFlyoutHeader will be the recommended way for visible titles instead. Prop is still honored.
  • Removes flyoutMenuHideTitle computation inside useFlyoutMenu hook since this logic is no longer needed. We hide by default and only show title is prop is set to false, we can rely on the raw prop now.
  • Adds a dev only warning when the prop is used.

Why are we making this change?

To enforce consistency between all flyouts and between main and child flyouts (previously, main flyouts hid titles by default and child showed them by default).

Closes https://github.com/elastic/kibana-team/issues/3017

Screenshots #

No changes for rows 1, 2, 5 (only warning)

Before After
Screenshot 2026-03-13 at 14 14 45 Screenshot 2026-03-13 at 14 01 04
Screenshot 2026-03-13 at 14 14 58 Screenshot 2026-03-13 at 14 01 13
Screenshot 2026-03-13 at 14 15 11 Screenshot 2026-03-13 at 14 01 28
Screenshot 2026-03-13 at 14 15 23 Screenshot 2026-03-13 at 14 01 47
Screenshot 2026-03-13 at 14 24 14  Screenshot 2026-03-13 at 13 23 17
Screenshot 2026-03-13 at 14 23 58 Screenshot 2026-03-13 at 13 27 24

Testing checklist:

Storybook EuiFlyout > EuiFlyoutMenu > Playground:

  • Default story shows flyout without title on its menu (hideTitle true)
  • Toggle hideTitle to false, menu now renders with a title and header title is not rendered

Storybook EuiFlyout > Flyout Manager > Playground:

  • Default story shows both main and child flyouts with a menu containing actions but no title
  • Toggling both main and child flyouts showCustomActions results in both flyouts showing no menu (no visible menu title nor actions, menu hides)

Kibana flyout examples:
If you want to test in kibana follow these instructions to test kibana against this branch. Run kibana with yarn start --no-cache --run-examples to be able to test Flyout System Examples (reachable via global search bar)

  • Add sample data, go to Discover, open a document Flyout and validate the flyout menu renders a title (this is currently the only Kibana consumer using hideTitle false)
  • Open browser console and check for the console warning
  • Search for flyout system examples in global search bar. Open main and child flyout. Validate none of them carry a menu with a title.
  • Open browser console and check there is no console warning

Impact to users

Users setting the prop will notice no behavior change. Users not using the prop will notice that child flyouts now never render a title inside the flyout menu.

QA

Remove or strikethrough items that do not apply to your PR.

General checklist

  • Browser QA
    • Checked in both light and dark modes
    • Checked in both MacOS and Windows high contrast modes
    • Checked in mobile
    • Checked in Chrome, Safari, Edge, and Firefox
    • Checked for accessibility including keyboard-only and screenreader modes
  • Docs site QA
  • Code quality checklist
  • Release checklist
    • A changelog entry exists and is marked appropriately
    • If applicable, added the breaking change issue label (and filled out the breaking change checklist)
    • If the changes unblock an issue in a different repo, smoke tested carefully (see Testing EUI features in Kibana ahead of time)
  • Designer 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)

@angeles-mb angeles-mb self-assigned this Mar 13, 2026
@angeles-mb angeles-mb marked this pull request as ready for review March 13, 2026 13:30
@angeles-mb angeles-mb requested a review from a team as a code owner March 13, 2026 13:30
Copy link
Copy Markdown
Contributor

@mgadewoll mgadewoll left a comment

Choose a reason for hiding this comment

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

🟢 The code changes are LGTM and the hideTitle behavior works as expected. Thanks for the update!

I only left one tiny nit.

@mgadewoll
Copy link
Copy Markdown
Contributor

@angeles-mb I forgot one thing: Could you please run VRT? There should be updates needed.

@angeles-mb
Copy link
Copy Markdown
Contributor Author

angeles-mb commented Mar 13, 2026

@mgadewoll I'm confused, aren't VRT tests run on every PR? Or do they soft fail?

Visual regression tests are being run automatically on every pull request.

I don't expect changes since for the manager stories loki is being skipped and for the single flyouts the title was already being hidden by default.

I'll run them in any case and see what happens.

@mgadewoll
Copy link
Copy Markdown
Contributor

mgadewoll commented Mar 13, 2026

@mgadewoll I'm confused, aren't VRT tests run on every PR? Or do they only run once merged?

Visual regression tests are being run automatically on every pull request.

Urgh, that part in the wiki is not true. No, VRT is currently not automatically run. 🙈

I don't expect changes since for the manager stories loki is being skipped and for the single flyouts the title was already being hidden by default.

I ran it briefly on your branch and saw that there were changes.

@angeles-mb
Copy link
Copy Markdown
Contributor Author

Urgh, that part in the wiki is not true

I've updated it.

I ran it briefly on your branch and saw that there were changes.

I understand now, those changes you're seeing are related to my previous PR [Flyout System] Add flyout menu display modes which did alter the stories in a more meaningful way (I added custom actions which make the flyout menu to render). I had never run these tests before so these changes are expected then. I've updated the screenshots.

@elasticmachine
Copy link
Copy Markdown
Collaborator

💚 Build Succeeded

History

cc @angeles-mb

@elasticmachine
Copy link
Copy Markdown
Collaborator

💚 Build Succeeded

History

cc @angeles-mb

@angeles-mb angeles-mb merged commit 1a3f148 into elastic:main Mar 13, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants