Drastic.Tray 1.0.9

Drastic.Tray

Drastic.Tray is a straightforward API for creating tray icons, designed for dotnet Mac Catalyst, macOS, and WinUI applications.

IMPORTANT

For this to work on Mac Catalyst, we are using Objective-C Selectors for directly accessing AppKit APIs from UIKit. These are private, and are frowd upon by Apple. You may have issues publishing apps using this library within the Mac App Store. While it should "work" it is best seen as experimental.

How To Use

Usage between macOS, Catalyst, and Windows is similar.

var menuItems = new List<TrayMenuItem>();
var trayImage = new TrayImage(NSImage.ImageNamed("TrayIcon.ico")!);
menuItems.Add(new TrayMenuItem("Hello!", trayImage, async () => { }, "h"));
menuItems.Add(new TrayMenuItem("From!", trayImage, async () => { }, "f"));
menuItems.Add(new TrayMenuItem("MacOS!", trayImage, async () => { }, "m", NSEventModifierMask.ControlKeyMask | NSEventModifierMask.CommandKeyMask));
var trayIcon = new Drastic.Tray.TrayIcon("Tray Icon", trayImage, menuItems);
trayIcon.LeftClicked += (object? sender, TrayClickedEventArgs e) => trayIcon.OpenMenu();
trayIcon.RightClicked += (object? sender, TrayClickedEventArgs e) => { };

Create a TrayImage. This requires either an NSImage or UIImage (Which gets turned back into an NSImage). If you wish, create a list of TrayMenuItem. These can then be invoked in the tray icon with trayIcon.OpenMenu().

When you create the TrayIcon, it should automatically appear in the Mac Tray.

After you create the icon, you can attach to LeftClicked and RightClicked to handle accessing the respected events on the button.

You can have as many TrayIcon's as allowed by the system. However, you should probably limit yourself to one, unless you hate your users. But hey, you do you, mythical developer.

IMPORTANT WINUI NOTE

If you use the default TrayMenuItem lists and add them to the TrayIcon, they will always open with the right mouse button. This is the default for the underlying WinForms control. If you wish to open it yourself or use it on Left Click, you should handle the menu creation yourself and use the LeftClicked or RightClicked event.