Struct MenuItem 

pub struct MenuItem {
    pub label: String,
    pub icon: Option<String>,
    pub action: MenuAction,
    pub shortcut: Option<String>,
}

A menu item that can be displayed in the Scarab Dock

Menu items represent actions that users can trigger from the dock interface. They support icons, keyboard shortcuts, and hierarchical organization through submenus.

Fields

label: String

Display label for the menu item

This is the text shown to the user in the dock interface. Keep it concise and descriptive (e.g., “Run Tests”, “Open Settings”).

icon: Option<String>

Optional icon or emoji for visual identification

Can be a single emoji (e.g., “🚀”, “⚙️”) or an icon identifier. Icons help users quickly identify menu items at a glance.

action: MenuAction

The action to perform when this menu item is selected

Defines what happens when the user clicks or activates this menu item.

shortcut: Option<String>

Optional keyboard shortcut hint

Display-only hint showing the keyboard shortcut (e.g., “Ctrl+T”, “Alt+B”). Note: The actual shortcut handling must be implemented separately. This field is purely informational for the UI.

Implementations

impl MenuItem

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

Create a new menu item with a label and action

Arguments

• label - Display text for the menu item
• action - Action to perform when selected

Example

use scarab_plugin_api::menu::{MenuItem, MenuAction};

let item = MenuItem::new(
    "Deploy",
    MenuAction::Command("./deploy.sh".to_string())
);

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

Add an icon or emoji to this menu item

Arguments

• icon - Icon identifier or emoji character

Example

use scarab_plugin_api::menu::{MenuItem, MenuAction};

let item = MenuItem::new("Build", MenuAction::Command("make".to_string()))
    .with_icon("🔨");

pub fn with_shortcut(self, shortcut: impl Into<String>) -> Self

Add a keyboard shortcut hint to this menu item

Note: This is display-only. The shortcut must be registered separately through the appropriate input handling mechanism.

Arguments

• shortcut - Shortcut text (e.g., “Ctrl+B”, “Alt+Shift+T”)

Example

use scarab_plugin_api::menu::{MenuItem, MenuAction};

let item = MenuItem::new("Save", MenuAction::Command("save".to_string()))
    .with_shortcut("Ctrl+S");

Trait Implementations

impl Clone for MenuItem

fn clone(&self) -> MenuItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MenuItem

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MenuItem

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for MenuItem

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.