feat(api/tray): add TrayIcon.setShowMenuOnLeftClick method (#11726)

amrbashir · web-flow · commit fc30b20bea12 · 2024-11-21T14:50:41.000+02:00
diff --git a/.changes/set-show-menu-on-left-click-windows-api.md b/.changes/set-show-menu-on-left-click-windows-api.md
@@ -0,0 +1,6 @@
+---
+"@tauri-apps/api": "minor:feat"
+---
+
+Add `TrayIcon.setShowMenuOnLeftClick` method and deprecate `TrayIcon.setMenuOnLeftClick` to match the Rust API.
+
diff --git a/.changes/show-menu-on-left-click-windows-api.md b/.changes/show-menu-on-left-click-windows-api.md
@@ -0,0 +1,6 @@
+---
+"@tauri-apps/api": "minor:feat"
+---
+
+Add `TrayIconOptions.showMenuOnLeftClick` field and deprecate `TrayIconOptions.menuOnLeftClick` to match the Rust API.
+
diff --git a/.changes/show-menu-on-left-click-windows.md b/.changes/show-menu-on-left-click-windows.md
@@ -0,0 +1,6 @@
+---
+"tauri": "minor:feat"
+---
+
+Add `TrayIconBuilder::show_menu_on_left_click` method and deprecate `TrayIconBuilder::menu_on_left_click` for consistent naming and clarity.
+
diff --git a/.changes/tray-icon-menu-on-left-click-windows-api.md b/.changes/tray-icon-menu-on-left-click-windows-api.md
@@ -0,0 +1,6 @@
+---
+"@tauri-apps/api": "minor:enhance"
+---
+
+Add support for `TrayIconOptions.menuOnLeftClick` option and `TrayIcon.setMenuOnLeftClick` on Windows.
+
diff --git a/.changes/tray-icon-menu-on-left-click-windows.md b/.changes/tray-icon-menu-on-left-click-windows.md
@@ -1,6 +1,6 @@
 ---
-"tauri": patch:bug
+"tauri": "minor:enhance"
 ---
 
-Support for `set_show_menu_on_left_click` was implemented on Windows too. So it
-should not be macOS anymore. [tauri-apps/tray-icon#199](https://github.com/tauri-apps/tray-icon/pull/199)
+Add support for `TrayIconBuilder::menu_on_left_click` and `TrayIcon::set_show_menu_on_left_click` on Windows.
+
diff --git a/crates/tauri-cli/config.schema.json b/crates/tauri-cli/config.schema.json
@@ -1624,7 +1624,13 @@
           "type": "boolean"
         },
         "menuOnLeftClick": {
-          "description": "A Boolean value that determines whether the menu should appear when the tray icon receives a left click on macOS.",
+          "description": "A Boolean value that determines whether the menu should appear when the tray icon receives a left click.\n\n ## Platform-specific:\n\n - **Linux**: Unsupported.",
+          "default": true,
+          "deprecated": true,
+          "type": "boolean"
+        },
+        "showMenuOnLeftClick": {
+          "description": "A Boolean value that determines whether the menu should appear when the tray icon receives a left click.\n\n ## Platform-specific:\n\n - **Linux**: Unsupported.",
           "default": true,
           "type": "boolean"
         },
diff --git a/crates/tauri-schema-generator/schemas/config.schema.json b/crates/tauri-schema-generator/schemas/config.schema.json
@@ -1624,7 +1624,13 @@
           "type": "boolean"
         },
         "menuOnLeftClick": {
-          "description": "A Boolean value that determines whether the menu should appear when the tray icon receives a left click on macOS.",
+          "description": "A Boolean value that determines whether the menu should appear when the tray icon receives a left click.\n\n ## Platform-specific:\n\n - **Linux**: Unsupported.",
+          "default": true,
+          "deprecated": true,
+          "type": "boolean"
+        },
+        "showMenuOnLeftClick": {
+          "description": "A Boolean value that determines whether the menu should appear when the tray icon receives a left click.\n\n ## Platform-specific:\n\n - **Linux**: Unsupported.",
           "default": true,
           "type": "boolean"
         },
