H.NotifyIcon.Uno
2.0.56
See the version list below for details.
dotnet add package H.NotifyIcon.Uno --version 2.0.56
NuGet\Install-Package H.NotifyIcon.Uno -Version 2.0.56
<PackageReference Include="H.NotifyIcon.Uno" Version="2.0.56" />
paket add H.NotifyIcon.Uno --version 2.0.56
#r "nuget: H.NotifyIcon.Uno, 2.0.56"
// Install H.NotifyIcon.Uno as a Cake Addin #addin nuget:?package=H.NotifyIcon.Uno&version=2.0.56 // Install H.NotifyIcon.Uno as a Cake Tool #tool nuget:?package=H.NotifyIcon.Uno&version=2.0.56
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
- Notifications
- Context menus
- ICommand support
- Design-time access
- Efficiency Mode
- Dynamic icon generation
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](https://user-images.githubusercontent.com/3002068/164691691-5baf5210-5b5e-417e-99d3-d0f19006d997.png)
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.
- 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">
- The menu will be created in your open window, in the corner of the screen.
- 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"
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
- 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 | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- DependencyPropertyGenerator.Core (>= 0.42.0)
- H.NotifyIcon (>= 2.0.56)
- H.NotifyIcon.PopupMenus (>= 2.0.56)
- Uno.UI (>= 4.4.13)
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.1.3 | 89 | 8/18/2024 |
2.1.2 | 62 | 8/15/2024 |
2.1.0 | 81 | 7/10/2024 |
2.0.131 | 96 | 5/1/2024 |
2.0.129 | 97 | 4/26/2024 |
2.0.128 | 90 | 4/25/2024 |
2.0.124 | 208 | 1/3/2024 |
2.0.123 | 168 | 12/2/2023 |
2.0.122 | 105 | 11/30/2023 |
2.0.118 | 154 | 9/20/2023 |
2.0.117 | 123 | 9/13/2023 |
2.0.116 | 171 | 9/7/2023 |
2.0.115 | 229 | 8/2/2023 |
2.0.114 | 190 | 8/1/2023 |
2.0.113 | 171 | 8/1/2023 |
2.0.112 | 178 | 7/26/2023 |
2.0.111 | 167 | 7/26/2023 |
2.0.110 | 162 | 7/26/2023 |
2.0.108 | 280 | 4/5/2023 |
2.0.106 | 229 | 4/5/2023 |
2.0.105 | 263 | 4/1/2023 |
2.0.104 | 234 | 3/28/2023 |
2.0.103 | 246 | 3/28/2023 |
2.0.99 | 272 | 3/13/2023 |
2.0.98 | 264 | 3/13/2023 |
2.0.97 | 271 | 3/13/2023 |
2.0.95 | 232 | 3/12/2023 |
2.0.94 | 269 | 3/9/2023 |
2.0.93 | 280 | 3/5/2023 |
2.0.86 | 268 | 2/3/2023 |
2.0.84 | 261 | 2/2/2023 |
2.0.77 | 327 | 1/12/2023 |
2.0.76 | 304 | 1/10/2023 |
2.0.75 | 331 | 1/5/2023 |
2.0.74 | 389 | 11/8/2022 |
2.0.73 | 429 | 10/13/2022 |
2.0.72 | 447 | 10/13/2022 |
2.0.68 | 423 | 10/4/2022 |
2.0.67 | 488 | 9/22/2022 |
2.0.66 | 478 | 9/16/2022 |
2.0.64 | 451 | 8/23/2022 |
2.0.63 | 471 | 8/17/2022 |
2.0.60 | 476 | 8/10/2022 |
2.0.59 | 499 | 8/1/2022 |
2.0.58 | 509 | 7/26/2022 |
2.0.57 | 514 | 7/21/2022 |
2.0.56 | 520 | 7/17/2022 |
2.0.55 | 508 | 7/15/2022 |
2.0.54 | 511 | 7/15/2022 |
2.0.53 | 512 | 6/24/2022 |
2.0.52 | 523 | 6/24/2022 |
2.0.51 | 538 | 6/23/2022 |
2.0.50 | 521 | 5/24/2022 |
2.0.49 | 470 | 5/24/2022 |
2.0.48 | 594 | 4/27/2022 |
2.0.46 | 515 | 4/24/2022 |
2.0.45 | 528 | 4/24/2022 |
2.0.44 | 511 | 4/22/2022 |
2.0.43 | 534 | 4/22/2022 |
2.0.41 | 527 | 4/22/2022 |
2.0.39 | 544 | 4/19/2022 |
2.0.38 | 550 | 4/19/2022 |
2.0.37 | 525 | 4/17/2022 |
2.0.36 | 540 | 4/17/2022 |
2.0.35 | 483 | 4/17/2022 |
2.0.34 | 505 | 4/17/2022 |
2.0.33 | 545 | 4/17/2022 |
2.0.31 | 521 | 4/16/2022 |
2.0.30 | 532 | 4/15/2022 |
2.0.29 | 556 | 4/10/2022 |
2.0.28 | 586 | 4/10/2022 |
2.0.27 | 565 | 4/10/2022 |
2.0.26 | 539 | 4/10/2022 |
2.0.25 | 505 | 4/8/2022 |
2.0.24 | 541 | 4/4/2022 |
2.0.23 | 551 | 4/3/2022 |
2.0.22 | 511 | 4/2/2022 |
2.0.21 | 497 | 4/2/2022 |
2.0.20 | 504 | 4/2/2022 |
2.0.19 | 539 | 4/2/2022 |
2.0.18 | 479 | 4/2/2022 |
2.0.17 | 516 | 4/1/2022 |
0.0.0-dev | 60 | 8/15/2024 |
⭐ Last 10 features:
- feat: Added routed events for WinUI/Uno platforms. 2022-07-17
- feat: Moved GeneratedIcon properties to separated class. 2022-07-15
- feat: Fixed ContextMenuMode.SecondWindow window size calculation. 2022-07-15
- 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
🐞 Last 10 bug fixes:
- fix: Updated to use latest DependencyPropertyGenerator. 2022-07-15
- fix: Converted read-only dependency properties. 2022-06-24
- 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