H.NotifyIcon.WinUI 2.0.131

dotnet add package H.NotifyIcon.WinUI --version 2.0.131
NuGet\Install-Package H.NotifyIcon.WinUI -Version 2.0.131
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.131" />
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.131
#r "nuget: H.NotifyIcon.WinUI, 2.0.131"
#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.131

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

README

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 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 frameworks 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="clr-namespace:H.NotifyIcon;assembly=H.NotifyIcon.Wpf" // WPF
    xmlns:tb="using:H.NotifyIcon" // WinUI
    >
    <tb:TaskbarIcon
        ToolTipText="ToolTip"
        IconSource="/Images/TrayIcons/Logo.ico"
        ContextMenu="{StaticResource TrayMenu}"
        MenuActivation="LeftOrRightClick"
        TrayPopup="{StaticResource 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: image

<tb:TaskbarIcon>
    <tb:TaskbarIcon.IconSource>
        <tb:GeneratedIconSource
            Text="❤️"
            Foreground="Red"
            />
    </tb:TaskbarIcon.IconSource>
</tb:TaskbarIcon>

Example 2: image

<tb:TaskbarIcon
    IconSource="/Icons/Error.ico"
    >
    <tb:TaskbarIcon.IconSource>
        <tb:GeneratedIconSource
            Text="5"
            Foreground="Black"
            FontSize="36"
            FontWeight="Bold"
            />
    </tb:TaskbarIcon.IconSource>
</tb:TaskbarIcon>

Example 3: image

<tb:TaskbarIcon>
    <tb:TaskbarIcon.IconSource>
        <tb:GeneratedIconSource
            Text="❤️"
            Foreground="Red"
            FontFamily="Segoe UI Emoji"
            Background="AliceBlue"
            FontWeight="Bold"
            FontSize="38"
            />
    </tb:TaskbarIcon.IconSource>
</tb:TaskbarIcon>

Example 4: image

<tb:TaskbarIcon>
    <tb:TaskbarIcon.IconSource>
        <tb:GeneratedIconSource
            Text="❤️"
            BorderThickness="5"
            FontSize="46"
            >
            <tb:GeneratedIconSource.Foreground>
                <LinearGradientBrush StartPoint="0,0" EndPoint="128,128">
                    <GradientStop Color="White" />
                    <GradientStop Color="Red" />
                </LinearGradientBrush>
            </tb:GeneratedIconSource.Foreground>
            <tb:GeneratedIconSource.BorderBrush>
                <LinearGradientBrush StartPoint="0,0" EndPoint="128,128">
                    <GradientStop Color="White" />
                    <GradientStop Color="Red" />
                </LinearGradientBrush>
            </tb:GeneratedIconSource.BorderBrush>
        </tb:GeneratedIconSource>
    </tb:TaskbarIcon.IconSource>
</tb:TaskbarIcon>
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:
image

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. image
  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

Support

Priority place for bugs: https://github.com/HavenDV/H.NotifyIcon/issues\ Priority place for ideas and general questions: https://github.com/HavenDV/H.NotifyIcon/discussions\ I also have a Discord support channel:
https://discord.gg/g8u2t9dKgE

Product Compatible and additional computed target framework versions.
.NET net6.0-windows10.0.17763 is compatible.  net7.0-windows was computed.  net7.0-windows10.0.17763 is compatible.  net8.0-windows was computed.  net8.0-windows10.0.17763 is compatible. 
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 (14)

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

Repository Stars
marticliment/WingetUI
WingetUI: The Graphical Interface for your package managers
Richasy/Bili.Uwp
适用于新系统UI的哔哩
Scighost/Starward
Game Launcher for miHoYo - 米家游戏启动器
Richasy/Bili.Copilot
哔哩哔哩用户的个人助理
CollapseLauncher/Collapse
An Advanced Launcher for miHoYo Games
Version Downloads Last updated
2.0.131 1,366 5/1/2024
2.0.129 167 4/26/2024
2.0.128 102 4/25/2024
2.0.124 5,837 1/3/2024
2.0.123 2,320 12/2/2023
2.0.122 133 11/30/2023
2.0.118 3,331 9/20/2023
2.0.117 283 9/13/2023
2.0.116 291 9/7/2023
2.0.115 3,214 8/2/2023
2.0.114 267 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 3,079 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 956 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 303 3/9/2023
2.0.93 416 3/5/2023
2.0.86 540 2/3/2023
2.0.84 294 2/2/2023
2.0.77 991 1/12/2023
2.0.76 395 1/10/2023
2.0.75 385 1/5/2023
2.0.74 2,490 11/8/2022
2.0.73 683 10/13/2022
2.0.72 423 10/13/2022
2.0.68 460 10/4/2022
2.0.67 627 9/22/2022
2.0.66 441 9/16/2022
2.0.64 607 8/23/2022
2.0.63 480 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,214 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 481 4/15/2022
2.0.29 458 4/10/2022
2.0.28 455 4/10/2022
2.0.27 454 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 483 3/27/2022
1.1.11 449 3/26/2022
1.1.10 457 3/24/2022
1.1.9 495 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: TaskbarIcon.ShowContextMenu is public now. 2024-05-02
- feat: Support Right-to-Left layout for PopupMenu and SecondWindow (#152) 2024-04-27
- feat: Updated to net8. 2023-11-13
- feat: Added auto-disposing for MAUI. 2023-09-21
- feat: Added MAUI WinUI Window.Activate() extension. #108. 2023-09-14
- feat: Added MessageWindow.InitMenuPopup event for #105. 2023-09-07
- feat: Added Window ShowInTaskbar and HideInTaskbar extensions. 2023-08-03
- feat: Reworked tooltips. 2023-08-01
- feat: Added ContextFlyout support for MAUI. 2023-07-27
- feat: Updated CsWin32. 2023-07-26
🐞 Last 10 bug fixes:
- fix: Try to fix CI. 2024-05-02
- fix: Fixed MAUI build. 2024-04-26
- fix: Fixed MAUI. 2024-04-25
- fix: Make SecondWindows fully transparent (#151) 2024-04-25
- fix: Removed UpdateIcon failed exception. 2024-01-03
- fix: Return net6/net7 support. 2023-12-02
- fix: Fixed warnings. 2023-11-30
- fix: Fixed WinUI. 2023-11-30
- fix: Added UseRidGraph to WinUI. 2023-11-13
- fix: Fixed issues with WindowExtensions.Show(). 2023-09-21