https://github.com/jack251970/winui3-template
A template for WinUI 3, with support of tray icon, multi-thread window, splash screen, etc.
https://github.com/jack251970/winui3-template
csharp template template-project templates templating wasdk windowsappsdk winui3
Last synced: about 1 month ago
JSON representation
A template for WinUI 3, with support of tray icon, multi-thread window, splash screen, etc.
- Host: GitHub
- URL: https://github.com/jack251970/winui3-template
- Owner: Jack251970
- License: mit
- Created: 2024-10-24T11:01:21.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2025-01-31T14:26:24.000Z (4 months ago)
- Last Synced: 2025-03-29T20:23:05.755Z (about 2 months ago)
- Topics: csharp, template, template-project, templates, templating, wasdk, windowsappsdk, winui3
- Language: C#
- Homepage:
- Size: 836 KB
- Stars: 7
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WinUI3 Template
**A template for WinUI 3, with support of tray icon, multi-thread window, splash screen, etc.**
## ⭐ Features
### 1. Package / Unpackaged Mode
### 2. Navigation View
### 3. Setting Page
1. Language
2. Startup
1. Startup Entry
2. Logon Task
3. Theme
4. Backdrop
### 4. Tray Icon
### 5. Window Creation
### 6. Multi-thread Window
### 7. Custom Program
### 8. Single Instance
### 9. Splash Screen
### 10. Serilog Logging
## 🖼️ Screenshots
## 🚀 Getting Started
### 1. Replace in files
* replace `WinUI3Template` with your own root namespace.
* replace `WinUI3 Template` with your own app name.
* replace `A template for WinUI 3.` with your own description.
* replace `AuthorName` with your own name.
* replace `Settings_Repository_NavigateUri` with your own repository.
* replace `Settings_LicenseLink_NavigateUri` with your own license link.
* replace `8f256a41-5ee3-4218-97c6-12e1f8d5c234` with your own GUID (PhoneProductId).
* replace `445ab065-101e-45ff-80ab-45efcdf5dae5` with your own GUID (ToastActivatorCLSID).
> [!TIP]
> You can use `VSCode` to execute replace. Use Ctrl + Shift + S.
### 2. Rename file names
* rename `WinUI3Template` with your own project root name.
> [!TIP]
> You can use `PowerRename` module in `PowerToys` to execute replace.
### 3. Custom project settings in the core project `csproj` file
* Custom program: `DISABLE_XAML_GENERATED_MAIN;$(DefineConstants)`
* Single instance: `SINGLE_INSTANCE;$(DefineConstants)`
* Tray icon: `TRAY_ICON;$(DefineConstants)`
* Splash screen: `SPLASH_SCREEN;$(DefineConstants)`
> [!TIP]
> If you don not need some features, you can remove the corresponding define constants.
### 4. Implement TODOs
* Initialize others things in `async Task ActivateAsync()` of `App.xaml.cs`.
* Add the languages supported by the unpackaged app in `public static void Initialize()` of `AppLanguageHelper.cs`.
### 5. Add a new window
* Refer to `WindowsExtensions.cs` for more information.
### 6. Building
* Select the package / unpackaged mode.
* Build the solution in Visual Studio or run `dotnet build` from the command line.
## 📚 Reference
* Files: https://github.com/files-community/Files
* fluentui-system-icons: https://github.com/microsoft/fluentui-system-icons
* H.NotifyIcon: https://github.com/HavenDV/H.NotifyIcon
* ICONS8: https://icons8.com/icons
* Newtonsoft.Json: https://github.com/JamesNK/Newtonsoft.Json
* Template Studio for WinUI (C#): https://github.com/microsoft/TemplateStudio
* terminal: https://github.com/microsoft/terminal
* WinUI3Windows: https://github.com/smourier/WinUI3Windows
* WinUI3-Template: https://github.com/Jack251970/WinUI3-Template
* Windows Community Toolkit: https://github.com/CommunityToolkit/WindowsCommunityToolkit
* WinUIEx: https://github.com/dotMorten/WinUIEx
## 📄 License
[MIT License](LICENSE)