snapshot of https://github.com/tauri-apps/tauri.git (dev, 2026-09-23; blobs > 131072B omitted)

crates/tauri/src/menu/builders/menu.rs

@@ -0,0 +1,675 @@
+// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use crate::{Manager, Runtime, image::Image, menu::*};
+
+/// A builder type for [`Menu`]
+///
+/// ## Platform-specific:
+///
+/// - **macOS**: if using [`MenuBuilder`] for the global menubar, it can only contain [`Submenu`]s
+///
+/// # Example
+///
+/// ```no_run
+/// use tauri::menu::*;
+/// tauri::Builder::default()
+///   .setup(move |app| {
+///     let handle = app.handle();
+///     # let icon1 = tauri::image::Image::new(&[], 0, 0);
+///     let menu = MenuBuilder::new(handle)
+///       .item(&MenuItem::new(handle, "MenuItem 1", true, None::<&str>)?)
+///       .items(&[
+///         &CheckMenuItem::new(handle, "CheckMenuItem 1", true, true, None::<&str>)?,
+///         &IconMenuItem::new(handle, "IconMenuItem 1", true, Some(icon1), None::<&str>)?,
+///       ])
+///       .separator()
+///       .cut()
+///       .copy()
+///       .paste()
+///       .separator()
+///       .text("item2", "MenuItem 2")
+///       .check("checkitem2", "CheckMenuItem 2")
+///       .icon("iconitem2", "IconMenuItem 2", app.default_window_icon().cloned().unwrap())
+///       .build()?;
+///     app.set_menu(menu);
+///     Ok(())
+///   });
+/// ```
+pub struct MenuBuilder<'m, R: Runtime, M: Manager<R>> {
+  pub(crate) id: Option<MenuId>,
+  pub(crate) manager: &'m M,
+  pub(crate) items: Vec<crate::Result<MenuItemKind<R>>>,
+}
+
+impl<'m, R: Runtime, M: Manager<R>> MenuBuilder<'m, R, M> {
+  /// Create a new menu builder.
+  pub fn new(manager: &'m M) -> Self {
+    Self {
+      id: None,
+      items: Vec::new(),
+      manager,
+    }
+  }
+
+  /// Create a new menu builder with the specified id.
+  pub fn with_id<I: Into<MenuId>>(manager: &'m M, id: I) -> Self {
+    Self {
+      id: Some(id.into()),
+      items: Vec::new(),
+      manager,
+    }
+  }
+
+  /// Builds this menu
+  pub fn build(self) -> crate::Result<Menu<R>> {
+    let menu = if let Some(id) = self.id {
+      Menu::with_id(self.manager, id)?
+    } else {
+      Menu::new(self.manager)?
+    };
+
+    for item in self.items {
+      let item = item?;
+      menu.append(&item)?;
+    }
+
+    Ok(menu)
+  }
+}
+
+/// A builder type for [`Submenu`]
+///
+/// # Example
+///
+/// ```no_run
+/// use tauri::menu::*;
+/// tauri::Builder::default()
+///   .setup(move |app| {
+///     let handle = app.handle();
+///     # let icon1 = tauri::image::Image::new(&[], 0, 0);
+///     # let icon2 = icon1.clone();
+///     let menu = Menu::new(handle)?;
+///     let submenu = SubmenuBuilder::new(handle, "File")
+///       .item(&MenuItem::new(handle, "MenuItem 1", true, None::<&str>)?)
+///       .items(&[
+///         &CheckMenuItem::new(handle, "CheckMenuItem 1", true, true, None::<&str>)?,
+///         &IconMenuItem::new(handle, "IconMenuItem 1", true, Some(icon1), None::<&str>)?,
+///       ])
+///       .separator()
+///       .cut()
+///       .copy()
+///       .paste()
+///       .separator()
+///       .text("item2", "MenuItem 2")
+///       .check("checkitem2", "CheckMenuItem 2")
+///       .icon("iconitem2", "IconMenuItem 2", app.default_window_icon().cloned().unwrap())
+///       .build()?;
+///     menu.append(&submenu)?;
+///     app.set_menu(menu);
+///     Ok(())
+///   });
+/// ```
+pub struct SubmenuBuilder<'m, R: Runtime, M: Manager<R>> {
+  pub(crate) id: Option<MenuId>,
+  pub(crate) manager: &'m M,
+  pub(crate) text: String,
+  pub(crate) enabled: bool,
+  pub(crate) items: Vec<crate::Result<MenuItemKind<R>>>,
+  pub(crate) icon: Option<crate::image::Image<'m>>,
+  pub(crate) native_icon: Option<NativeIcon>,
+}
+
+impl<'m, R: Runtime, M: Manager<R>> SubmenuBuilder<'m, R, M> {
+  /// Create a new submenu builder.
+  ///
+  /// - `text` could optionally contain an `&` before a character to assign this character as the mnemonic
+  ///   for this menu item. To display a `&` without assigning a mnemenonic, use `&&`.
+  pub fn new<S: AsRef<str>>(manager: &'m M, text: S) -> Self {
+    Self {
+      id: None,
+      items: Vec::new(),
+      text: text.as_ref().to_string(),
+      enabled: true,
+      manager,
+      icon: None,
+      native_icon: None,
+    }
+  }
+
+  /// Create a new submenu builder with the specified id.
+  ///
+  /// - `text` could optionally contain an `&` before a character to assign this character as the mnemonic
+  ///   for this menu item. To display a `&` without assigning a mnemenonic, use `&&`.
+  pub fn with_id<I: Into<MenuId>, S: AsRef<str>>(manager: &'m M, id: I, text: S) -> Self {
+    Self {
+      id: Some(id.into()),
+      text: text.as_ref().to_string(),
+      enabled: true,
+      items: Vec::new(),
+      manager,
+      icon: None,
+      native_icon: None,
+    }
+  }
+
+  /// Set an icon for the submenu.
+  /// Calling this method resets the native_icon.
+  pub fn submenu_icon(mut self, icon: crate::image::Image<'m>) -> Self {
+    self.icon = Some(icon);
+    self.native_icon = None;
+    self
+  }
+
+  /// Set a native icon for the submenu.
+  /// Calling this method resets the icon.
+  pub fn submenu_native_icon(mut self, icon: NativeIcon) -> Self {
+    self.native_icon = Some(icon);
+    self.icon = None;
+    self
+  }
+
+  /// Set the enabled state for the submenu.
+  pub fn enabled(mut self, enabled: bool) -> Self {
+    self.enabled = enabled;
+    self
+  }
+
+  /// Builds this submenu
+  pub fn build(self) -> crate::Result<Submenu<R>> {
+    let submenu = if let Some(id) = self.id {
+      if let Some(icon) = self.icon {
+        Submenu::with_id_and_icon(self.manager, id, self.text, self.enabled, Some(icon))?
+      } else if let Some(native_icon) = self.native_icon {
+        Submenu::with_id_and_native_icon(
+          self.manager,
+          id,
+          self.text,
+          self.enabled,
+          Some(native_icon),
+        )?
+      } else {
+        Submenu::with_id(self.manager, id, self.text, self.enabled)?
+      }
+    } else if let Some(icon) = self.icon {
+      Submenu::new_with_icon(self.manager, self.text, self.enabled, Some(icon))?
+    } else if let Some(native_icon) = self.native_icon {
+      Submenu::new_with_native_icon(self.manager, self.text, self.enabled, Some(native_icon))?
+    } else {
+      Submenu::new(self.manager, self.text, self.enabled)?
+    };
+
+    for item in self.items {
+      let item = item?;
+      submenu.append(&item)?;
+    }
+
+    Ok(submenu)
+  }
+}
+
+macro_rules! shared_menu_builder {
+  ($menu: ty) => {
+    impl<'m, R: Runtime, M: Manager<R>> $menu {
+      /// Set the id for this menu.
+      pub fn id<I: Into<MenuId>>(mut self, id: I) -> Self {
+        self.id.replace(id.into());
+        self
+      }
+
+      /// Add this item to the menu.
+      pub fn item(mut self, item: &dyn IsMenuItem<R>) -> Self {
+        self.items.push(Ok(item.kind()));
+        self
+      }
+
+      /// Add these items to the menu.
+      pub fn items(mut self, items: &[&dyn IsMenuItem<R>]) -> Self {
+        for item in items {
+          self = self.item(*item);
+        }
+        self
+      }
+
+      /// Add a [MenuItem] to the menu.
+      pub fn text<I: Into<MenuId>, S: AsRef<str>>(mut self, id: I, text: S) -> Self {
+        self
+          .items
+          .push(MenuItem::with_id(self.manager, id, text, true, None::<&str>).map(|i| i.kind()));
+        self
+      }
+
+      /// Add a [CheckMenuItem] to the menu.
+      pub fn check<I: Into<MenuId>, S: AsRef<str>>(mut self, id: I, text: S) -> Self {
+        self.items.push(
+          CheckMenuItem::with_id(self.manager, id, text, true, true, None::<&str>)
+            .map(|i| i.kind()),
+        );
+        self
+      }
+
+      /// Add an [IconMenuItem] to the menu.
+      pub fn icon<I: Into<MenuId>, S: AsRef<str>>(
+        mut self,
+        id: I,
+        text: S,
+        icon: Image<'_>,
+      ) -> Self {
+        self.items.push(
+          IconMenuItem::with_id(self.manager, id, text, true, Some(icon), None::<&str>)
+            .map(|i| i.kind()),
+        );
+        self
+      }
+
+      /// Add an [IconMenuItem] with a native icon to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Windows / Linux**: Unsupported.
+      pub fn native_icon<I: Into<MenuId>, S: AsRef<str>>(
+        mut self,
+        id: I,
+        text: S,
+        icon: NativeIcon,
+      ) -> Self {
+        self.items.push(
+          IconMenuItem::with_id_and_native_icon(
+            self.manager,
+            id,
+            text,
+            true,
+            Some(icon),
+            None::<&str>,
+          )
+          .map(|i| i.kind()),
+        );
+        self
+      }
+
+      /// Add Separator menu item to the menu.
+      pub fn separator(mut self) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::separator(self.manager).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Copy menu item to the menu.
+      pub fn copy(mut self) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::copy(self.manager, None).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Copy menu item with specified text to the menu.
+      pub fn copy_with_text<S: AsRef<str>>(mut self, text: S) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::copy(self.manager, Some(text.as_ref())).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Cut menu item to the menu.
+      pub fn cut(mut self) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::cut(self.manager, None).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Cut menu item with specified text to the menu.
+      pub fn cut_with_text<S: AsRef<str>>(mut self, text: S) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::cut(self.manager, Some(text.as_ref())).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Paste menu item to the menu.
+      pub fn paste(mut self) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::paste(self.manager, None).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Paste menu item with specified text to the menu.
+      pub fn paste_with_text<S: AsRef<str>>(mut self, text: S) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::paste(self.manager, Some(text.as_ref())).map(|i| i.kind()));
+        self
+      }
+
+      /// Add SelectAll menu item to the menu.
+      pub fn select_all(mut self) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::select_all(self.manager, None).map(|i| i.kind()));
+        self
+      }
+
+      /// Add SelectAll menu item with specified text to the menu.
+      pub fn select_all_with_text<S: AsRef<str>>(mut self, text: S) -> Self {
+        self.items.push(
+          PredefinedMenuItem::select_all(self.manager, Some(text.as_ref())).map(|i| i.kind()),
+        );
+        self
+      }
+
+      /// Add Undo menu item to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Windows / Linux:** Unsupported.
+      pub fn undo(mut self) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::undo(self.manager, None).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Undo menu item with specified text to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Windows / Linux:** Unsupported.
+      pub fn undo_with_text<S: AsRef<str>>(mut self, text: S) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::undo(self.manager, Some(text.as_ref())).map(|i| i.kind()));
+        self
+      }
+      /// Add Redo menu item to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Windows / Linux:** Unsupported.
+      pub fn redo(mut self) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::redo(self.manager, None).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Redo menu item with specified text to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Windows / Linux:** Unsupported.
+      pub fn redo_with_text<S: AsRef<str>>(mut self, text: S) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::redo(self.manager, Some(text.as_ref())).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Minimize window menu item to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Linux:** Unsupported.
+      pub fn minimize(mut self) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::minimize(self.manager, None).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Minimize window menu item with specified text to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Linux:** Unsupported.
+      pub fn minimize_with_text<S: AsRef<str>>(mut self, text: S) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::minimize(self.manager, Some(text.as_ref())).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Maximize window menu item to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Linux:** Unsupported.
+      pub fn maximize(mut self) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::maximize(self.manager, None).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Maximize window menu item with specified text to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Linux:** Unsupported.
+      pub fn maximize_with_text<S: AsRef<str>>(mut self, text: S) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::maximize(self.manager, Some(text.as_ref())).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Fullscreen menu item to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Windows / Linux:** Unsupported.
+      pub fn fullscreen(mut self) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::fullscreen(self.manager, None).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Fullscreen menu item with specified text to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Windows / Linux:** Unsupported.
+      pub fn fullscreen_with_text<S: AsRef<str>>(mut self, text: S) -> Self {
+        self.items.push(
+          PredefinedMenuItem::fullscreen(self.manager, Some(text.as_ref())).map(|i| i.kind()),
+        );
+        self
+      }
+
+      /// Add Hide window menu item to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Linux:** Unsupported.
+      pub fn hide(mut self) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::hide(self.manager, None).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Hide window menu item with specified text to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Linux:** Unsupported.
+      pub fn hide_with_text<S: AsRef<str>>(mut self, text: S) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::hide(self.manager, Some(text.as_ref())).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Hide other windows menu item to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Linux:** Unsupported.
+      pub fn hide_others(mut self) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::hide_others(self.manager, None).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Hide other windows menu item with specified text to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Linux:** Unsupported.
+      pub fn hide_others_with_text<S: AsRef<str>>(mut self, text: S) -> Self {
+        self.items.push(
+          PredefinedMenuItem::hide_others(self.manager, Some(text.as_ref())).map(|i| i.kind()),
+        );
+        self
+      }
+
+      /// Add Show all app windows menu item to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Windows / Linux:** Unsupported.
+      pub fn show_all(mut self) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::show_all(self.manager, None).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Show all app windows menu item with specified text to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Windows / Linux:** Unsupported.
+      pub fn show_all_with_text<S: AsRef<str>>(mut self, text: S) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::show_all(self.manager, Some(text.as_ref())).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Close window menu item to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Linux:** Unsupported.
+      pub fn close_window(mut self) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::close_window(self.manager, None).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Close window menu item with specified text to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Linux:** Unsupported.
+      pub fn close_window_with_text<S: AsRef<str>>(mut self, text: S) -> Self {
+        self.items.push(
+          PredefinedMenuItem::close_window(self.manager, Some(text.as_ref())).map(|i| i.kind()),
+        );
+        self
+      }
+
+      /// Add Quit app menu item to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Linux:** Unsupported.
+      pub fn quit(mut self) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::quit(self.manager, None).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Quit app menu item with specified text to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Linux:** Unsupported.
+      pub fn quit_with_text<S: AsRef<str>>(mut self, text: S) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::quit(self.manager, Some(text.as_ref())).map(|i| i.kind()));
+        self
+      }
+
+      /// Add About app menu item to the menu.
+      pub fn about(mut self, metadata: Option<AboutMetadata<'_>>) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::about(self.manager, None, metadata).map(|i| i.kind()));
+        self
+      }
+
+      /// Add About app menu item with specified text to the menu.
+      pub fn about_with_text<S: AsRef<str>>(
+        mut self,
+        text: S,
+        metadata: Option<AboutMetadata<'_>>,
+      ) -> Self {
+        self.items.push(
+          PredefinedMenuItem::about(self.manager, Some(text.as_ref()), metadata).map(|i| i.kind()),
+        );
+        self
+      }
+
+      /// Add Services menu item to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Windows / Linux:** Unsupported.
+      pub fn services(mut self) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::services(self.manager, None).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Services menu item with specified text to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Windows / Linux:** Unsupported.
+      pub fn services_with_text<S: AsRef<str>>(mut self, text: S) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::services(self.manager, Some(text.as_ref())).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Bring All to Front menu item to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Windows / Linux:** Unsupported.
+      pub fn bring_all_to_front(mut self) -> Self {
+        self
+          .items
+          .push(PredefinedMenuItem::bring_all_to_front(self.manager, None).map(|i| i.kind()));
+        self
+      }
+
+      /// Add Bring All to Front menu item with specified text to the menu.
+      ///
+      /// ## Platform-specific:
+      ///
+      /// - **Windows / Linux:** Unsupported.
+      pub fn bring_all_to_front_with_text<S: AsRef<str>>(mut self, text: S) -> Self {
+        self.items.push(
+          PredefinedMenuItem::bring_all_to_front(self.manager, Some(text.as_ref()))
+            .map(|i| i.kind()),
+        );
+        self
+      }
+    }
+  };
+}
+
+shared_menu_builder!(MenuBuilder<'m, R, M>);
+shared_menu_builder!(SubmenuBuilder<'m, R, M>);