⚠️ Improved menu based on `egui::Popup` #5716

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

@@ -374,6 +374,7 @@ fn combo_box_dyn<'c, R>(

    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?

…as/popup-based-menu

emilk · 2025-02-21T08:55:49Z

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

What happens if you also call ui.close(); (or the old ui.close_menu()) in a buttons on-click handler inside a menu? Does that close the egui::Window that the menu is in?

lucasmerlin · 2025-02-21T09:02:16Z

Add reset button to demo

lucasmerlin · 2025-02-21T09:08:22Z

Add some note that ui.close doesnt bubble up across areas

emilk

If the default behavior is CloseOnClick, then we can remove the calls to ui.close() from

egui/crates/egui_demo_lib/src/demo/demo_app_windows.rs

Lines 308 to 363 in ab0f83d

    
           fn file_menu_button(ui: &mut Ui) { 
        
               let organize_shortcut = 
        
                   egui::KeyboardShortcut::new(Modifiers::CTRL | Modifiers::SHIFT, egui::Key::O); 
        
               let reset_shortcut = 
        
                   egui::KeyboardShortcut::new(Modifiers::CTRL | Modifiers::SHIFT, egui::Key::R); 
        
               // NOTE: we must check the shortcuts OUTSIDE of the actual "File" menu, 
        
               // or else they would only be checked if the "File" menu was actually open! 
        
               if ui.input_mut(|i| i.consume_shortcut(&organize_shortcut)) { 
        
                   ui.ctx().memory_mut(|mem| mem.reset_areas()); 
        
               } 
        
               if ui.input_mut(|i| i.consume_shortcut(&reset_shortcut)) { 
        
                   ui.ctx().memory_mut(|mem| *mem = Default::default()); 
        
               } 
        
               ui.menu_button("File", |ui| { 
        
                   ui.style_mut().wrap_mode = Some(egui::TextWrapMode::Extend); 
        
                   // On the web the browser controls the zoom 
        
                   #[cfg(not(target_arch = "wasm32"))] 
        
                   { 
        
                       egui::gui_zoom::zoom_menu_buttons(ui); 
        
                       ui.weak(format!( 
        
                           "Current zoom: {:.0}%", 
        
                           100.0 * ui.ctx().zoom_factor() 
        
                       )) 
        
                       .on_hover_text("The UI zoom level, on top of the operating system's default value"); 
        
                       ui.separator(); 
        
                   } 
        
                   if ui 
        
                       .add( 
        
                           egui::Button::new("Organize Windows") 
        
                               .shortcut_text(ui.ctx().format_shortcut(&organize_shortcut)), 
        
                       ) 
        
                       .clicked() 
        
                   { 
        
                       ui.ctx().memory_mut(|mem| mem.reset_areas()); 
        
                       ui.close(); 
        
                   } 
        
                   if ui 
        
                       .add( 
        
                           egui::Button::new("Reset egui memory") 
        
                               .shortcut_text(ui.ctx().format_shortcut(&reset_shortcut)), 
        
                       ) 
        
                       .on_hover_text("Forget scroll, positions, sizes etc") 
        
                       .clicked() 
        
                   { 
        
                       ui.ctx().memory_mut(|mem| *mem = Default::default()); 
        
                       ui.close(); 
        
                   } 
        
               }); 
        
           }

emilk · 2025-02-21T09:43:06Z

crates/egui/src/containers/combo_box.rs

@@ -374,6 +374,7 @@ fn combo_box_dyn<'c, R>(

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


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

crates/egui/src/containers/popup.rs

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

crates/egui/src/containers/popup.rs

crates/egui/src/context.rs

crates/egui/src/menu.rs

crates/egui/src/ui.rs

crates/egui/src/widgets/button.rs

emilk · 2025-02-21T14:55:20Z

crates/egui/src/widgets/button.rs

