Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/egvijayanand/winui-templates

WinUI 3 CLI Templates
https://github.com/egvijayanand/winui-templates

cli client desktop library msix template windows windows-app-sdk winui winui3

Last synced: 3 months ago
JSON representation

WinUI 3 CLI Templates

Host: GitHub
URL: https://github.com/egvijayanand/winui-templates
Owner: egvijayanand
License: mit
Created: 2022-11-14T18:18:06.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-09-17T09:52:02.000Z (5 months ago)
Last Synced: 2024-09-17T12:18:18.245Z (5 months ago)
Topics: cli, client, desktop, library, msix, template, windows, windows-app-sdk, winui, winui3
Language: C#
Homepage: https://egvijayanand.in/
Size: 1.06 MB
Stars: 13
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

### CLI Project and Item Templates for developing WinUI 3 based Windows Desktop Apps

Join me on [**Developer Thoughts**](https://egvijayanand.in/ "Developer Thoughts"), an exclusive blog for .NET MAUI and Blazor.

#### Package Status:

#### Install Package:

To install the template NuGet package, use the below .NET CLI command:

Latest stable version:

```shell
dotnet new install VijayAnand.WinUITemplates
```

If you've already installed this package, then it can be updated to the latest version with the below command:

```shell
dotnet new update --check-only
```

```shell
dotnet new update
```

#### Templates Included

All three project templates takes the target framework as an input parameter, can be specified with `--framework` / `-f`.

And the supported values are:

* net6.0
* net7.0
* net8.0 *(the default value)*
* net9.0

Note: The default value for the framework parameter remains as `net8.0` (the latest stable channel), which means to create a project for .NET 9 (the preview channel), an explicit value of `net9.0` is to be passed.

All three project templates take the below optional parameter to include the officially supported [CommunityToolkit.Mvvm](https://www.nuget.org/packages/CommunityToolkit.Mvvm) NuGet package.

* `-imt` | `--include-mvvm-toolkit` - Default value is `false`

Both the **App** project takes another optional parameter thus allowing it to be created as MVVM supported solution using the same Microsoft MVVM Toolkit.

* `-mvvm` | `--use-mvvm` - Default value is `false`

Starting with [v3.1.0](https://www.nuget.org/packages/VijayAnand.WinUITemplates/3.1.0), all three project templates take the below optional parameter support NuGet's Central Package Management (CPM) feature.

* `-cpm` | `--central-pkg-mgmt` - Default value is `false`

Starting with [v3.3.0](https://www.nuget.org/packages/VijayAnand.WinUITemplates/3.3.0), added the ability to use the NuGet Central Package Management (CPM) feature within Visual Studio IDE.

Starting with [v3.4.0](https://www.nuget.org/packages/VijayAnand.WinUITemplates/3.4.0), introduced an option to support the XML-based solution file (slnx) format.

*This would be an explicit option since the SLNX feature is currently in the preview stage and is only supported on VS2022.*

* `-slnx` | `--use-slnx` - Default value is `false`

*Note: These options may also be combined.*

Use the below .NET CLI command to create the projects out these template:

#### WinUI 3 App:

```shell
dotnet new winui -n MyApp
```

.NET 7:
```shell
dotnet new winui -n MyApp -f net7.0
```

.NET 9 Preview:
```shell
dotnet new winui -n MyApp -f net9.0
```

MVVM based solution:
```shell
dotnet new winui -n MyApp -mvvm
```

Option to include only the MVVM NuGet package:
```shell
dotnet new winui -n MyApp -imt
```

Option to use the CPM feature:
```shell
dotnet new winui -n MyApp -cpm
```

Option to create the SLNX solution file:
```shell
dotnet new winui -n MyApp -slnx
```

#### Blazor Hybrid App:

```shell
dotnet new winui-blazor -n HybridApp
```

.NET 7:
```shell
dotnet new winui-blazor -n HybridApp -f net7.0
```

.NET 9 Preview:
```shell
dotnet new winui-blazor -n HybridApp -f net9.0
```

MVVM based solution:
```shell
dotnet new winui-blazor -n HybridApp -mvvm
```

Option to include only the MVVM NuGet package:
```shell
dotnet new winui-blazor -n HybridApp -imt
```

Option to use the CPM feature:
```shell
dotnet new winui-blazor -n HybridApp -cpm
```

Option to create the SLNX solution file:
```shell
dotnet new winui-blazor -n HybridApp -slnx
```

#### Library:

```shell
dotnet new winuilib -n MyLib
```

.NET 7:
```shell
dotnet new winuilib -n MyLib -f net7.0
```

.NET 9 Preview:
```shell
dotnet new winuilib -n MyLib -f net9.0
```

Option to include only the MVVM NuGet package:
```shell
dotnet new winuilib -n MyLib -imt
```

Option to use the CPM feature:
```shell
dotnet new winuilib -n MyLib -cpm
```

Option to create the SLNX solution file:
```shell
dotnet new winuilib -n MyLib -slnx
```

#### Item Templates:

Use the below .NET CLI command to create the items out these template:

All these item templates require one mandatory parameter:

* `-n` | `--name` - Name of the item

Auto suffixing of the Type name is supported for the files created with the `Page` and `Window` item templates.

Page:
```shell
dotnet new winui-page -n Order
```

UserControl:
```shell
dotnet new winui-usercontrol -n CardView
```

Window:
```shell
dotnet new winui-window -n Home
```