InfiniFrame.Tray 0.1.0

InfiniFrame.Tray

System tray (Windows) and menu bar (macOS) icons for InfiniFrame windows. Use it to send an InfiniFrame app to the tray: close or minimize to the tray, start hidden, click the icon to bring the window back, plus a tray menu.

InfiniFrame itself has no tray support. Its Taskbar feature only does taskbar progress and flashing. This library adds the tray icon and builds on InfiniFrame's window events.

Targets net8.0, net9.0 and net10.0 (same as InfiniFrame). It is AOT/trim compatible: all interop is LibraryImport / function pointers. Depends on InfiniLore.InfiniFrame 0.62.1.

Quick start

using InfiniFrame;
using InfiniFrame.Tray;

[STAThread]
static void Main()
{
    using var tray = new TrayIcon("My App", TrayIconImage.FromFile("tray.ico"));

    tray.Menu = new TrayMenu
    {
        { "Open", tray.ShowWindow },
        TrayMenuItem.Separator(),
        { "Quit", tray.ExitApplication },
    };

    var window = InfiniFrameWindowBuilder.Create()
        .SetTitle("My App")
        .SetStartPageUrl("https://example.com")
        .UseTray(tray, o =>
        {
            o.CloseToTray = true;     // X hides the window (default)
            o.MinimizeToTray = true;  // minimize hides it too
            o.StartHidden = false;    // true = start in the tray
        })
        .Build();

    window.WaitForClose(); // returns after "Quit"
}

See samples/InfiniFrame.Tray.Sample for checkable items, submenus and updating the menu just before it opens.

API

TrayIcon

TrayMenu / TrayMenuItem

TrayMenuItem has Text, Enabled, Checked, Visible, Submenu and a Clicked event. Hidden items are left out, and the separators that would be left over are dropped too. An & in the text shows literally on both platforms. TrayMenu is thread-safe and works with collection initializers ({ "Text", action }).

TrayIconImage

UseTray(tray, options) and TrayWindowOptions

UseTray works on an IInfiniFrameWindowBuilder, or on an IInfiniFrameWindow that is already built. A tray icon can be attached to one window.

Threading

• Every member can be called from any thread. Changes are applied in order on the tray's UI thread.
• Events and menu Clicked handlers run on the tray's UI thread:
  • Windows: a dedicated background thread with its own message loop. This keeps the icon independent of the InfiniFrame window thread, so it can exist before the window does and after it closes.
  • macOS: the main thread (through the main dispatch queue).
• A handler that throws is logged through the ILogger you passed in. Handlers run inside native callbacks, where an unhandled exception would terminate the process.
• On macOS the icon appears once the main run loop runs, which is when WaitForClose() starts.

Caveats

• Start hidden can flash. InfiniFrame shows a window while it creates it, so with StartHidden the window may be visible for a moment before it is hidden.
• Shutting down. With CloseToTray, InfiniFrame's own close requests are also turned into "hide". Exit with tray.ExitApplication(), or dispose the tray first.
• macOS has not been run on real hardware yet. The backend compiles, and the Windows behaviour it mirrors is tested, but the AppKit interop has not been run on a Mac. Test the sample on a Mac before relying on it.
• Windows balloon notifications are not included. Use InfiniFrame's Notifications feature (window.Features.Notifications.ShowNotification), which works on every platform.

Development

dotnet build InfiniFrameTray.slnx
dotnet test --project tests/InfiniFrame.Tray.Tests      # runs anywhere (Linux uses the no-op backend)
dotnet run --project samples/InfiniFrame.Tray.Sample    # Windows or macOS
dotnet pack src/InfiniFrame.Tray -c Release