H.NotifyIcon.WinUI 2.0.52

There is a newer version of this package available.
See the version list below for details.
dotnet add package H.NotifyIcon.WinUI --version 2.0.52
NuGet\Install-Package H.NotifyIcon.WinUI -Version 2.0.52
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="H.NotifyIcon.WinUI" Version="2.0.52" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add H.NotifyIcon.WinUI --version 2.0.52
#r "nuget: H.NotifyIcon.WinUI, 2.0.52"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install H.NotifyIcon.WinUI as a Cake Addin
#addin nuget:?package=H.NotifyIcon.WinUI&version=2.0.52

// Install H.NotifyIcon.WinUI as a Cake Tool
#tool nuget:?package=H.NotifyIcon.WinUI&version=2.0.52

H.NotifyIcon

** This project is a continuation of the inactive base project to other platforms (WinUI/Uno.Skia.Wpf/Console) - ❤️ https://github.com/hardcodet/wpf-notifyicon ❤️ **

This is an implementation of a NotifyIcon (aka system tray icon or taskbar icon) for .Net Core 3.1/.Net 5/.Net 6 WPF/WinUI/Uno.Skia.WPF/Console platforms. It does not just rely on the Windows Forms NotifyIcon component, but is a purely independent control which leverages several features of the WPF/WinUI framework in order to display rich tooltips, popups, context menus, and balloon messages. It can be used directly in code or embedded in any XAML file.

Features

Nuget

Nuget Nuget Nuget Nuget

Install-Package H.NotifyIcon.Wpf
Install-Package H.NotifyIcon.WinUI
Install-Package H.NotifyIcon.Uno
Install-Package H.NotifyIcon.Uno.WinUI
// If you need other platforms, you can use this Core library - 
// it allows you to make NotifyIcon even in a console application.
Install-Package H.NotifyIcon

Usage

<Window
    xmlns:tb="http://www.hardcodet.net/taskbar" // WPF
    xmlns:tb="using:H.NotifyIcon" // WinUI
    >
    <tb:TaskbarIcon
        ToolTipText="ToolTip"
        IconSource="/Images/TrayIcons/Logo.ico"
        ContextMenu="{StaticResource TrayMenu}"
        MenuActivation="LeftOrRightClick"
        TrayPopup="{StaticResoure TrayStatusPopup}"
        PopupActivation="DoubleClick"
        TrayToolTip="{StaticResource TrayToolTip}"
        />
</Window>

Efficiency Mode image

Windows 11 introduces a new concept called Efficiency Mode.
Since, basically, this library is intended for applications to exist in the background with the ability to interact through TrayIcon, the library implements an API for this mode:

EfficiencyModeUtilities.SetEfficiencyMode(bool value)
WindowExtensions.Hide(this Window window, enableEfficiencyMode: true) // default value
WindowExtensions.Show(this Window window, disableEfficiencyMode: true) // default value
TaskbarIcon.ForceCreate(bool enablesEfficiencyMode = true) // default value

Generated icons

Example 1: <img width="15" alt="image" src="https://user-images.githubusercontent.com/3002068/163721411-1388f2b4-a039-4b4a-8114-f74bfc8835ba.png">

<tb:TaskbarIcon GeneratedIconText="❤️" GeneratedIconForeground="Red">

Example 2: <img width="14" alt="image" src="https://user-images.githubusercontent.com/3002068/163721399-cbfd0286-d2d4-4b40-b3f3-388c9613f535.png">

<tb:TaskbarIcon
    IconSource="/Icons/Error.ico"
    GeneratedIconText="5"
    GeneratedIconForeground="Black"
    GeneratedIconFontSize="36"
    GeneratedIconFontWeight="Bold"
    >

Example 3: <img width="19" alt="image" src="https://user-images.githubusercontent.com/3002068/163721367-dc6878df-3ec2-4288-b699-cf664894e1b1.png">

<tb:TaskbarIcon
    GeneratedIconText="❤️"
    GeneratedIconForeground="Red"
    GeneratedIconFontFamily="Segoe UI Emoji"
    GeneratedIconBackground="AliceBlue"
    GeneratedIconFontWeight="Bold"
    GeneratedIconFontSize="38"
    >

Example 4: <img width="18" alt="image" src="https://user-images.githubusercontent.com/3002068/163723782-8b135584-8b35-401e-926e-0fe0e7aa801e.png">

