Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leanflutter/tray_manager
This plugin allows Flutter desktop apps to defines system tray.
https://github.com/leanflutter/tray_manager
tray tray-icon
Last synced: 5 days ago
JSON representation
This plugin allows Flutter desktop apps to defines system tray.
- Host: GitHub
- URL: https://github.com/leanflutter/tray_manager
- Owner: leanflutter
- License: mit
- Created: 2021-08-06T08:05:52.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-22T14:26:05.000Z (15 days ago)
- Last Synced: 2025-01-25T20:02:46.680Z (12 days ago)
- Topics: tray, tray-icon
- Language: C++
- Homepage: https://pub.dev/packages/tray_manager
- Size: 516 KB
- Stars: 248
- Watchers: 5
- Forks: 45
- Open Issues: 19
-
Metadata Files:
- Readme: README-ZH.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-flutter-desktop - tray_manager - This plugin allows Flutter desktop apps to defines system tray. (Packages)
README
# tray_manager
[![pub version][pub-image]][pub-url] [![][discord-image]][discord-url] ![][visits-count-image]
[pub-image]: https://img.shields.io/pub/v/tray_manager.svg
[pub-url]: https://pub.dev/packages/tray_manager
[discord-image]: https://img.shields.io/discord/884679008049037342.svg
[discord-url]: https://discord.gg/zPa6EZ2jqb
[visits-count-image]: https://img.shields.io/badge/dynamic/json?label=Visits%20Count&query=value&url=https://api.countapi.xyz/hit/leanflutter.tray_manager/visits
这个插件允许 Flutter 桌面应用定义系统托盘。
---
[English](./README.md) | 简体中文
---
- [平台支持](#%E5%B9%B3%E5%8F%B0%E6%94%AF%E6%8C%81)
- [截图](#%E6%88%AA%E5%9B%BE)
- [已知问题](#%E5%B7%B2%E7%9F%A5%E9%97%AE%E9%A2%98)
- [与 app_links 不兼容](#%E4%B8%8E-app_links-%E4%B8%8D%E5%85%BC%E5%AE%B9)
- [快速开始](#%E5%BF%AB%E9%80%9F%E5%BC%80%E5%A7%8B)
- [安装](#%E5%AE%89%E8%A3%85)
- [Linux requirements](#linux-requirements)
- [用法](#%E7%94%A8%E6%B3%95)
- [监听事件](#%E7%9B%91%E5%90%AC%E4%BA%8B%E4%BB%B6)
- [谁在用使用它？](#%E8%B0%81%E5%9C%A8%E7%94%A8%E4%BD%BF%E7%94%A8%E5%AE%83)
- [API](#api)
- [TrayManager](#traymanager)
- [许可证](#%E8%AE%B8%E5%8F%AF%E8%AF%81)
## 平台支持
| Linux | macOS | Windows |
| :---: | :---: | :-----: |
| ✔️ | ✔️ | ✔️ |
## 截图
| macOS | Linux | Windows |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
|  |  |  |
## 已知问题
### 与 app_links 不兼容
当同时使用 `app_links` 包和 `tray_manager` 时，可能会出现插件无法正常工作。这是因为低版本 `app_links` 在内部阻止了事件传播，导致菜单点击事件无法触发。
要解决此问题：
1. 确保你的 `app_links` 包版本大于或等于 6.3.3
```yaml
dependencies:
app_links: ^6.3.3
```
2. 使用 [protocol_handler](https://github.com/leanflutter/protocol_handler) 包代替 `app_links` 包。
## 快速开始
### 安装
将此添加到你的软件包的 pubspec.yaml 文件：
```yaml
dependencies:
tray_manager: ^0.3.1
```
或
```yaml
dependencies:
tray_manager:
git:
url: https://github.com/leanflutter/tray_manager.git
ref: main
```
#### Linux requirements
- `ayatana-appindicator3-0.1` or `appindicator3-0.1`
运行以下命令
```
sudo apt-get install libayatana-appindicator3-dev
```
或
```
sudo apt-get install appindicator3-0.1 libappindicator3-dev
```
### 用法
```dart
import 'package:flutter/material.dart' hide MenuItem;
import 'package:tray_manager/tray_manager.dart';
await trayManager.setIcon(
Platform.isWindows
? 'images/tray_icon.ico'
: 'images/tray_icon.png',
);
Menu menu = Menu(
items: [
MenuItem(
key: 'show_window',
label: 'Show Window',
),
MenuItem.separator(),
MenuItem(
key: 'exit_app',
label: 'Exit App',
),
],
);
await trayManager.setContextMenu(menu);
```
> 请看这个插件的示例应用，以了解完整的例子。
#### 监听事件
```dart
import 'package:flutter/material.dart';
import 'package:tray_manager/tray_manager.dart';
class HomePage extends StatefulWidget {
@override
_HomePageState createState() => _HomePageState();
}
class _HomePageState extends State with TrayListener {
@override
void initState() {
trayManager.addListener(this);
super.initState();
_init();
}
@override
void dispose() {
trayManager.removeListener(this);
super.dispose();
}
void _init() {
// ...
}
@override
Widget build(BuildContext context) {
// ...
}
@override
void onTrayIconMouseDown() {
// do something, for example pop up the menu
trayManager.popUpContextMenu();
}
@override
void onTrayIconRightMouseDown() {
// do something
}
@override
void onTrayIconRightMouseUp() {
// do something
}
@override
void onTrayMenuItemClick(MenuItem menuItem) {
if (menuItem.key == 'show_window') {
// do something
} else if (menuItem.key == 'exit_app') {
// do something
}
}
}
```
## 谁在用使用它？
- [Airclap](https://airclap.app/) - 任何文件，任意设备，随意发送。简单好用的跨平台高速文件传输 APP。
- [Biyi (比译)](https://biyidev.com/) - 一个便捷的翻译和词典应用程序。
## API
### TrayManager
| Method | Description | Linux | macOS | Windows |
| ---------------- | -------------------------------- | ----- | ----- | ------- |
| destroy | 立即销毁托盘图标 | ✔️ | ✔️ | ✔️ |
| setIcon | 设置与此托盘图标相关的图片。 | ✔️ | ✔️ | ✔️ |
| setIconPosition | 设置托盘图标的图标位置。 | ➖ | ✔️ | ➖ |
| setToolTip | 设置此托盘图标的悬停文本。 | ➖ | ✔️ | ✔️ |
| setContextMenu | 设置此图标的上下文菜单。 | ✔️ | ✔️ | ✔️ |
| popUpContextMenu | 弹出托盘图标的上下文菜单。 | ➖ | ✔️ | ✔️ |
| getBounds | 返回 `Rect` 这个托盘图标的边界。 | ➖ | ✔️ | ✔️ |
## 许可证
[MIT](./LICENSE)