diff --git a/crates/tauri-utils/src/config.rs b/crates/tauri-utils/src/config.rs
@@ -2431,9 +2431,21 @@ pub struct TrayIconConfig {
   /// A Boolean value that determines whether the image represents a [template](https://developer.apple.com/documentation/appkit/nsimage/1520017-template?language=objc) image on macOS.
   #[serde(default, alias = "icon-as-template")]
   pub icon_as_template: bool,
-  /// A Boolean value that determines whether the menu should appear when the tray icon receives a left click on macOS.
+  /// A Boolean value that determines whether the menu should appear when the tray icon receives a left click.
+  ///
+  /// ## Platform-specific:
+  ///
+  /// - **Linux**: Unsupported.
   #[serde(default = "default_true", alias = "menu-on-left-click")]
+  #[deprecated(since = "2.2.0", note = "Use `show_menu_on_left_click` instead.")]
   pub menu_on_left_click: bool,
+  /// A Boolean value that determines whether the menu should appear when the tray icon receives a left click.
+  ///
+  /// ## Platform-specific:
+  ///
+  /// - **Linux**: Unsupported.
+  #[serde(default = "default_true", alias = "show-menu-on-left-click")]
+  pub show_menu_on_left_click: bool,
   /// Title for MacOS tray
   pub title: Option<String>,
   /// Tray icon tooltip on Windows and macOS
@@ -3351,7 +3363,9 @@ mod build {
     fn to_tokens(&self, tokens: &mut TokenStream) {
       let id = opt_str_lit(self.id.as_ref());
       let icon_as_template = self.icon_as_template;
+      #[allow(deprecated)]
       let menu_on_left_click = self.menu_on_left_click;
+      let show_menu_on_left_click = self.show_menu_on_left_click;
       let icon_path = path_buf_lit(&self.icon_path);
       let title = opt_str_lit(self.title.as_ref());
       let tooltip = opt_str_lit(self.tooltip.as_ref());
@@ -3362,6 +3376,7 @@ mod build {
         icon_path,
         icon_as_template,
         menu_on_left_click,
+        show_menu_on_left_click,
         title,
         tooltip
       );
diff --git a/crates/tauri/scripts/bundle.global.js b/crates/tauri/scripts/bundle.global.js
diff --git a/crates/tauri/src/app.rs b/crates/tauri/src/app.rs
@@ -2042,10 +2042,12 @@ tauri::Builder::default()
     {
       let config = app.config();
       if let Some(tray_config) = &config.app.tray_icon {
+        #[allow(deprecated)]
         let mut tray =
           TrayIconBuilder::with_id(tray_config.id.clone().unwrap_or_else(|| "main".into()))
             .icon_as_template(tray_config.icon_as_template)
-            .menu_on_left_click(tray_config.menu_on_left_click);
+            .menu_on_left_click(tray_config.menu_on_left_click)
+            .show_menu_on_left_click(tray_config.show_menu_on_left_click);
         if let Some(icon) = &app.manager.tray.icon {
           tray = tray.icon(icon.clone());
         }
diff --git a/crates/tauri/src/menu/check.rs b/crates/tauri/src/menu/check.rs
@@ -119,9 +119,9 @@ impl<R: Runtime> CheckMenuItem<R> {
   /// Set this menu item accelerator.
   pub fn set_accelerator<S: AsRef<str>>(&self, accelerator: Option<S>) -> crate::Result<()> {
     let accel = accelerator.and_then(|s| s.as_ref().parse().ok());
-    run_item_main_thread!(self, |self_: Self| (*self_.0)
-      .as_ref()
-      .set_accelerator(accel))?
+    run_item_main_thread!(self, |self_: Self| {
+      (*self_.0).as_ref().set_accelerator(accel)
+    })?
     .map_err(Into::into)
   }
 
diff --git a/crates/tauri/src/menu/icon.rs b/crates/tauri/src/menu/icon.rs
@@ -206,9 +206,9 @@ impl<R: Runtime> IconMenuItem<R> {
   /// Set this menu item accelerator.
   pub fn set_accelerator<S: AsRef<str>>(&self, accelerator: Option<S>) -> crate::Result<()> {
     let accel = accelerator.and_then(|s| s.as_ref().parse().ok());
-    run_item_main_thread!(self, |self_: Self| (*self_.0)
-      .as_ref()
-      .set_accelerator(accel))?
+    run_item_main_thread!(self, |self_: Self| {
+      (*self_.0).as_ref().set_accelerator(accel)
+    })?
     .map_err(Into::into)
   }
 
@@ -228,9 +228,9 @@ impl<R: Runtime> IconMenuItem<R> {
   /// - **Windows / Linux**: Unsupported.
   pub fn set_native_icon(&self, _icon: Option<NativeIcon>) -> crate::Result<()> {
     #[cfg(target_os = "macos")]
-    return run_item_main_thread!(self, |self_: Self| (*self_.0)
-      .as_ref()
-      .set_native_icon(_icon.map(Into::into)));
+    return run_item_main_thread!(self, |self_: Self| {
+      (*self_.0).as_ref().set_native_icon(_icon.map(Into::into))
+    });
     #[allow(unreachable_code)]
     Ok(())
   }
diff --git a/crates/tauri/src/menu/menu.rs b/crates/tauri/src/menu/menu.rs
@@ -271,9 +271,9 @@ impl<R: Runtime> Menu<R> {
   /// [`Submenu`]: super::Submenu
   pub fn append(&self, item: &dyn IsMenuItem<R>) -> crate::Result<()> {
     let kind = item.kind();
-    run_item_main_thread!(self, |self_: Self| (*self_.0)
-      .as_ref()
-      .append(kind.inner().inner_muda()))?
+    run_item_main_thread!(self, |self_: Self| {
+      (*self_.0).as_ref().append(kind.inner().inner_muda())
+    })?
     .map_err(Into::into)
   }
 
@@ -301,9 +301,9 @@ impl<R: Runtime> Menu<R> {
   /// [`Submenu`]: super::Submenu
   pub fn prepend(&self, item: &dyn IsMenuItem<R>) -> crate::Result<()> {
     let kind = item.kind();
-    run_item_main_thread!(self, |self_: Self| (*self_.0)
-      .as_ref()
-      .prepend(kind.inner().inner_muda()))?
+    run_item_main_thread!(self, |self_: Self| {
+      (*self_.0).as_ref().prepend(kind.inner().inner_muda())
+    })?
     .map_err(Into::into)
   }
 
@@ -351,18 +351,20 @@ impl<R: Runtime> Menu<R> {
   /// Remove a menu item from this menu.
   pub fn remove(&self, item: &dyn IsMenuItem<R>) -> crate::Result<()> {
     let kind = item.kind();
-    run_item_main_thread!(self, |self_: Self| (*self_.0)
-      .as_ref()
-      .remove(kind.inner().inner_muda()))?
+    run_item_main_thread!(self, |self_: Self| {
+      (*self_.0).as_ref().remove(kind.inner().inner_muda())
+    })?
     .map_err(Into::into)
   }
 
   /// Remove the menu item at the specified position from this menu and returns it.
   pub fn remove_at(&self, position: usize) -> crate::Result<Option<MenuItemKind<R>>> {
-    run_item_main_thread!(self, |self_: Self| (*self_.0)
-      .as_ref()
-      .remove_at(position)
-      .map(|i| MenuItemKind::from_muda(self_.0.app_handle.clone(), i)))
+    run_item_main_thread!(self, |self_: Self| {
+      (*self_.0)
+        .as_ref()
+        .remove_at(position)
+        .map(|i| MenuItemKind::from_muda(self_.0.app_handle.clone(), i))
+    })
   }
 
   /// Retrieves the menu item matching the given identifier.
@@ -380,12 +382,14 @@ impl<R: Runtime> Menu<R> {
 
   /// Returns a list of menu items that has been added to this menu.
   pub fn items(&self) -> crate::Result<Vec<MenuItemKind<R>>> {
-    run_item_main_thread!(self, |self_: Self| (*self_.0)
-      .as_ref()
-      .items()
-      .into_iter()
-      .map(|i| MenuItemKind::from_muda(self_.0.app_handle.clone(), i))
-      .collect::<Vec<_>>())
+    run_item_main_thread!(self, |self_: Self| {
+      (*self_.0)
+        .as_ref()
+        .items()
+        .into_iter()
+        .map(|i| MenuItemKind::from_muda(self_.0.app_handle.clone(), i))
+        .collect::<Vec<_>>()
+    })
   }
 
   /// Set this menu as the application menu.
diff --git a/crates/tauri/src/menu/normal.rs b/crates/tauri/src/menu/normal.rs
@@ -117,9 +117,9 @@ impl<R: Runtime> MenuItem<R> {
   /// Set this menu item accelerator.
   pub fn set_accelerator<S: AsRef<str>>(&self, accelerator: Option<S>) -> crate::Result<()> {
     let accel = accelerator.and_then(|s| s.as_ref().parse().ok());
-    run_item_main_thread!(self, |self_: Self| (*self_.0)
-      .as_ref()
-      .set_accelerator(accel))?
+    run_item_main_thread!(self, |self_: Self| {
+      (*self_.0).as_ref().set_accelerator(accel)
+    })?
     .map_err(Into::into)
   }
 }
diff --git a/crates/tauri/src/menu/submenu.rs b/crates/tauri/src/menu/submenu.rs
@@ -173,9 +173,9 @@ impl<R: Runtime> Submenu<R> {
   /// Add a menu item to the end of this submenu.
   pub fn append(&self, item: &dyn IsMenuItem<R>) -> crate::Result<()> {
     let kind = item.kind();
-    run_item_main_thread!(self, |self_: Self| (*self_.0)
-      .as_ref()
-      .append(kind.inner().inner_muda()))?
+    run_item_main_thread!(self, |self_: Self| {
+      (*self_.0).as_ref().append(kind.inner().inner_muda())
+    })?
     .map_err(Into::into)
   }
 
@@ -225,18 +225,20 @@ impl<R: Runtime> Submenu<R> {
   /// Remove a menu item from this submenu.
   pub fn remove(&self, item: &dyn IsMenuItem<R>) -> crate::Result<()> {
     let kind = item.kind();
-    run_item_main_thread!(self, |self_: Self| (*self_.0)
-      .as_ref()
-      .remove(kind.inner().inner_muda()))?
+    run_item_main_thread!(self, |self_: Self| {
+      (*self_.0).as_ref().remove(kind.inner().inner_muda())
+    })?
     .map_err(Into::into)
   }
 
   /// Remove the menu item at the specified position from this submenu and returns it.
   pub fn remove_at(&self, position: usize) -> crate::Result<Option<MenuItemKind<R>>> {
-    run_item_main_thread!(self, |self_: Self| (*self_.0)
-      .as_ref()
-      .remove_at(position)
-      .map(|i| MenuItemKind::from_muda(self_.0.app_handle.clone(), i)))
+    run_item_main_thread!(self, |self_: Self| {
+      (*self_.0)
+        .as_ref()
+        .remove_at(position)
+        .map(|i| MenuItemKind::from_muda(self_.0.app_handle.clone(), i))
+    })
   }
 
   /// Retrieves the menu item matching the given identifier.
@@ -293,9 +295,9 @@ impl<R: Runtime> Submenu<R> {
   /// certain other items to the menu.
   #[cfg(target_os = "macos")]
   pub fn set_as_windows_menu_for_nsapp(&self) -> crate::Result<()> {
-    run_item_main_thread!(self, |self_: Self| (*self_.0)
-      .as_ref()
-      .set_as_windows_menu_for_nsapp())?;
+    run_item_main_thread!(self, |self_: Self| {
+      (*self_.0).as_ref().set_as_windows_menu_for_nsapp()
+    })?;
     Ok(())
   }
 
@@ -307,9 +309,9 @@ impl<R: Runtime> Submenu<R> {
   /// which has a title matching the localized word "Help".
   #[cfg(target_os = "macos")]
   pub fn set_as_help_menu_for_nsapp(&self) -> crate::Result<()> {
-    run_item_main_thread!(self, |self_: Self| (*self_.0)
-      .as_ref()
-      .set_as_help_menu_for_nsapp())?;
+    run_item_main_thread!(self, |self_: Self| {
+      (*self_.0).as_ref().set_as_help_menu_for_nsapp()
+    })?;
     Ok(())
   }
 }
diff --git a/crates/tauri/src/tray/mod.rs b/crates/tauri/src/tray/mod.rs
diff --git a/crates/tauri/src/tray/plugin.rs b/crates/tauri/src/tray/plugin.rs
diff --git a/examples/api/src-tauri/src/tray.rs b/examples/api/src-tauri/src/tray.rs
diff --git a/packages/api/src/tray.ts b/packages/api/src/tray.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +---
 +"@tauri-apps/api": "minor:feat"
 +---
++
 +Add `TrayIcon.setShowMenuOnLeftClick` method and deprecate `TrayIcon.setMenuOnLeftClick` to match the Rust API.
++
Original file line number	Diff line number	Diff line change
`@@ -2042,10 +2042,12 @@ tauri::Builder::default()`
`2042`	`2042`	`{`
`2043`	`2043`	`let config = app.config();`
`2044`	`2044`	`if let Some(tray_config) = &config.app.tray_icon {`
	`2045`	`+ #[allow(deprecated)]`
`2045`	`2046`	`let mut tray =`
`2046`	`2047`	`TrayIconBuilder::with_id(tray_config.id.clone().unwrap_or_else(\|\| "main".into()))`
`2047`	`2048`	`.icon_as_template(tray_config.icon_as_template)`
`2048`		`- .menu_on_left_click(tray_config.menu_on_left_click);`
	`2049`	`+ .menu_on_left_click(tray_config.menu_on_left_click)`
	`2050`	`+ .show_menu_on_left_click(tray_config.show_menu_on_left_click);`
`2049`	`2051`	`if let Some(icon) = &app.manager.tray.icon {`
`2050`	`2052`	`tray = tray.icon(icon.clone());`
`2051`	`2053`	`}`