<tb:TaskbarIcon
    GeneratedIconText="❤️"
    GeneratedIconBorderThickness="5"
    GeneratedIconFontSize="46"
    >
    <tb:TaskbarIcon.GeneratedIconForeground>
        <LinearGradientBrush StartPoint="0,0" EndPoint="128,128">
            <GradientStop Color="White" />
            <GradientStop Color="Red" />
        </LinearGradientBrush>
    </tb:TaskbarIcon.GeneratedIconForeground>
    <tb:TaskbarIcon.GeneratedIconBorderBrush>
        <LinearGradientBrush StartPoint="0,0" EndPoint="128,128">
            <GradientStop Color="White" />
            <GradientStop Color="Red" />
        </LinearGradientBrush>
    </tb:TaskbarIcon.GeneratedIconBorderBrush>

Design-Time Access

It is recommended to pin the designer icon for easy viewing. To do this, go to Taskbar Settings → Other system tray icons and enable this icon:
<img width="412" alt="image" src="https://user-images.githubusercontent.com/3002068/163700588-eb2ad5f2-45d0-4b6f-ad39-c66f96202cb5.png">

WinUI Context menu

At the moment, three modes are implemented, each with its own pros and cons.

  1. Based on your MenuFlyout, a Win32 PopupMenu will be created that will call the commands attached to your MenuFlyoutItem. This is the default. <img width="174" alt="image" src="https://user-images.githubusercontent.com/3002068/164977047-e8497047-0c6d-4f99-b160-bc1c1a1a6c3f.png">
  2. The menu will be created in your open window, in the corner of the screen.
  3. A second transparent window will be created and used to render the native menu.. At the moment it is in the preview stage. To do this you need to explicitly set ContextMenuMode="SecondWindow"
    image

Availability of various options(depends on the version of WindowsAppSDK you are using): Option | Packaged App | Unpackaged App -------------|------------------------------|----------------------------------- Transparency | 🟢 from 1.1.0-preview | 🟢 from 1.1.0-preview Borderless | 🔷 | 🟢 from 1.1.0-preview Animations | 🟢, but with borders | 🟢 from 1.1.0-preview Submenus | 🔷 | 🔷

Behavior that needs attention

  1. This implementation currently uses the Guid associated with each TrayIcon. The default is a hash function that creates a unique Guid based on the path to your file, because Windows associates the guid with the current path when TrayIcon is registered. The only way to keep the settings when changing the file path is to use Authenticode. Read more here: https://docs.microsoft.com/en-us/windows/win32/api/shellapi/ns-shellapi-notifyicondataa#troubleshooting

Sample Apps

The minimum supported version of the .Net Framework is 4.5.1.
So in some cases to build the project you will need to install this -
https://dotnet.microsoft.com/en-us/download/dotnet-framework/thank-you/net451-developer-pack-offline-installer

Support

You can get answers to your questions in my discord support channel:
https://discord.gg/g8u2t9dKgE

Product Compatible and additional computed target framework versions.
.NET net5.0-windows10.0.17763 is compatible.  net6.0-windows was computed.  net6.0-windows10.0.17763 is compatible.  net7.0-windows was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (13)

Showing the top 5 popular GitHub repositories that depend on H.NotifyIcon.WinUI:

