Enum PopupMenuItem 

pub enum PopupMenuItem {
    Separator,
    Label(SharedString),
    Item {
        icon: Option<Icon>,
        label: SharedString,
        disabled: bool,
        checked: bool,
        is_link: bool,
        action: Option<Box<dyn Action>>,
        handler: Option<Rc<dyn Fn(&ClickEvent, &mut Window, &mut App)>>,
    },
    ElementItem {
        icon: Option<Icon>,
        disabled: bool,
        checked: bool,
        action: Option<Box<dyn Action>>,
        render: Box<dyn Fn(&mut Window, &mut App) -> AnyElement + 'static>,
        handler: Option<Rc<dyn Fn(&ClickEvent, &mut Window, &mut App)>>,
    },
    Submenu {
        icon: Option<Icon>,
        label: SharedString,
        disabled: bool,
        menu: Entity<PopupMenu>,
    },
}

An menu item in a popup menu.

Variants

Separator

A menu separator item.

Label(SharedString)

A non-interactive label item.

Item

A standard menu item.

Fields

icon: Option<Icon>

label: SharedString

disabled: bool

checked: bool

is_link: bool

action: Option<Box<dyn Action>>

handler: Option<Rc<dyn Fn(&ClickEvent, &mut Window, &mut App)>>

ElementItem

A menu item with custom element render.

Fields

icon: Option<Icon>

disabled: bool

checked: bool

action: Option<Box<dyn Action>>

render: Box<dyn Fn(&mut Window, &mut App) -> AnyElement + 'static>

handler: Option<Rc<dyn Fn(&ClickEvent, &mut Window, &mut App)>>

Submenu

A submenu item that opens another popup menu.

NOTE: This is only supported when the parent menu is not scrollable.

Fields

icon: Option<Icon>

label: SharedString

disabled: bool

menu: Entity<PopupMenu>

Implementations

impl PopupMenuItem

pub fn new(label: impl Into<SharedString>) -> Self

Create a new menu item with the given label.

pub fn element<F, E>(builder: F) -> Self

where F: Fn(&mut Window, &mut App) -> E + 'static, E: IntoElement,

Create a new menu item with custom element render.

pub fn submenu(label: impl Into<SharedString>, menu: Entity<PopupMenu>) -> Self

Create a new submenu item that opens another popup menu.

pub fn separator() -> Self

Create a separator menu item.

pub fn label(label: impl Into<SharedString>) -> Self

Creates a label menu item.

pub fn icon(self, icon: impl Into<Icon>) -> Self

Set the icon for the menu item.

Only works for PopupMenuItem::Item, PopupMenuItem::ElementItem and PopupMenuItem::Submenu.

pub fn action(self, action: Box<dyn Action>) -> Self

Set the action for the menu item.

Only works for PopupMenuItem::Item and PopupMenuItem::ElementItem.

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

Set the disabled state for the menu item.

Only works for PopupMenuItem::Item, PopupMenuItem::ElementItem and PopupMenuItem::Submenu.

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

Set checked state for the menu item.

NOTE: If check_side is Side::Left, the icon will replace with a check icon.

pub fn on_click<F>(self, handler: F) -> Self

where F: Fn(&ClickEvent, &mut Window, &mut App) + 'static,

Add a click handler for the menu item.

Only works for PopupMenuItem::Item and PopupMenuItem::ElementItem.

pub fn link(label: impl Into<SharedString>, href: impl Into<String>) -> Self

Create a link menu item.

Trait Implementations

impl FluentBuilder for PopupMenuItem

fn map<U>(self, f: impl FnOnce(Self) -> U) -> U

where Self: Sized,

Imperatively modify self with the given closure.

fn when(self, condition: bool, then: impl FnOnce(Self) -> Self) -> Self

where Self: Sized,

Conditionally modify self with the given closure.

fn when_else( self, condition: bool, then: impl FnOnce(Self) -> Self, else_fn: impl FnOnce(Self) -> Self, ) -> Self

where Self: Sized,

Conditionally modify self with the given closure.

fn when_some<T>( self, option: Option<T>, then: impl FnOnce(Self, T) -> Self, ) -> Self

where Self: Sized,

Conditionally unwrap and modify self with the given closure, if the given option is Some.

fn when_none<T>( self, option: &Option<T>, then: impl FnOnce(Self) -> Self, ) -> Self

where Self: Sized,

Conditionally unwrap and modify self with the given closure, if the given option is None.