Struct MenuItem 

#[non_exhaustive]
pub struct MenuItem { /* private fields */ }

A command in a menu.

The key names the row’s element id and the MenuEvent::Activated payload, so it comes from the domain and is unique in the menu, submenus included. An item does one thing when chosen: it dispatches an action, whose shortcut the row shows, calls on_select, or opens a link. An item with none of them only reports its key.

Implementations

impl MenuItem

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

An item with a stable key and the label it shows.

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

An icon before the label.

pub fn description(self, description: impl Into<SharedString>) -> Self

A line under the label, in the menu’s description color.

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

Makes the item a toggle: a check shows in the leading slot while checked is true, in place of the icon.

pub fn radio(self, selected: bool) -> Self

Makes the item one of a group of radio items: a dot shows in the leading slot while selected is true. The application keeps which one of the group is on.

pub fn destructive(self) -> Self

Paints the item in the destructive color, for a command that deletes or cannot be undone.

pub fn action(self, action: impl Action) -> Self

Dispatches action when the item is chosen, to the element the menu acts on, and shows the action’s shortcut.

pub fn action_context(self, focus_handle: &FocusHandle) -> Self

The element this item’s action goes to, and whose key bindings its shortcut shows, in place of the menu’s.

pub fn on_select( self, handler: impl Fn(&mut Window, &mut App) + 'static, ) -> Self

Calls handler when the item is chosen, once the menu has closed.

pub fn link(self, url: impl Into<SharedString>) -> Self

Opens url in the system’s browser or mail client when chosen. The row shows an external-link icon after the label.

pub fn external_link_icon(self, visible: bool) -> Self

Whether a link item shows its external-link icon. On by default.

pub fn render<E: IntoElement>( self, render: impl Fn(MenuRowState, &mut Window, &mut App) -> E + 'static, ) -> Self

Draws the inside of the row: render gets the row’s state and returns what goes between the row’s padding, in place of the indicator, icon, label, description, and shortcut. The row itself (its height, highlight, hover, and click) stays the menu’s.

pub fn key(&self) -> &SharedString

The item’s key.

pub fn label(&self) -> &SharedString

The text the item shows.

pub fn description_text(&self) -> Option<&SharedString>

The line under the label.

pub fn is_disabled(&self) -> bool

Whether the item ignores input.

pub fn is_checked(&self) -> bool

Whether the item is a toggle or a radio item that is on.

pub fn is_destructive(&self) -> bool

Whether the item is painted as destructive.

Trait Implementations

impl Clone for MenuItem

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Disableable for MenuItem

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

impl From<MenuItem> for MenuEntry

fn from(item: MenuItem) -> Self

Converts to this type from the input type.