-
-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b065bfd
commit d332ff6
Showing
2 changed files
with
172 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| # Table of contents | ||
|
|
||
| * [Page 1](README.md) | ||
| * [README](readme.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,171 @@ | ||
| # 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 | ||
|
|
||
| * Notifications | ||
| * [Context menus](broken-reference) | ||
| * ICommand support | ||
| * [Design-time access](broken-reference) | ||
| * [Efficiency Mode](broken-reference) | ||
| * [Dynamic icon generation](broken-reference) | ||
|
|
||
| #### NuGet | ||
|
|
||
| [](https://www.nuget.org/packages/H.NotifyIcon.Wpf/) [](https://www.nuget.org/packages/H.NotifyIcon.WinUI/) [](https://www.nuget.org/packages/H.NotifyIcon.Uno/) [](https://www.nuget.org/packages/H.NotifyIcon.Uno.WinUI/) | ||
|
|
||
| ```powershell | ||
| 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 | ||
|
|
||
| ```xml | ||
| <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  | ||
|
|
||
| Windows 11 introduces a new concept called [Efficiency Mode](https://devblogs.microsoft.com/performance-diagnostics/reduce-process-interference-with-task-manager-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: | ||
|
|
||
| ```cs | ||
| 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:  | ||
|
|
||
| ```xml | ||
| <tb:TaskbarIcon> | ||
| <tb:TaskbarIcon.IconSource> | ||
| <tb:GeneratedIconSource | ||
| Text="❤️" | ||
| Foreground="Red" | ||
| /> | ||
| </tb:TaskbarIcon.IconSource> | ||
| </tb:TaskbarIcon> | ||
| ``` | ||
|
|
||
| Example 2:  | ||
|
|
||
| ```xml | ||
| <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:  | ||
|
|
||
| ```xml | ||
| <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:  | ||
|
|
||
| ```xml | ||
| <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:\ | ||
|  | ||
|
|
||
| #### 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.  | ||
| 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"\ | ||
|  | ||
|
|
||
| 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](https://docs.microsoft.com/en-us/previous-versions/windows/internet-explorer/ie-developer/platform-apis/ms537359\(v=vs.85\)). Read more here: https://docs.microsoft.com/en-us/windows/win32/api/shellapi/ns-shellapi-notifyicondataa#troubleshooting | ||
|
|
||
| ### 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 |