⚠️ Improved menu based on `egui::Popup` by lucasmerlin · Pull Request #5716 · emilk/egui

lucasmerlin · 2025-02-13T17:45:34Z

Continuation of #5713

Silently breaking changes:

Menus now close on click by default, this is configurable via PopupCloseBehavior

Additional additions:

Button::right_text
StyleModifier

This is a rewrite of the egui menus, with the following goals:

submenu buttons should work everywhere, in a popup, context menu, area, in some random Ui
remove the menu state from Ui
should work just like the previous menu
~~proper support for keyboard navigation~~
- It's better now but requires further work to be perfect
support PopupCloseBehavior

Closes Unify menus with tooltips/popups #4607
I have followed the instructions in the PR template

github-actions · 2025-02-13T17:49:32Z

Preview available at https://egui-pr-preview.github.io/pr/5716-lucaspopup-based-menu
Note that it might take a couple seconds for the update to show up after the preview_build workflow has completed.

…owing)

…enu and deprecate old menu

# Conflicts: # crates/egui/src/containers/popup.rs # crates/egui/src/containers/window.rs # crates/egui/src/response.rs # crates/egui/src/ui.rs # crates/egui/src/ui_builder.rs # crates/egui_demo_lib/src/demo/context_menu.rs # crates/egui_demo_lib/src/demo/demo_app_windows.rs # crates/egui_demo_lib/src/demo/popups.rs

lucasmerlin · 2025-02-20T17:34:41Z

crates/egui/src/containers/combo_box.rs


    let inner = Popup::menu(&button_response)
        .id(popup_id)
+        .style(None)


Should we set the menu styles for the ComboBox? I'm overwriting this here since this is how it was before, but I think the menu styles would look nice here

Good question 🤔 If so I think we save it for another PR

crates/egui/src/containers/menu.rs

lucasmerlin · 2025-02-20T18:04:50Z

crates/egui_demo_lib/src/demo/demo_app_windows.rs

+                        ui.hyperlink_to(
+                            egui::RichText::new("🦋").size(font_size),
+                            "https://bsky.app/profile/ernerfeldt.bsky.social",
+                        );


