Struct ContextMenuItem 

pub struct ContextMenuItem {
    pub id: String,
    pub label: String,
    pub shortcut: Option<KeyboardShortcut>,
    pub enabled: bool,
    pub separator_after: bool,
    pub icon: Option<String>,
}

A single item in a context menu

Represents a menu item with optional shortcuts, icons, and visual separators. Items can be enabled or disabled to control user interaction.

Fields

id: String

Unique identifier for the item

label: String

Display label

shortcut: Option<KeyboardShortcut>

Optional keyboard shortcut hint

enabled: bool

Whether the item is enabled

separator_after: bool

Whether to show a separator after this item

icon: Option<String>

Optional icon identifier

Implementations

impl ContextMenuItem

pub fn new(id: impl Into<String>, label: impl Into<String>) -> Self

Create a new context menu item

Example

let item = ContextMenuItem::new("copy", "Copy");

pub fn with_shortcut(self, shortcut: KeyboardShortcut) -> Self

Add a keyboard shortcut to this item

The shortcut will be displayed as a hint next to the item label.

Example

let item = ContextMenuItem::new("copy", "Copy")
    .with_shortcut(KeyboardShortcut::command(KeyCode::C));

pub fn disabled(self) -> Self

Mark this item as disabled

Disabled items will be displayed but cannot be clicked.

Example

let item = ContextMenuItem::new("paste", "Paste").disabled();

pub fn with_separator(self) -> Self

Add a separator after this item

A visual separator line will be drawn after this item in the menu.

Example

let item = ContextMenuItem::new("copy", "Copy").with_separator();

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

Add an icon to this item

The icon identifier can be used by the renderer to display an icon next to the menu item.

Example

let item = ContextMenuItem::new("open", "Open")
    .with_icon("folder-open");

pub fn separator() -> Self

Create a separator-only item

This creates a non-interactive item that only displays a separator. The item will have an empty label and be disabled.

Example

let items = vec![
    ContextMenuItem::new("copy", "Copy"),
    ContextMenuItem::separator(),
    ContextMenuItem::new("paste", "Paste"),
];

pub fn is_separator(&self) -> bool

Check if this is a separator-only item

Trait Implementations

impl Clone for ContextMenuItem

fn clone(&self) -> ContextMenuItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContextMenuItem

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.