clippy, fmt, and config option

tauri-apps · Nov 19, 2024 · d816040 · d816040
1 parent 6edb84f
commit d816040
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 3 deletions.
diff --git a/crates/tauri-cli/config.schema.json b/crates/tauri-cli/config.schema.json
@@ -1624,6 +1624,12 @@
           "type": "boolean"
         },
         "menuOnLeftClick": {
+          "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,6 +1624,12 @@
           "type": "boolean"
         },
         "menuOnLeftClick": {
+          "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
@@ -2437,7 +2437,15 @@ pub struct TrayIconConfig {
   ///
   /// - **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
@@ -3355,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());
@@ -3366,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/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/tray/mod.rs b/crates/tauri/src/tray/mod.rs
@@ -312,7 +312,10 @@ impl<R: Runtime> TrayIconBuilder<R> {
   /// ## Platform-specific:
   ///
   /// - **Linux:** Unsupported.
-  #[deprecated(since = "2.2.0", note = "Use `TrayIconBuiler::show_menu_on_left_click` instead.")]
+  #[deprecated(
+    since = "2.2.0",
+    note = "Use `TrayIconBuiler::show_menu_on_left_click` instead."
+  )]
   pub fn menu_on_left_click(mut self, enable: bool) -> Self {
     self.inner = self.inner.with_menu_on_left_click(enable);
     self

diff --git a/examples/api/src-tauri/src/tray.rs b/examples/api/src-tauri/src/tray.rs
@@ -48,7 +48,7 @@ pub fn create_tray<R: Runtime>(app: &tauri::AppHandle<R>) -> tauri::Result<()> {
     .tooltip("Tauri")
     .icon(app.default_window_icon().unwrap().clone())
     .menu(&menu1)
-    .menu_on_left_click(false)
+    .show_menu_on_left_click(false)
     .on_menu_event(move |app, event| match event.id.as_ref() {
       "quit" => {
         app.exit(0);