Seems like there is no butterfly in egui :(

You just have to wait for🐛...

lucasmerlin · 2025-02-20T18:07:01Z

crates/egui_demo_lib/tests/snapshots/demos/Popups.png

I thought this would be a fun way to display the options, but it seems like the readability suffers a bit. Should I change it?

crates/egui/src/containers/menu.rs

crates/egui/src/menu.rs

crates/egui/src/widgets/button.rs

… Never close menu when clicking submenu buttons. Add tests.

crumblingstatue · 2025-03-03T12:08:02Z

⚠️ Breaking: This technically breaks popup dialogs nested inside menus, for example a color edit button

Since they use the same popup mechanism, and there can only be one popup, they will close the menu (and likely themselves in the process).

I don't know if this should be counted as a regression, or never supported in the first place, but a decision should be made regarding this, before merging this PR.

lucasmerlin · 2025-03-03T13:55:04Z

@crumblingstatue good catch. I want to support opening multiple/nested popups which should fix this. But I'll implement that in a separate PR, since this one is already so big.

Breaking changes: - When using the Memory::popup state, it's now required to call keep_popup_open each frame or the popup will close. - Usually handled by the `Popup` struct, but required for custom popups using the state in `Memory` directly ----- If a popup is abandoned `Memory::popup` would remain `Some`. This is problematic if, for example, you have logic that checks `is_any_popup_open`. This PR adds a new requirement for popups keeping their open state in `Memory::popup`. They must call `Memory::keep_popup_open` as long as they are being rendered. The recent changes in #5716 make this easy to implement. Supersedes #4697 which had an awkward implementation These two videos show a case where a context menu was open when the underlying widget got removed. Before (`any_popup_open` remains `true`) ![Screenshot 2025-03-16 at 18 22 50](https://github.com/user-attachments/assets/22db64dd-e6f2-4501-9bda-39f470b9210c) After ![Screenshot 2025-03-16 at 18 21 14](https://github.com/user-attachments/assets/bd4631b1-a0ad-4047-a14d-cd4999710e07) * Closes #3657 * [x] I have followed the instructions in the PR template

### Related ### What I was curious how my work on egui [menus](emilk/egui#5716) and [popups](emilk/egui#5713) would work in rerun, so I gave it a try. ### Findings so far - ~The new tooltip positioning works well unless we scroll in the scroll area. Maybe we should intersect the widget rect with the clip rect.~ Fixed! https://github.com/user-attachments/assets/54e7ffb1-f0a9-4f2d-8776-e0bea8777903

Continuation of emilk#5713 **Silently breaking changes:** - Menus now close on click by default, this is configurable via `PopupCloseBehavior` **Additional additions:** - `Button::right_text` - `StyleModifier` This is a rewrite of the egui menus, with the following goals: - submenu buttons should work everywhere, in a popup, context menu, area, in some random Ui - remove the menu state from Ui - should work just like the previous menu - ~proper support for keyboard navigation~ - It's better now but requires further work to be perfect - support `PopupCloseBehavior` * Closes emilk#4607 * [x] I have followed the instructions in the PR template

Breaking changes: - When using the Memory::popup state, it's now required to call keep_popup_open each frame or the popup will close. - Usually handled by the `Popup` struct, but required for custom popups using the state in `Memory` directly ----- If a popup is abandoned `Memory::popup` would remain `Some`. This is problematic if, for example, you have logic that checks `is_any_popup_open`. This PR adds a new requirement for popups keeping their open state in `Memory::popup`. They must call `Memory::keep_popup_open` as long as they are being rendered. The recent changes in emilk#5716 make this easy to implement. Supersedes emilk#4697 which had an awkward implementation These two videos show a case where a context menu was open when the underlying widget got removed. Before (`any_popup_open` remains `true`) ![Screenshot 2025-03-16 at 18 22 50](https://github.com/user-attachments/assets/22db64dd-e6f2-4501-9bda-39f470b9210c) After ![Screenshot 2025-03-16 at 18 21 14](https://github.com/user-attachments/assets/bd4631b1-a0ad-4047-a14d-cd4999710e07) * Closes emilk#3657 * [x] I have followed the instructions in the PR template

lucasmerlin marked this pull request as draft February 13, 2025 20:46

lucasmerlin force-pushed the lucas/popup-based-menu branch from e6cf98d to 0109e35 Compare February 18, 2025 15:09

lucasmerlin added 9 commits February 19, 2025 16:11

Add Ui::close and Response::should_close

4848eff

Fixes

7e8d4f7

Replace close_menu with close

1b749fb

Snapshots

06f607a

Fix log

51cf5e8

New menu based on egui::Popup

b0747c5

Split SubMenuButton

7c162d9

Handle Ui::close

91f39af

Handle clicked_outside and fix sub menus staying open

b9c1a1f

lucasmerlin force-pushed the lucas/popup-based-menu branch from 0109e35 to b9c1a1f Compare February 19, 2025 17:21

lucasmerlin added 4 commits February 20, 2025 09:59

Add Button::right_text and use it in menu

830bead

Apply open style to opened submenu button

0e33213

Correct menu offset

7bd3750

Correctly handle all close behaviors

3410269

lucasmerlin added feature New feature or request egui labels Feb 20, 2025

lucasmerlin added 2 commits February 20, 2025 12:31

Always add popups to the layers open_popups (prevents tooltip from sh…

910faaa

…owing)

Ensure submenus are closed when the menu wasn't shown for any reason

b1d206a

lucasmerlin changed the title ~~Improved menu based on egui::Popup~~ ⚠️ Improved menu based on egui::Popup Feb 20, 2025

lucasmerlin added 6 commits February 20, 2025 16:01

Add Bar and MenuButton, migrate the Ui helpers to use the new m…

eb9b9be

…enu and deprecate old menu

Add is_popup_open

e3dfe20

Make the popup demo nicer and remove old context menu demo

58e4c95

Documentation improvements

db9b149

Small improvements

b9c8e00

lucasmerlin commented Feb 20, 2025

View reviewed changes

lucasmerlin commented Feb 21, 2025

View reviewed changes

crates/egui/src/containers/menu.rs Outdated Show resolved Hide resolved

crates/egui/src/containers/menu.rs Show resolved Hide resolved

crates/egui/src/menu.rs Show resolved Hide resolved

crates/egui/src/widgets/button.rs Outdated Show resolved Hide resolved

lucasmerlin added 2 commits February 21, 2025 18:51

Properly support setting a different PopupCloseBehavior in a submenu.…

fdcc6dc

… Never close menu when clicking submenu buttons. Add tests.

Fix panel resizing not working (I forgot to return the old widget_rect)

a312478

lucasmerlin force-pushed the lucas/popup-based-menu branch from 8c9b953 to a312478 Compare February 28, 2025 10:07

lucasmerlin added 3 commits February 28, 2025 13:38

Remove some unnecessary close calls

b4600ce

Add StyleModifier

a820418

Fix egui crashing when menu is shown on first frame

1d073de

lucasmerlin mentioned this pull request Mar 3, 2025

Context menu for first element in a horizontal_wrapping layout doesn't open #2969

Open

lucasmerlin added 9 commits March 3, 2025 11:56

Add reset button

669afa6

Close docs

d6b1e09

Remove unnecessary close call

c2c9872

Rename Ui::will_close to will_parent_close

11277da

Remove Button::right_text_weak

0a5887b

Small changes

bd3aacd

Update snapshot

be048af

Merge branch 'master' into lucas/popup-based-menu

86ffb6d

Use Response::interact_rect

44d9efe

Fix menu alignment

c3a0da2

lucasmerlin merged commit cd22517 into master Mar 3, 2025
46 checks passed

lucasmerlin deleted the lucas/popup-based-menu branch March 3, 2025 13:56

lucasmerlin mentioned this pull request Mar 13, 2025

Fix : Submenus are inaccessible via keyboard Enter/Space (Response::fake_primary_click) #5230

Closed

juancampa mentioned this pull request Mar 16, 2025

⚠️ Close popup if Memory::keep_popup_open isn't called #5814

Merged

1 task

torokati44 mentioned this pull request Jun 17, 2025

Submenu alignment changed since 0.31.1 #7253

Open

emilk mentioned this pull request Jul 10, 2025

Release 0.32.0 - Atoms, popups, and better SVG support #7329

Merged

Conversation

lucasmerlin commented Feb 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Feb 13, 2025

Uh oh!

lucasmerlin Feb 20, 2025

Choose a reason for hiding this comment

Uh oh!

emilk Feb 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lucasmerlin Feb 20, 2025

Choose a reason for hiding this comment

Uh oh!

oscargus Feb 20, 2025

Choose a reason for hiding this comment

Uh oh!

lucasmerlin Feb 20, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

crumblingstatue commented Mar 3, 2025

Uh oh!

lucasmerlin commented Mar 3, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

lucasmerlin commented Feb 13, 2025 •

edited

Loading