Home

Awesome

system_tray

Pub

A Flutter package that enables support for system tray menu for desktop flutter apps. on Windows, macOS, and Linux.

Install

In the pubspec.yaml of your flutter project, add the following dependency:

dependencies:
  ...
  system_tray: ^2.0.3

In your library add the following import:

import 'package:system_tray/system_tray.dart';

Prerequisite

Linux

sudo apt-get install appindicator3-0.1 libappindicator3-dev

or

// For Ubuntu 22.04 or greater
sudo apt-get install libayatana-appindicator3-dev

Example App

Windows

<img src="https://raw.githubusercontent.com/antler119/system_tray/master/resources/screenshot_windows.png">

macOS

<img src="https://raw.githubusercontent.com/antler119/system_tray/master/resources/screenshot_macos.png">

Linux

<img src="https://raw.githubusercontent.com/antler119/system_tray/master/resources/screenshot_ubuntu.png">

API

<table> <tr> <th>Method</th> <th>Description</th> <th>Windows</th> <th>macOS</th> <th>Linux</th> </tr> <tr> <td>initSystemTray</td> <td>Initialize system tray</td> <td>✔️</td> <td>✔️</td> <td>✔️</td> </tr> <tr> <td>setSystemTrayInfo</td> <td>Modify the tray info</td> <td> <ul> <li>icon</li> <li>toolTip</li> </ul> </td> <td> <ul> <li>title</li> <li>icon</li> <li>toolTip</li> </ul> </td> <td> <ul> <li>icon</li> </ul> </td> </tr> <tr> <td>setImage</td> <td>Modify the tray image</td> <td>✔️</td> <td>✔️</td> <td>✔️</td> </tr> <tr> <td>setTooltip</td> <td>Modify the tray tooltip</td> <td>✔️</td> <td>✔️</td> <td>➖</td> </tr> <tr> <td>setTitle / getTitle</td> <td>Set / Get the tray title</td> <td>➖</td> <td>✔️</td> <td>➖</td> </tr> <tr> <td>setContextMenu</td> <td>Set the tray context menu</td> <td>✔️</td> <td>✔️</td> <td>✔️</td> </tr> <tr> <td>popUpContextMenu</td> <td>Popup the tray context menu</td> <td>✔️</td> <td>✔️</td> <td>➖</td> </tr> </tr> <tr> <td>destroy</td> <td>Destroy the tray</td> <td>✔️</td> <td>✔️</td> <td>✔️</td> </tr> <tr> <td>registerSystemTrayEventHandler</td> <td>Register system tray event</td> <td> <ul> <li>click</li> <li>right-click</li> <li>double-click</li> </ul> </td> <td> <ul> <li>click</li> <li>right-click</li> </ul> </td> <td>➖</td> </tr> </table>

Menu

<table> <tr> <th>Type</th> <th>Description</th> <th>Windows</th> <th>macOS</th> <th>Linux</th> </tr> <tr> <td>MenuItemLabel</td> <td></td> <td>✔️</td> <td>✔️</td> <td>✔️</td> </tr> <tr> <td>MenuItemCheckbox</td> <td></td> <td>✔️</td> <td>✔️</td> <td>✔️</td> </tr> <tr> <td>SubMenu</td> <td></td> <td>✔️</td> <td>✔️</td> <td>✔️</td> </tr> <tr> <td>MenuSeparator</td> <td></td> <td>✔️</td> <td>✔️</td> <td>✔️</td> </tr> </table>

Usage

Future<void> initSystemTray() async {
  String path =
      Platform.isWindows ? 'assets/app_icon.ico' : 'assets/app_icon.png';

  final AppWindow appWindow = AppWindow();
  final SystemTray systemTray = SystemTray();

  // We first init the systray menu
  await systemTray.initSystemTray(
    title: "system tray",
    iconPath: path,
  );

  // create context menu
  final Menu menu = Menu();
  await menu.buildFrom([
    MenuItemLabel(label: 'Show', onClicked: (menuItem) => appWindow.show()),
    MenuItemLabel(label: 'Hide', onClicked: (menuItem) => appWindow.hide()),
    MenuItemLabel(label: 'Exit', onClicked: (menuItem) => appWindow.close()),
  ]);

  // set context menu
  await systemTray.setContextMenu(menu);

  // handle system tray event
  systemTray.registerSystemTrayEventHandler((eventName) {
    debugPrint("eventName: $eventName");
    if (eventName == kSystemTrayEventClick) {
       Platform.isWindows ? appWindow.show() : systemTray.popUpContextMenu();
    } else if (eventName == kSystemTrayEventRightClick) {
       Platform.isWindows ? systemTray.popUpContextMenu() : appWindow.show();
    }
  });
}

Additional Resources

Recommended library that supports window control:

Q&A

  1. Q: If you encounter the following compilation error

    Undefined symbols for architecture x86_64:
  "___gxx_personality_v0", referenced from:
      ...

    A: add libc++.tbd

    1. open example/macos/Runner.xcodeproj
2. add 'libc++.tbd' to TARGET runner 'Link Binary With Libraries'