Repository Stars
Richasy/Bili.Uwp
适用于新系统UI的哔哩
Scighost/Starward
Game Launcher for miHoYo - 米家游戏启动器
Richasy/Bili.Copilot
哔哩哔哩用户的个人助理
CollapseLauncher/Collapse
An Advanced Launcher for miHoYo Games
NickvisionApps/Parabolic
Download web video and audio
Version Downloads Last updated
2.0.131 423 5/1/2024
2.0.129 154 4/26/2024
2.0.128 97 4/25/2024
2.0.124 5,386 1/3/2024
2.0.123 2,227 12/2/2023
2.0.122 133 11/30/2023
2.0.118 3,192 9/20/2023
2.0.117 283 9/13/2023
2.0.116 289 9/7/2023
2.0.115 3,197 8/2/2023
2.0.114 265 8/1/2023
2.0.113 167 8/1/2023
2.0.112 240 7/26/2023
2.0.111 179 7/26/2023
2.0.110 227 7/26/2023
2.0.108 2,980 4/5/2023
2.0.106 225 4/5/2023
2.0.105 280 4/1/2023
2.0.104 270 3/28/2023
2.0.103 253 3/28/2023
2.0.99 954 3/13/2023
2.0.98 227 3/13/2023
2.0.97 281 3/13/2023
2.0.95 245 3/12/2023
2.0.94 302 3/9/2023
2.0.93 416 3/5/2023
2.0.86 533 2/3/2023
2.0.84 292 2/2/2023
2.0.77 991 1/12/2023
2.0.76 393 1/10/2023
2.0.75 385 1/5/2023
2.0.74 2,485 11/8/2022
2.0.73 681 10/13/2022
2.0.72 421 10/13/2022
2.0.68 460 10/4/2022
2.0.67 625 9/22/2022
2.0.66 441 9/16/2022
2.0.64 607 8/23/2022
2.0.63 479 8/17/2022
2.0.60 509 8/10/2022
2.0.59 564 8/1/2022
2.0.58 452 7/26/2022
2.0.57 472 7/21/2022
2.0.56 491 7/17/2022
2.0.55 450 7/15/2022
2.0.54 456 7/15/2022
2.0.53 1,130 6/24/2022
2.0.52 465 6/24/2022
2.0.51 439 6/23/2022
2.0.50 763 5/24/2022
2.0.49 454 5/24/2022
2.0.48 663 4/27/2022
2.0.46 493 4/24/2022
2.0.45 445 4/24/2022
2.0.44 482 4/22/2022
2.0.43 440 4/22/2022
2.0.41 472 4/22/2022
2.0.39 471 4/19/2022
2.0.38 442 4/19/2022
2.0.37 446 4/17/2022
2.0.36 436 4/17/2022
2.0.35 436 4/17/2022
2.0.34 470 4/17/2022
2.0.33 462 4/17/2022
2.0.31 453 4/16/2022
2.0.30 479 4/15/2022
2.0.29 458 4/10/2022
2.0.28 455 4/10/2022
2.0.27 453 4/10/2022
2.0.26 449 4/10/2022
2.0.25 471 4/8/2022
2.0.24 446 4/4/2022
2.0.23 461 4/3/2022
2.0.22 452 4/2/2022
2.0.21 442 4/2/2022
2.0.20 426 4/2/2022
2.0.19 439 4/2/2022
2.0.18 443 4/2/2022
2.0.17 468 4/1/2022
1.1.12 482 3/27/2022
1.1.11 449 3/26/2022
1.1.10 457 3/24/2022
1.1.9 493 2/25/2022
1.1.8 440 2/25/2022
1.1.7 435 2/25/2022
1.1.6 447 2/25/2022
1.1.5 472 2/25/2022

⭐ Last 10 features:
- feat: To DependencyPropertyGenerator. 2022-06-23
- feat: Added pickup right icon size from icon stream. 2022-05-24
- feat: Added PopupPlacement/PopupOffset properties. 2022-05-24
- feat(WinUI): Fixed context menu position. 2022-04-27
- feat: Removed win32 GetCursorPos() calls. 2022-04-27
- feat: Added ShowNotification customIcon size check. Closes #11. 2022-04-24
- feat(Core): TrayIcon will create a MessageWindow automatically if WindowHandle is not set. 2022-04-24
- feat(Core): Added TrayInfo.IsShellOpen() method. 2022-04-24
- feat(Core): Added IsPackaged check. 2022-04-23
- feat(WinUI): Added context menu animation support for unpackaged apps V1.1. 2022-04-23

🐞 Last 10 bug fixes:
- fix: Fixed bug with GeneratedIconBorderThickness. 2022-06-24
- fix: Fixed MessageWindow.TaskbarCreated event. 2022-05-24
- fix: Fixed Uno build. 2022-04-27
- fix: Fixed some TryCreate exceptions. 2022-04-24
- fix(WinUI): Fixed ContextMenu double right click animation bug. 2022-04-23
- fix: Fixed Uno build. 2022-04-23
- fix: Fixed issues with Efficiency Mode. 2022-04-22
- fix(WinUI): Fixed missing H.NotifyIcon.PopupMenus. 2022-04-19
- fix(WinUI): Fixed GeneratedIcon default font style. 2022-04-18
- fix: Fixed bug with auto-centering generated text. 2022-04-17