722b9b2bf2
* Migrate to MVVMToolkit 8.1 * Add breaking change test & get working with VSEmulator |
||
|---|---|---|
| .. | ||
| features | ||
| frameworks | ||
| pages | ||
| pipelines | ||
| projectTypes | ||
| activation.md | ||
| navigation.md | ||
| readme.md | ||
readme.md
WinUI 3 Apps
WinUI 3 project templates supported by Template Studio:
C# templates:
- App (WinUI 3 in Desktop)
- Class Library (WinUI 3 in Desktop)
C++ Templates:
- App (WinUI 3 in Desktop)
- Windows Runtime Component (WinUI 3)
We also offer the following item templates for C# and C++:
- Blank page
- Blank Window (Desktop)
- Custom Control
- Resource Dictionary
- Resources File
- User Control
Using and extending your generated project
WinUI 3 projects created with Template Studio (aka TS) are intended as a starting point, and will require modification and extension before they're finished. This page explains common ways to extend what is generated for you.
Understanding generated code from Template Studio
The final generated code is the result of a project configuration (project type and design pattern) and a multiple template choice (pages and features). There are a few concepts to understand before start working on the generated code.
Understanding concepts for Template Studio
Template Studio approaches WinUI 3 Desktop app creation using the following attribute sets to decide how to best generate your app. Below are descriptions of everything you can do.
Project Types
Project types define the basic look and feel of your WinUI 3 Desktop app.
| Project type | Description |
|---|---|
| Blank | It provides folder scaffolding creating the most important folders as Services, Styles, Views and ViewModels. It also provides a minimal set of styles, font sizes, and thickness values that you can use to build your app styles. This project type also includes basic services for activation and navigation. On application startup, the navigation to the home page is performed with these services. |
| Navigation Pane | This project includes a navigation pane (or 'hamburger menu') at the side of the screen, for navigation between pages. This style is popular in mobile apps but also works well on larger screens. The menu can be hidden when space is limited, or it isn't needed. The menu shows items with an icon and text. The menu can be entirely hidden, show just the icon, or show the icon and text. The user can choose to display the full menu at the touch of a button. The menu also adapts automatically to the size of the screen. |
| MenuBar | The project includes a menu bar on top of the screen that gives access to the pages of the application. Menu Bars are used a lot in desktop applications like Outlook, Word or Visual Studio. The menu initially shows two entries, File and Views. Pages are added to the Views menu entry, Settings Page to the file entry. Once the project is created you can redistribute or create new menu entries as convenient. |
Design patterns
App Design patterns define the coding pattern that will be used across the project, tying your UI and code together. Template Studio currently supports the following common patterns:
| Design pattern | Description |
|---|---|
| MVVM Toolkit | The CommunityToolkit.Mvvm package is a modern, fast, and modular MVVM library. It is part of the Windows Community Toolkit. |
Pages
| Page | Description |
|---|---|
| Blank | This is the most basic page. A blank canvas to mold into whatever you wish. |
| Content Grid | This page allows you to add custom items in the form of an Adaptive Grid. |
| Data Grid | A page displaying a simple data grid. |
| List Details | The list/details pattern has a list pane and a details pane for content. |
| Settings | The settings page is the page where we recommend putting the configuration settings for your app. |
| WebView | The web view page renders web content using the Microsoft Edge rendering engine. |
Features
Application Lifecycle
| Feature | Description |
|---|---|
| Settings Storage | Setting storage helps simplify storing data inside your application data folder. |
Packaging
| Feature | Description |
|---|---|
| MSIX | Allows packages creation for side-loading or distribution via Microsoft Store. |
User Interactions
| Feature | Description |
|---|---|
| Theme Selection | Adds theming support to your application. |