Struct MaterialMenu 

pub struct MaterialMenu<'a> { /* private fields */ }

Material Design menu component.

Menus display a list of choices on a temporary surface. They appear when users interact with a button, action, or other control.

Example

let mut menu_open = false;

if ui.button("Open Menu").clicked() {
    menu_open = true;
}

let mut menu = MaterialMenu::new(&mut menu_open)
    .item("Cut", Some(|| println!("Cut")))
    .item("Copy", Some(|| println!("Copy")))
    .item("Paste", Some(|| println!("Paste")));

if menu_open {
    ui.add(menu);
}

Implementations

impl<'a> MaterialMenu<'a>

pub fn new(id: impl Into<Id>, open: &'a mut bool) -> Self

Create a new MaterialMenu instance.

Arguments

• id - Unique identifier for this menu
• open - Mutable reference to the menu’s open state

Example

let mut menu_open = false;
let menu = MaterialMenu::new("main_menu", &mut menu_open);

pub fn anchor_rect(self, rect: Rect) -> Self

Set the anchor rectangle for the menu.

The menu will be positioned relative to this rectangle.

Arguments

• rect - The rectangle to anchor the menu to

Example

let mut menu_open = false;
let button_rect = ui.available_rect_before_wrap();
let menu = MaterialMenu::new("menu", &mut menu_open)
    .anchor_rect(button_rect);

pub fn item(self, item: MenuItem<'a>) -> Self

Add an item to the menu.

Arguments

• item - The menu item to add

Example

let mut menu_open = false;
let item = MenuItem::new("Cut").action(|| println!("Cut"));
let menu = MaterialMenu::new("menu", &mut menu_open).item(item);

pub fn style(self, style: MenuStyle) -> Self

Set the menu style, overriding Material Design 3 defaults.

Arguments

• style - The MenuStyle to apply

pub fn button_theme(self, theme: MenuButtonThemeData) -> Self

Set the button theme, overriding Material Design 3 defaults.

Arguments

• theme - The MenuButtonThemeData to apply

pub fn elevation(self, elevation: f32) -> Self

Set the elevation (shadow) of the menu.

This is a shorthand for setting MenuStyle.elevation. Material Design defines typical elevation levels from 0 to 12.

Arguments

• elevation - Elevation level

pub fn anchor_corner(self, corner: Corner) -> Self

Set the anchor corner for the menu.

pub fn menu_corner(self, corner: Corner) -> Self

Set the menu corner for positioning.

pub fn default_focus(self, focus: FocusState) -> Self

Set the default focus state for the menu.

pub fn positioning(self, positioning: Positioning) -> Self

Set the positioning mode for the menu.

pub fn quick(self, quick: bool) -> Self

Enable or disable quick animation for the menu.

pub fn has_overflow(self, has_overflow: bool) -> Self

Enable or disable overflow scrolling for the menu.

pub fn stay_open_on_outside_click(self, stay_open: bool) -> Self

Keep the menu open when clicking outside of it.

pub fn stay_open_on_focusout(self, stay_open: bool) -> Self

Keep the menu open when focus moves away from it.

pub fn skip_restore_focus(self, skip: bool) -> Self

Skip restoring focus when the menu closes.

pub fn x_offset(self, offset: f32) -> Self

Set the horizontal offset for the menu.

pub fn y_offset(self, offset: f32) -> Self

Set the vertical offset for the menu.

pub fn no_horizontal_flip(self, no_flip: bool) -> Self

Prevent horizontal flipping when the menu would go offscreen.

pub fn no_vertical_flip(self, no_flip: bool) -> Self

Prevent vertical flipping when the menu would go offscreen.

pub fn typeahead_delay(self, delay: f32) -> Self

Set the typeahead delay for the menu.

pub fn list_tab_index(self, index: i32) -> Self

Set the tab index for keyboard navigation.

pub fn show(self, ctx: &Context)

Show the menu in the given context.