Merge pull request #211 from kdroidFilter/workaround-macos

Improve macOS Tray Behavior Documentation and Parameter Naming

Author: kdroidFilter

README.md

@@ -25,7 +25,8 @@
 - Improves the appearance of the tray on Linux, which previously resembled Windows 95.
 - Adds support for checkable items, dividers, and submenus, including nested submenus.
 - Supports primary action for Windows, macOS, and Linux.
-  - On Windows and macOS, the primary action is triggered by a left-click on the tray icon.
+  - On Windows, the primary action is triggered by a left-click on the tray icon.
+  - On macOS, left-clicking opens the tray menu (macOS convention) while right-clicking has no effect. The primary action is added as the first item in the menu.
   - On Linux, due to the limitations of `libappindicator`, the primary action creates an item at the top of the context menu (with a customizable label). If the context menu is empty, the library uses `gtkstatusicon` to capture the primary action without needing to add an item to the context menu.
 - **Single Instance Management**: Ensures that only one instance of the application can run at a time and allows restoring focus to the running instance when another instance is attempted.
 - **Tray Position Detection**: Allows determining the position of the system tray, which helps in positioning related windows appropriately.
@@ -53,7 +54,7 @@ To use the ComposeTray library, add it as a dependency in your `build.gradle.kts
 
 ```kotlin
 dependencies {
-  implementation("io.github.kdroidfilter:composenativetray:0.6.0")
+  implementation("io.github.kdroidfilter:composenativetray:<version>")
 }
 ```
 
@@ -79,7 +80,7 @@ application {
     primaryAction = {
       Log.i(logTag, "Primary action triggered")
     },
-    primaryActionLinuxLabel = "Open Application"
+    primaryActionLabel = "Open Application"
   ) {
     SubMenu(label = "Options") {
       Item(label = "Setting 1") {

demo/src/jvmMain/kotlin/com/kdroid/composetray/demo/DemoAdaptivePositionWindows.kt

@@ -14,7 +14,6 @@ import androidx.compose.ui.window.Window
 import androidx.compose.ui.window.application
 import androidx.compose.ui.window.rememberWindowState
 import com.kdroid.composetray.tray.api.Tray
-import com.kdroid.composetray.utils.IconRenderProperties
 import com.kdroid.composetray.utils.SingleInstanceManager
 import com.kdroid.composetray.utils.getTrayPosition
 import com.kdroid.composetray.utils.getTrayWindowPosition
@@ -65,7 +64,7 @@ fun main() = application {
                 isWindowVisible = true
                 Log.i(logTag, "On Primary Clicked")
             },
-            primaryActionLinuxLabel = "Open the Application",
+            primaryActionLabel = "Open the Application",
             tooltip = "My Application"
         ) {
 

demo/src/jvmMain/kotlin/com/kdroid/composetray/demo/DemoWithContextMenu.kt

@@ -13,7 +13,6 @@ import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.window.Window
 import androidx.compose.ui.window.application
 import com.kdroid.composetray.tray.api.Tray
-import com.kdroid.composetray.utils.IconRenderProperties
 import com.kdroid.composetray.utils.SingleInstanceManager
 import com.kdroid.composetray.utils.getTrayPosition
 import com.kdroid.kmplog.Log
@@ -61,7 +60,7 @@ fun main() = application {
                 isWindowVisible = true
                 Log.i(logTag, "On Primary Clicked")
             },
-            primaryActionLinuxLabel = "Open the Application",
+            primaryActionLabel = "Open the Application",
             tooltip = "My Application"
         ) {
             // Options SubMenu

demo/src/jvmMain/kotlin/com/kdroid/composetray/demo/DemoWithoutContextMenu.kt

@@ -57,7 +57,7 @@ fun main() = application {
                 isWindowVisible = true
                 Log.i(logTag, "On Primary Clicked")
             },
-            primaryActionLinuxLabel = "Open the Application",
+            primaryActionLabel = "Open the Application",
             tooltip = "My Application"
         )
     }

demo/src/jvmMain/kotlin/com/kdroid/composetray/demo/DynamicTrayMenu.kt

@@ -8,7 +8,6 @@ import androidx.compose.runtime.setValue
 import androidx.compose.ui.window.Window
 import androidx.compose.ui.window.application
 import com.kdroid.composetray.tray.api.Tray
-import com.kdroid.composetray.utils.IconRenderProperties
 import com.kdroid.composetray.utils.SingleInstanceManager
 import com.kdroid.composetray.utils.getTrayPosition
 import com.kdroid.kmplog.Log
@@ -64,7 +63,7 @@ fun main() = application {
                 isWindowVisible = true
                 Log.i(logTag, "On Primary Clicked")
             },
-            primaryActionLinuxLabel = "Open the Application",
+            primaryActionLabel = "Open the Application",
             tooltip = "My Application",
             menuContent = {
                 Item("Change icon") {

src/commonMain/kotlin/com/kdroid/composetray/tray/api/NativeTray.kt

@@ -38,17 +38,17 @@ internal class NativeTray {
      */
     @Deprecated(
         message = "Use the constructor with composable icon content instead",
-        replaceWith = ReplaceWith("NativeTray(iconContent, tooltip, primaryAction, primaryActionLinuxLabel, menuContent)")
+        replaceWith = ReplaceWith("NativeTray(iconContent, tooltip, primaryAction, primaryActionLabel, menuContent)")
     )
     constructor(
         iconPath: String,
         windowsIconPath: String = iconPath,
         tooltip: String = "",
         primaryAction: (() -> Unit)?,
-        primaryActionLinuxLabel: String,
+        primaryActionLabel: String,
         menuContent: (TrayMenuBuilder.() -> Unit)? = null
     ) {
-        initializeTray(iconPath, windowsIconPath, tooltip, primaryAction, primaryActionLinuxLabel, menuContent)
+        initializeTray(iconPath, windowsIconPath, tooltip, primaryAction, primaryActionLabel, menuContent)
     }
 
     /**
@@ -59,7 +59,7 @@ internal class NativeTray {
         iconRenderProperties: IconRenderProperties = IconRenderProperties(),
         tooltip: String = "",
         primaryAction: (() -> Unit)?,
-        primaryActionLinuxLabel: String,
+        primaryActionLabel: String,
         menuContent: (TrayMenuBuilder.() -> Unit)? = null
     ) {
         // Render the composable to PNG file for general use
@@ -76,15 +76,15 @@ internal class NativeTray {
             pngIconPath
         }
 
-        initializeTray(pngIconPath, windowsIconPath, tooltip, primaryAction, primaryActionLinuxLabel, menuContent)
+        initializeTray(pngIconPath, windowsIconPath, tooltip, primaryAction, primaryActionLabel, menuContent)
     }
 
     private fun initializeTray(
         iconPath: String,
         windowsIconPath: String,
         tooltip: String,
         primaryAction: (() -> Unit)?,
-        primaryActionLinuxLabel: String,
+        primaryActionLabel: String,
         menuContent: (TrayMenuBuilder.() -> Unit)? = null
     ) {
         trayScope.launch {
@@ -94,7 +94,7 @@ internal class NativeTray {
                 when (os) {
                     LINUX -> {
                         Log.d("NativeTray", "Initializing Linux tray with icon path: $iconPath")
-                        LinuxTrayInitializer.initialize(iconPath, tooltip, primaryAction, primaryActionLinuxLabel, menuContent)
+                        LinuxTrayInitializer.initialize(iconPath, tooltip, primaryAction, primaryActionLabel, menuContent)
                         trayInitialized = true
                     }
 
@@ -146,22 +146,22 @@ internal class NativeTray {
  * @param windowsIconPath The file path to the tray icon specifically for Windows. Defaults to the value of `iconPath`.
  * @param tooltip The tooltip text to be displayed when the user hovers over the tray icon.
  * @param primaryAction An optional callback to be invoked when the tray icon is clicked (handled only on specific platforms).
- * @param primaryActionLinuxLabel The label for the primary action on Linux. Defaults to "Open".
+ * @param primaryActionLabel The label for the primary action on Linux and macOS. Defaults to "Open".
  * @param menuContent A lambda that builds the tray menu using a `TrayMenuBuilder`. Define the menu structure, including items, checkable items, dividers, and submenus.
  * 
  * @deprecated Use the version with composable icon content instead
  */
 @Deprecated(
     message = "Use the version with composable icon content instead",
-    replaceWith = ReplaceWith("Tray(iconContent, tooltip, primaryAction, primaryActionLinuxLabel, menuContent)")
+    replaceWith = ReplaceWith("Tray(iconContent, tooltip, primaryAction, primaryActionLabel, menuContent)")
 )
 @Composable
 fun ApplicationScope.Tray(
     iconPath: String,
     windowsIconPath: String = iconPath,
     tooltip: String,
     primaryAction: (() -> Unit)? = null,
-    primaryActionLinuxLabel: String = "Open",
+    primaryActionLabel: String = "Open",
     menuContent: (TrayMenuBuilder.() -> Unit)? = null
 ) {
     val absoluteIconPath = remember(iconPath) { extractToTempIfDifferent(iconPath)?.absolutePath.orEmpty() }
@@ -174,15 +174,15 @@ fun ApplicationScope.Tray(
         absoluteWindowsIconPath,
         tooltip,
         primaryAction,
-        primaryActionLinuxLabel,
+        primaryActionLabel,
         menuContent
     ) {
         val tray = NativeTray(
             iconPath = absoluteIconPath,
             windowsIconPath = absoluteWindowsIconPath,
             tooltip = tooltip,
             primaryAction = primaryAction,
-            primaryActionLinuxLabel = primaryActionLinuxLabel,
+            primaryActionLabel = primaryActionLabel,
             menuContent = menuContent
         )
 
@@ -201,7 +201,7 @@ fun ApplicationScope.Tray(
  * @param iconRenderProperties Properties for rendering the icon.
  * @param tooltip The tooltip text to be displayed when the user hovers over the tray icon.
  * @param primaryAction An optional callback to be invoked when the tray icon is clicked (handled only on specific platforms).
- * @param primaryActionLinuxLabel The label for the primary action on Linux. Defaults to "Open".
+ * @param primaryActionLabel The label for the primary action on Linux and macOS. Defaults to "Open".
  * @param menuContent A lambda that builds the tray menu using a `TrayMenuBuilder`. Define the menu structure, including items, checkable items, dividers, and submenus.
  */
 @Composable
@@ -210,7 +210,7 @@ fun ApplicationScope.Tray(
     iconRenderProperties: IconRenderProperties = IconRenderProperties.forCurrentOperatingSystem(),
     tooltip: String,
     primaryAction: (() -> Unit)? = null,
-    primaryActionLinuxLabel: String = "Open",
+    primaryActionLabel: String = "Open",
     menuContent: (TrayMenuBuilder.() -> Unit)? = null,
 ) {
     // Calculate a hash of the rendered composable content to detect changes
@@ -221,7 +221,7 @@ fun ApplicationScope.Tray(
         iconRenderProperties,
         tooltip,
         primaryAction,
-        primaryActionLinuxLabel,
+        primaryActionLabel,
         menuContent,
         contentHash, // Use the content hash as an implicit key
     ) {
@@ -230,7 +230,7 @@ fun ApplicationScope.Tray(
             iconRenderProperties = iconRenderProperties,
             tooltip = tooltip,
             primaryAction = primaryAction,
-            primaryActionLinuxLabel = primaryActionLinuxLabel,
+            primaryActionLabel = primaryActionLabel,
             menuContent = menuContent,
         )
 

src/commonMain/kotlin/com/kdroid/composetray/tray/impl/AwtTrayInitializer.kt

@@ -2,6 +2,8 @@ package com.kdroid.composetray.tray.impl
 
 import com.kdroid.composetray.menu.api.TrayMenuBuilder
 import com.kdroid.composetray.menu.impl.AwtTrayMenuBuilderImpl
+import io.github.kdroidfilter.platformtools.OperatingSystem
+import io.github.kdroidfilter.platformtools.getOperatingSystem
 import java.awt.PopupMenu
 import java.awt.SystemTray
 import java.awt.Toolkit
@@ -42,24 +44,46 @@ object AwtTrayInitializer {
 
         // Create the tray icon
         val trayImage = Toolkit.getDefaultToolkit().getImage(iconPath)
+
         val newTrayIcon = TrayIcon(trayImage, tooltip, popupMenu).apply {
             isImageAutoSize = true
 
-            // Handle the left-click if specified
-            onLeftClick?.let { clickAction ->
-                addMouseListener(object : MouseAdapter() {
-                    override fun mouseClicked(e: MouseEvent) {
-                        if (e.button == MouseEvent.BUTTON1) {
-                            clickAction()
+            // On macOS, we cannot easily override the default left-click behavior
+            // when a popup menu is attached. We have two options:
+            // 1. Accept that left-click opens the menu (macOS convention)
+            // 2. Use a more complex native implementation via JNA
+
+            if (getOperatingSystem() == OperatingSystem.MACOS) {
+                // For macOS, add primary action as the first menu item if both menu and action exist
+                if (onLeftClick != null && menuContent != null) {
+                    // The primary action will be added as the first menu item
+                    // This is handled in the menu building phase
+                }
+            } else {
+                // For other platforms, handle left-click normally
+                onLeftClick?.let { clickAction ->
+                    addMouseListener(object : MouseAdapter() {
+                        override fun mouseClicked(e: MouseEvent) {
+                            if (e.button == MouseEvent.BUTTON1) {
+                                clickAction()
+                            }
                         }
-                    }
-                })
+                    })
+                }
             }
         }
 
         // Add the menu content if specified
         menuContent?.let {
-            AwtTrayMenuBuilderImpl(popupMenu, newTrayIcon).apply(it)
+            // For macOS, prepend the primary action to the menu if it exists
+            if (getOperatingSystem() == OperatingSystem.MACOS && onLeftClick != null) {
+                val menuBuilder = AwtTrayMenuBuilderImpl(popupMenu, newTrayIcon)
+                menuBuilder.Item("Open", true) { onLeftClick.invoke() }
+                menuBuilder.Divider()
+                menuBuilder.apply(it)
+            } else {
+                AwtTrayMenuBuilderImpl(popupMenu, newTrayIcon).apply(it)
+            }
         }
 
         // Add the icon to the system tray

src/commonMain/kotlin/com/kdroid/composetray/tray/impl/LinuxTrayInitializer.kt

@@ -85,7 +85,7 @@ object LinuxTrayInitializer {
         iconPath: String,
         tooltip: String,
         primaryAction: (() -> Unit)?,
-        primaryActionLinuxLabel: String,
+        primaryActionLabel: String,
         menuContent: (TrayMenuBuilder.() -> Unit)?
     ) {
         cleanPreviousInstance()
@@ -97,7 +97,7 @@ object LinuxTrayInitializer {
                 iconPath = iconPath,
                 tooltip = tooltip,
                 primaryAction = primaryAction,
-                primaryActionLinuxLabel = primaryActionLinuxLabel,
+                primaryActionLabel = primaryActionLabel,
                 menuContent = menuContent
             )
         } else if (primaryAction != null) {
@@ -134,7 +134,7 @@ object LinuxTrayInitializer {
         iconPath: String,
         tooltip: String,
         primaryAction: (() -> Unit)?,
-        primaryActionLinuxLabel: String,
+        primaryActionLabel: String,
         menuContent: (TrayMenuBuilder.() -> Unit)?
     ) {
         try {
@@ -152,7 +152,7 @@ object LinuxTrayInitializer {
             currentMenuBuilder.set(trayMenuBuilder)
 
             primaryAction?.let {
-                addPrimaryActionMenuItem(trayMenuBuilder, it, primaryActionLinuxLabel)
+                addPrimaryActionMenuItem(trayMenuBuilder, it, primaryActionLabel)
             }
 
             trayMenuBuilder.apply(menuContent!!)
@@ -170,9 +170,9 @@ object LinuxTrayInitializer {
     private fun addPrimaryActionMenuItem(
         trayMenuBuilder: LinuxTrayMenuBuilderImpl,
         primaryAction: () -> Unit,
-        primaryActionLinuxLabel: String
+        primaryActionLabel: String
     ) {
-        trayMenuBuilder.Item(primaryActionLinuxLabel) {
+        trayMenuBuilder.Item(primaryActionLabel) {
             saveTrayIconPosition()
             primaryAction.invoke()
         }
@@ -229,4 +229,4 @@ object LinuxTrayInitializer {
         }
     }
 
-}
+}