+    /// Show some text on the right side of the button.
+    #[inline]
+    pub fn right_text(mut self, right_text: impl Into<WidgetText>) -> Self {


If this was broken out to its own PR it would get its own entry in the changelog 🤷

Mentioned it in the PR description, hopefully that is enough to remember to add this to the changelog during the release

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.

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 added 2 commits February 20, 2025 19:30

Replace icon

1158c49

Merge remote-tracking branch 'origin/lucas/popup-based-menu' into luc…

ab0f83d

…as/popup-based-menu

lucasmerlin mentioned this pull request Feb 21, 2025

Update egui to latest master rerun-io/rerun#9103

Draft

emilk reviewed Feb 21, 2025

View reviewed changes

emilk approved these changes Feb 21, 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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

⚠️ Improved menu based on `egui::Popup` #5716

⚠️ Improved menu based on `egui::Popup` #5716

lucasmerlin commented Feb 13, 2025 •

edited

Loading

github-actions bot commented Feb 13, 2025

lucasmerlin Feb 20, 2025

emilk Feb 21, 2025

lucasmerlin Feb 20, 2025

oscargus Feb 20, 2025

lucasmerlin Feb 20, 2025

emilk commented Feb 21, 2025 •

edited

Loading

lucasmerlin commented Feb 21, 2025

lucasmerlin commented Feb 21, 2025

emilk left a comment

emilk Feb 21, 2025

emilk Feb 21, 2025

lucasmerlin Mar 3, 2025

crumblingstatue commented Mar 3, 2025

lucasmerlin commented Mar 3, 2025

	fn file_menu_button(ui: &mut Ui) {
	let organize_shortcut =
	egui::KeyboardShortcut::new(Modifiers::CTRL \| Modifiers::SHIFT, egui::Key::O);
	let reset_shortcut =
	egui::KeyboardShortcut::new(Modifiers::CTRL \| Modifiers::SHIFT, egui::Key::R);

	// NOTE: we must check the shortcuts OUTSIDE of the actual "File" menu,
	// or else they would only be checked if the "File" menu was actually open!

	if ui.input_mut(\|i\| i.consume_shortcut(&organize_shortcut)) {
	ui.ctx().memory_mut(\|mem\| mem.reset_areas());
	}

	if ui.input_mut(\|i\| i.consume_shortcut(&reset_shortcut)) {
	ui.ctx().memory_mut(\|mem\| *mem = Default::default());
	}

	ui.menu_button("File", \|ui\| {
	ui.style_mut().wrap_mode = Some(egui::TextWrapMode::Extend);

	// On the web the browser controls the zoom
	#[cfg(not(target_arch = "wasm32"))]
	{
	egui::gui_zoom::zoom_menu_buttons(ui);
	ui.weak(format!(
	"Current zoom: {:.0}%",
	100.0 * ui.ctx().zoom_factor()
	))
	.on_hover_text("The UI zoom level, on top of the operating system's default value");
	ui.separator();
	}

	if ui
	.add(
	egui::Button::new("Organize Windows")
	.shortcut_text(ui.ctx().format_shortcut(&organize_shortcut)),
	)
	.clicked()
	{
	ui.ctx().memory_mut(\|mem\| mem.reset_areas());
	ui.close();
	}

	if ui
	.add(
	egui::Button::new("Reset egui memory")
	.shortcut_text(ui.ctx().format_shortcut(&reset_shortcut)),
	)
	.on_hover_text("Forget scroll, positions, sizes etc")
	.clicked()
	{
	ui.ctx().memory_mut(\|mem\| *mem = Default::default());
	ui.close();
	}
	});
	}

⚠️ Improved menu based on egui::Popup #5716

⚠️ Improved menu based on egui::Popup #5716

Conversation

lucasmerlin commented Feb 13, 2025 • edited Loading

github-actions bot commented Feb 13, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emilk commented Feb 21, 2025 • edited Loading

lucasmerlin commented Feb 21, 2025

lucasmerlin commented Feb 21, 2025

emilk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crumblingstatue commented Mar 3, 2025

lucasmerlin commented Mar 3, 2025

⚠️ Improved menu based on `egui::Popup` #5716

⚠️ Improved menu based on `egui::Popup` #5716

lucasmerlin commented Feb 13, 2025 •

edited

Loading

emilk commented Feb 21, 2025 •

edited

Loading