托盘与通知

在 Compose Multiplatform 桌面端中，您可以向系统托盘添加应用程序图标，并以此发送系统通知。

undefined

系统托盘

使用 Tray() 可组合项向系统托盘添加应用程序图标。Tray() 在 application() 函数的作用域内可用，因此可以与应用程序窗口一起调用，也可以单独调用。

Tray() 可组合项具有以下形参：

icon – 绘制托盘图标的 Painter。
menu – 托盘菜单的内容。在 Windows 上通过右键点击打开菜单，在 macOS 上通过左键点击打开。如果您不添加任何项，则菜单不会出现。
state – 用于发送通知的 TrayState。
tooltip – 当用户将鼠标悬停在图标上时显示的工具提示。
onAction – 点击图标触发的操作：在 Windows 上为双击，在 macOS 上为右键点击。

以下示例在托盘中创建了一个具有三个菜单项的应用程序图标：

Increment value（增加值）更改窗口中显示的状态。
Send notification（发送通知）发送一条系统通知。
Exit（退出）关闭应用程序。

kotlin

import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.material.Text
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.geometry.Offset
import androidx.compose.ui.geometry.Size
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.graphics.drawscope.DrawScope
import androidx.compose.ui.graphics.painter.Painter
import androidx.compose.ui.window.Tray
import androidx.compose.ui.window.Window
import androidx.compose.ui.window.application
import androidx.compose.ui.window.rememberNotification
import androidx.compose.ui.window.rememberTrayState

fun main() = application {
    var count by remember { mutableStateOf(0) }
    var isOpen by remember { mutableStateOf(true) }

    if (isOpen) {
        val trayState = rememberTrayState()
        val notification = rememberNotification("Notification", "Message from MyApp!")

        Tray(
            state = trayState,
            icon = TrayIcon,
            menu = {
                Item(
                    "Increment value",
                    onClick = {
                        count++
                    }
                )
                Item(
                    "Send notification",
                    onClick = {
                        trayState.sendNotification(notification)
                    }
                )
                Item(
                    "Exit",
                    onClick = {
                        isOpen = false
                    }
                )
            }
        )

        Window(
            onCloseRequest = {
                isOpen = false
            },
            icon = MyAppIcon
        ) {
            // 窗口内容：
            Box(
                modifier = Modifier.fillMaxSize(),
                contentAlignment = Alignment.Center
            ) {
                Text(text = "Value: $count")
            }
        }
    }
}

object MyAppIcon : Painter() {
    override val intrinsicSize = Size(256f, 256f)

    override fun DrawScope.onDraw() {
        drawOval(Color.Green, Offset(size.width / 4, 0f), Size(size.width / 2f, size.height))
        drawOval(Color.Blue, Offset(0f, size.height / 4), Size(size.width, size.height / 2f))
        drawOval(Color.Red, Offset(size.width / 4, size.height / 4), Size(size.width / 2f, size.height / 2f))
    }
}

object TrayIcon : Painter() {
    override val intrinsicSize = Size(256f, 256f)

    override fun DrawScope.onDraw() {
        drawOval(Color(0xFFFFA500))
    }
}

并非每个桌面环境都具有系统托盘。如果平台不支持系统托盘，Tray() 会向标准错误流输出错误，而不是抛出异常。在应用程序中显示与托盘相关的选项之前，请先检查 isTraySupported 属性。

无窗口托盘

应用程序不需要窗口也可以拥有托盘图标。如果仅调用 Tray() 函数，应用程序将完全在系统托盘中运行：

kotlin

import androidx.compose.ui.geometry.Size
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.graphics.drawscope.DrawScope
import androidx.compose.ui.graphics.painter.Painter
import androidx.compose.ui.window.Tray
import androidx.compose.ui.window.application

fun main() = application {
    Tray(
        icon = TrayIcon,
        menu = {
            Item(
                "Exit",
                onClick = ::exitApplication
            )
        }
    )
}

object TrayIcon : Painter() {
    override val intrinsicSize = Size(256f, 256f)

    override fun DrawScope.onDraw() {
        drawOval(Color(0xFFFFA500))
    }
}

由于没有可关闭的窗口，应从菜单项中调用 exitApplication()。

通知

要发送系统通知，请使用 rememberNotification() 创建通知并将其传递给 TrayState.sendNotification()，如系统托盘示例中所示。通知通过传递给 Tray() 可组合项的 TrayState 进行传送。如果该状态未附加到托盘，通知将会丢失。

一条通知由标题、消息和类型组成，类型定义了通知的图标和声音。可用的类型有 None（默认选项）、Info、Warning 和 Error。

图标和声音所使用的具体资源取决于平台。

要在 macOS 上测试通知，必须对应用进行打包。否则，通知将不会显示。

下一步

了解如何向窗口添加菜单栏。
探索有关其他桌面组件的教程。

托盘与通知 ​

托盘与通知 ​

系统托盘 ​

无窗口托盘 ​

通知 ​

下一步 ​

托盘与通知

托盘与通知

系统托盘

无窗口托盘

通知

下一步