Skip to content

Commit 4f5d52d

Browse files
authored
Merge pull request #6273 from MicrosoftDocs/niels9001/winui-winget
WinUI Getting started updates
2 parents c5cbb4d + 249a55c commit 4f5d52d

10 files changed

Lines changed: 186 additions & 349 deletions

File tree

hub/apps/get-started/index.md

Lines changed: 68 additions & 199 deletions
Large diffs are not rendered by default.

hub/apps/get-started/samples.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,3 @@ You can get the [**Windows Community Toolkit Gallery app from the Microsoft Sto
4747
[**.NET Community Toolkit**](https://github.com/CommunityToolkit/dotnet)
4848

4949
The .NET Community Toolkit is a collection of NuGet packages with high-performance helpers, extensions, and APIs designed to enhance .NET development across WinUI, WPF, MAUI, and other .NET applications. A key component is the [MVVM Toolkit](/dotnet/communitytoolkit/mvvm/), a lightweight and modern Model-View-ViewModel (MVVM) library that simplifies app architecture with features like observable properties, commands, and dependency injection. Built for performance and flexibility, the MVVM Toolkit helps you implement MVVM patterns efficiently while keeping your code clean and maintainable.
50-
51-
52-
53-
[**Template Studio**](https://github.com/microsoft/TemplateStudio)
54-
55-
Template Studio provides a powerful scaffolding tool for quickly generating modern Windows applications using WinUI or WPF. The Visual Studio extension guides developers through a wizard-based experience to create project templates with best practices, including MVVM architecture, navigation patterns, dependency injection, and predefined app features. By automating boilerplate setup, Template Studio helps developers focus on building great experiences while ensuring consistency and maintainability in their applications.

hub/apps/get-started/start-here.md

Lines changed: 54 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,57 @@
11
---
2-
title: Setup for WinUI
2+
title: Set up your environment and create your first WinUI project
33
description: List of steps to get started developing Windows apps with WinUI and the Windows App SDK.
44
ms.topic: how-to
5-
ms.date: 12/18/2025
5+
ms.date: 02/18/2026
66
keywords: windows, desktop development
77
ms.localizationpriority: medium
88
ms.collection: windows11
99
---
1010

11-
# Quickstart for WinUI and Windows App SDK
11+
# Quick start: Set up your environment and create a WinUI project
1212

13-
This Hello World guide walks you through setting up your WinUI and Windows App SDK development environment in Visual Studio and creating your first app.
13+
This quick start guide walks you through setting up your WinUI and Windows App SDK development environment and creating your first app. To develop WinUI apps, you need:
1414

15-
## 1. Enable Developer Mode
15+
- [Visual Studio 2026](/visualstudio/ide/) with the required workloads for WinUI and Windows App SDK
16+
- [Developer Mode](/windows/advanced-settings/developer-mode) enabled on your device
1617

17-
Windows includes a Developer Mode that adjusts security settings to let you run and test apps you're building. Enable Developer Mode before building, deploying, and testing your app with Visual Studio.
18+
## Set up your development environment
1819

19-
> [!TIP]
20-
> If you don't enable Developer Mode now, Visual Studio prompts you to enable it when you try to build your app.
21-
22-
To enable Developer Mode:
23-
24-
* Open Windows Settings and navigate to the **[System > Advanced](ms-settings:developers)** page.
25-
* Toggle the **Developer Mode** switch to **On** and confirm your choice in the confirmation dialog.
26-
27-
For more information about Developer Mode, see [Settings for developers](/windows/advanced-settings/developer-mode).
20+
#### [WinGet Configuration](#tab/wingetconfig)
2821

29-
## 2. Install Visual Studio and the required workloads for WinUI and Windows App SDK
22+
Open [Windows Terminal](/windows/terminal/) and run the following command in PowerShell to automatically set up your environment using a [WinGet Configuration file](../../package-manager/configuration/index.md). This will:
3023

31-
Use [Visual Studio](/visualstudio/ide/), Microsoft's IDE, to build, debug, and deploy WinUI apps. Visual Studio includes ready-to-use project templates for Windows that help you get started quickly.
24+
- Install Visual Studio 2026 with the required workloads
25+
- Enable Developer Mode
3226

33-
The free **Visual Studio Community** edition includes everything you need to develop apps. **Professional** and **Enterprise** editions are available for larger teams or organizations. For more details, see [What is Visual Studio?](/visualstudio/get-started/visual-studio-ide) and the [system requirements for Windows app development](../windows-app-sdk/system-requirements.md).
27+
```powershell
28+
winget configure -f https://aka.ms/winui-config
29+
```
3430

35-
### [WinGet](#tab/winget)
31+
> [!TIP]
32+
> To review the config file and learn more, see its [README](https://github.com/microsoft/winget-dsc/blob/main/samples/Configuration%20files/Learn%20tutorials/WinUI/README.md] on GitHub.
3633
37-
Install the required tools and workloads by running one of the following commands in a console.
38-
The command opens the Visual Studio Installer with any missing workloads preselected — select **Modify** to install them.
34+
#### [Manual installation](#tab/manual)
3935

40-
You can replace *Community* with *Professional* or *Enterprise* to install a different Visual Studio edition.
36+
#### Enable Developer Mode
4137

42-
**For C# app development**
38+
Windows includes a [Developer Mode](/windows/advanced-settings/developer-mode) that adjusts security settings to let you run and test apps you're building. Enable Developer Mode before building, deploying, and testing your app with Visual Studio.
4339

44-
```console
45-
winget install "Visual Studio Community 2022" --override "--add Microsoft.VisualStudio.Workload.ManagedDesktop Microsoft.VisualStudio.ComponentGroup.WindowsAppSDK.Cs" -s msstore
46-
```
47-
48-
**For C++ app development**
40+
To enable Developer Mode:
4941

50-
```console
51-
winget install "Visual Studio Community 2022" --override "--add Microsoft.VisualStudio.Workload.NativeDesktop Microsoft.VisualStudio.ComponentGroup.WindowsAppSDK.Cpp" -s msstore
52-
```
42+
* Open Windows Settings and navigate to the **[System > Advanced](ms-settings:developers)** page.
43+
* Toggle the **Developer Mode** switch to **On** and confirm your choice in the confirmation dialog.
5344

54-
### [Manual installation](#tab/manual)
45+
#### Install Visual Studio and the required WinUI and Windows App SDK workloads
5546

5647
Download and install the latest Visual Studio using the link below. For details, see [Install Visual Studio](/visualstudio/install/install-visual-studio).
5748

5849
> [!div class="button"]
5950
> [Download Visual Studio](https://visualstudio.microsoft.com/downloads/)
6051
61-
#### Required workloads and components
52+
##### Required workloads and components
6253

63-
When installing Visual Studio, include the workloads and components required for developing with WinUI and the Windows App SDK. After installation, you can open the Visual Studio Installer and select **Modify** to add workloads or components.
64-
65-
On the **Workloads** tab in the Visual Studio Installer, select the following workloads and components:
54+
In the Visual Studio Installer, select the following workloads on the **Workloads** tab. If Visual Studio is already installed, open the installer and select **Modify** to add them.
6655

6756
* **For C# app development** using the Windows App SDK, select **WinUI application development**.
6857

@@ -75,38 +64,44 @@ On the **Workloads** tab in the Visual Studio Installer, select the following wo
7564
7665
---
7766

78-
## 3. Create and launch your first WinUI app
79-
80-
Visual Studio project templates include everything you need to create an app quickly. When you create a project from a WinUI app template, you start with a runnable app that you can extend with your own code.
67+
## Create and launch your first WinUI app
8168

82-
To create a new project using the **WinUI C# Blank App** project template:
69+
1. Open Visual Studio and select **Create a new project**.
8370

84-
1. Open Visual Studio and select **Create a new project** on the launch page. If Visual Studio is already open, select **File** > **New** > **Project**.
85-
:::image type="content" source="images/hello-world/start-project.png" alt-text="Create a new project":::
71+
2. Search for **WinUI**, select the **WinUI Blank App (Packaged)** C# project template, and select **Next**.
8672

87-
1. Search for **WinUI**, select the **WinUI Blank App (Packaged)** C# project template, and then select **Next**.
88-
:::image type="content" source="images/hello-world/create-project.png" alt-text="Blank, packaged WinUI C# desktop app":::
73+
:::image type="content" source="images/hello-world/create-project.png" lightbox="images/hello-world/create-project.png" alt-text="Blank, packaged WinUI C# desktop app":::
8974

90-
1. Specify a project name, then select **Create**. You can optionally specify a solution name and directory, or leave the defaults. In this image, the `Hello World` project belongs to a `Hello World` solution, which lives in `C:\Projects\`:
91-
:::image type="content" source="images/hello-world/configure-project.png" alt-text="Specify project details":::
75+
3. Enter a project name and select **Create**.
9276

93-
1. Press the **Start** button to build and run your project:<br/>
94-
:::image type="content" source="images/hello-world/start-click.png" alt-text="Build and run your project":::<br/>
77+
:::image type="content" source="images/hello-world/configure-project.png" lightbox="images/hello-world/configure-project.png" alt-text="Specify project details":::
9578

96-
Your project will build, be deployed to your local machine, and run in debug mode:<br/>
79+
4. Press **Start** (**F5**) to build and run your app.
9780

98-
:::image type="content" source="images/hello-world/click-me.png" border="false" alt-text="Hello World project built and running":::
81+
:::image type="content" source="images/hello-world/start-click.png" alt-text="Build and run your project":::
9982

100-
Congratulations, you've just built your first WinUI app!
83+
Your app builds, deploys, and launches in debug mode:
10184

102-
## Next steps
85+
:::image type="content" source="images/hello-world/click-me.png" border="false" alt-text="Hello World project built and running":::
10386

104-
> [!div class="nextstepaction"]
105-
> [Build your first app with WinUI](../tutorials/winui-notes/intro.md)
87+
You've built and launched your first WinUI app! 🎉
10688

107-
* To get an idea of what WinUI offers, check out the WinUI Gallery app.
108-
[!INCLUDE [winui-3-gallery](../../includes/winui-3-gallery.md)]
89+
## Next steps
10990

110-
* Learn more about [WinUI fundamentals](../develop/index.md).
111-
* Explore [Fluent Design](../design/index.md) principles.
112-
* Find [samples and tools](samples.md) to help you develop apps more efficiently.
91+
:::row:::
92+
:::column:::
93+
[![Hello WinUI](../winui/winui3/images/hero-hello-winui.png)](../tutorials/winui-notes/intro.md)<br>
94+
**[Build your first WinUI app](../tutorials/winui-notes/intro.md)**<br>
95+
Ready to go further? Follow the step-by-step tutorial to build a full WinUI app.
96+
:::column-end:::
97+
:::column:::
98+
[![WinUI Gallery](../winui/winui3/images/winui-gallery.png)](samples.md#winui-gallery)<br>
99+
**[WinUI Gallery](samples.md#winui-gallery)**<br>
100+
Explore interactive examples of WinUI controls, features, and functionality.
101+
:::column-end:::
102+
:::column:::
103+
[![Samples icon](../images/tile-samples.png)](samples.md)<br>
104+
**[Samples and resources](samples.md)**<br>
105+
Browse code samples, starter projects, and tools to accelerate your development.
106+
:::column-end:::
107+
:::row-end:::

hub/apps/package-and-deploy/index.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,6 @@ ms.date: 12/17/2025
66
ms.localizationpriority: medium
77
---
88

9-
<div class="buttons margin-top-xs">
10-
<a href="../introduction.md" class="button button-sm"><span>Start</span></a>
11-
<a href="../design/index.md" class="button button-sm"><span>Design</span></a>
12-
<a href="../develop/index.md" class="button button-sm"><span>Develop</span></a>
13-
<a href="" class="button button-sm button-primary button-filled"><span>Package</span></a>
14-
<a href="../publish/index.md" class="button button-sm"><span>Publish</span></a>
15-
</div>
16-
179
# Package and deploy Windows apps overview
1810

1911
:::image type="content" source="images/header-packaging.png" alt-text="Blue wrench and screwdriver icons on a light gray banner background representing tools for app packaging and deployment." border="false":::

hub/apps/toc.yml

Lines changed: 38 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ items:
66
href: introduction.md
77
- name: Core concepts
88
expanded: true
9-
items:
9+
items:
10+
- name: Overview
11+
href: get-started/index.md
1012
- name: Windows SDK
1113
items:
1214
- name: Overview
@@ -30,33 +32,36 @@ items:
3032
- name: Windows App SDK 1.8
3133
href: windows-app-sdk/release-notes/windows-app-sdk-1-8.md
3234
- name: Windows App SDK 1.7
33-
href: windows-app-sdk/release-notes/windows-app-sdk-1-7.md
34-
- name: Windows App SDK 1.6
35-
href: windows-app-sdk/release-notes/windows-app-sdk-1-6.md
36-
- name: Windows App SDK 1.5
37-
href: windows-app-sdk/release-notes/windows-app-sdk-1-5.md
38-
- name: Windows App SDK 1.4
39-
href: windows-app-sdk/release-notes/windows-app-sdk-1-4.md
40-
- name: Windows App SDK 1.3
41-
href: windows-app-sdk/release-notes/windows-app-sdk-1-3.md
42-
- name: Windows App SDK 1.2
43-
href: windows-app-sdk/release-notes/windows-app-sdk-1-2.md
44-
- name: Windows App SDK 1.1
45-
href: windows-app-sdk/release-notes/windows-app-sdk-1-1.md
46-
- name: Windows App SDK 1.0
47-
href: windows-app-sdk/release-notes/windows-app-sdk-1-0.md
48-
- name: Windows App SDK 0.8
49-
href: windows-app-sdk/release-notes/windows-app-sdk-0-8.md
50-
- name: Windows App SDK 0.5
51-
href: windows-app-sdk/release-notes/windows-app-sdk-0-5.md
52-
- name: Project Reunion
35+
href: windows-app-sdk/release-notes/windows-app-sdk-1-7.md
36+
- name: Older versions
5337
items:
54-
- name: Project Reunion 0.8 Preview
55-
href: windows-app-sdk/release-notes/project-reunion-0-8-preview.md
56-
- name: Project Reunion 0.5 Preview
57-
href: windows-app-sdk/release-notes/project-reunion-0-5-preview.md
58-
- name: Project Reunion 0.5
59-
href: windows-app-sdk/release-notes/project-reunion-0-5.md
38+
39+
- name: Windows App SDK 1.6
40+
href: windows-app-sdk/release-notes/windows-app-sdk-1-6.md
41+
- name: Windows App SDK 1.5
42+
href: windows-app-sdk/release-notes/windows-app-sdk-1-5.md
43+
- name: Windows App SDK 1.4
44+
href: windows-app-sdk/release-notes/windows-app-sdk-1-4.md
45+
- name: Windows App SDK 1.3
46+
href: windows-app-sdk/release-notes/windows-app-sdk-1-3.md
47+
- name: Windows App SDK 1.2
48+
href: windows-app-sdk/release-notes/windows-app-sdk-1-2.md
49+
- name: Windows App SDK 1.1
50+
href: windows-app-sdk/release-notes/windows-app-sdk-1-1.md
51+
- name: Windows App SDK 1.0
52+
href: windows-app-sdk/release-notes/windows-app-sdk-1-0.md
53+
- name: Windows App SDK 0.8
54+
href: windows-app-sdk/release-notes/windows-app-sdk-0-8.md
55+
- name: Windows App SDK 0.5
56+
href: windows-app-sdk/release-notes/windows-app-sdk-0-5.md
57+
- name: Project Reunion
58+
items:
59+
- name: Project Reunion 0.8 Preview
60+
href: windows-app-sdk/release-notes/project-reunion-0-8-preview.md
61+
- name: Project Reunion 0.5 Preview
62+
href: windows-app-sdk/release-notes/project-reunion-0-5-preview.md
63+
- name: Project Reunion 0.5
64+
href: windows-app-sdk/release-notes/project-reunion-0-5.md
6065
- name: Downloads
6166
items:
6267
- name: Latest
@@ -65,15 +70,14 @@ items:
6570
href: windows-app-sdk/downloads-archive.md
6671
- name: WinUI
6772
href: winui/winui3/index.md
68-
- name: App frameworks
69-
href: get-started/index.md
70-
- name: Get started
73+
- name: Get started with WinUI
7174
items:
72-
- name: Setup and tooling
75+
- name: Quick start
7376
href: get-started/start-here.md
74-
- name: Create your first WinUI app
75-
href: tutorials/winui-notes/intro.md
77+
- name: "Tutorial: Create your first WinUI app"
7678
items:
79+
- name: Introduction
80+
href: tutorials/winui-notes/intro.md
7781
- name: 1. Project setup
7882
href: tutorials/winui-notes/project.md
7983
- name: 2. Note page
@@ -102,5 +106,5 @@ items:
102106
href: get-started/windows-developer-glossary.md
103107
- name: FAQ
104108
href: get-started/windows-developer-faq.md
105-
- name: What's new?
109+
- name: What's new
106110
href: whats-new/whats-new-for-developers.md

hub/apps/tutorials/winui-notes/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.date: 09/02/2025
77
ms.topic: tutorial
88
ms.localizationpriority: medium
99
---
10-
# Create a WinUI app
10+
# Create your first WinUI app
1111

1212
This tutorial series demonstrates how to create a WinUI app using XAML and C#. The app you'll create is a note app, where the user can create, save, and load multiple notes. You can download or view the code for this tutorial from the [GitHub repo](https://github.com/MicrosoftDocs/windows-topic-specific-samples/tree/winui-3/tutorials/winui-notes).
1313

hub/apps/winui/winui3/index.md

Lines changed: 13 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ WinUI combines the flexibility of the Win32 app model with the richness of moder
3434
:::column span="2":::
3535
**Modern UI**<br>
3636
WinUI includes a comprehensive set of modern UI controls and styles, designed for usability, adaptability, and a polished, Fluent look and feel.
37-
<br><br>
37+
<br>
3838
[Explore Fluent Design](../../design/index.md)
3939
:::column-end:::
4040
:::row-end:::
@@ -66,7 +66,7 @@ WinUI combines the flexibility of the Win32 app model with the richness of moder
6666
:::column span="2":::
6767
**Built on the Windows App SDK**<br>
6868
WinUI is part of the Windows App SDK, giving you access to modern Windows APIs, consistent app behaviors, and tools that simplify development and deployment.
69-
<br><br>
69+
<br>
7070
[Learn more about the Windows App SDK](../../windows-app-sdk/index.md)
7171
:::column-end:::
7272
:::row-end:::
@@ -89,32 +89,18 @@ To get started with WinUI, you can try out these resources to get you started:
8989

9090
:::row:::
9191
:::column:::
92-
![An image that says Hello, WinUI](images/hero-hello-winui.png)
92+
[![Hello WinUI](images/hero-hello-winui.png)](../../get-started/start-here.md)<br>
93+
**[Hello, WinUI](../../get-started/start-here.md))**<br>
94+
Setup your development environment and build your first WinUI app.
9395
:::column-end:::
94-
:::column span="2":::
95-
**Hello, WinUI**<br>
96-
Setup your development environment and build your first WinUI app.
97-
<br>
98-
> [!div class="nextstepaction"]
99-
> [Create your first WinUI app](../../get-started/start-here.md)
100-
:::column-end:::
101-
:::row-end:::
102-
103-
:::row:::
10496
:::column:::
105-
![A screenshot of the WinUI Gallery](images/winui-gallery.png)
97+
[![WinUI Gallery](images/winui-gallery.png)](../../get-started/samples.md#winui-gallery)<br>
98+
**[WinUI Gallery](../../get-started/samples.md#winui-gallery)**<br>
99+
Explore interactive examples of WinUI controls, features, and functionality.
100+
:::column-end:::
101+
:::column:::
102+
[![Samples icon](../../images/tile-samples.png)](../../get-started/samples.md)<br>
103+
**[Samples and resources](../../get-started/samples.md)**<br>
104+
Browse code samples, starter projects, and tools to accelerate your development.
106105
:::column-end:::
107-
:::column span="2":::
108-
**Explore the WinUI Gallery**<br>
109-
The WinUI Gallery is an open-source app that showcases interactive examples of WinUI controls, features, and functionality. It includes code snippets and design guidance to help you get started quickly.
110-
<br><br>
111-
[Explore WinUI Gallery](../../get-started/samples.md#winui-gallery)
112-
:::column-end:::
113106
:::row-end:::
114-
115-
### See also
116-
117-
- [Windows App SDK](../../windows-app-sdk/index.md)
118-
- [Windows App SDK API docs](/windows/windows-app-sdk/api/winrt/)
119-
- [Windows App SDK Samples](https://github.com/microsoft/WindowsAppSDK-Samples)
120-
- [Design guidelines](../../design/index.md)

hub/images/winui-gallery-icon.png

2.69 KB
Loading

0 commit comments

Comments
 (0)