H.NotifyIcon.Maui 2.0.131

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package H.NotifyIcon.Maui --version 2.0.131                

                    
                

            
NuGet\Install-Package H.NotifyIcon.Maui -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.Maui" 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.Maui --version 2.0.131                

                    
                

            
#r "nuget: H.NotifyIcon.Maui, 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.Maui as a Cake Addin
#addin nuget:?package=H.NotifyIcon.Maui&version=2.0.131

// Install H.NotifyIcon.Maui as a Cake Tool
#tool nuget:?package=H.NotifyIcon.Maui&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 net8.0 is compatible.  net8.0-android was computed.  net8.0-android34.0 is compatible.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-ios17.2 is compatible.  net8.0-maccatalyst was computed.  net8.0-maccatalyst17.2 is compatible.  net8.0-macos was computed.  net8.0-tizen8.0 is compatible.  net8.0-tvos was computed.  net8.0-windows was computed.  net8.0-windows10.0.19041 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

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.2.0 161 12/6/2024
2.1.4 605 10/22/2024
2.1.3 371 8/18/2024
2.1.2 123 8/15/2024
2.1.0 235 7/10/2024
2.0.131 640 5/1/2024
2.0.129 167 4/26/2024
2.0.128 132 4/25/2024
2.0.124 3,259 1/3/2024
2.0.123 209 12/2/2023
2.0.122 136 11/30/2023
2.0.118 1,921 9/20/2023
2.0.117 234 9/13/2023
2.0.116 176 9/7/2023
2.0.115 472 8/2/2023
2.0.114 170 8/1/2023
2.0.113 157 8/1/2023
2.0.112 176 7/26/2023
2.0.111 170 7/26/2023
2.0.110 186 7/26/2023
0.0.0-dev 108 8/15/2024

⭐ 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