Awesome-copilot winui3-migration-guide
UWP-to-WinUI 3 migration reference. Maps legacy UWP APIs to correct Windows App SDK equivalents with before/after code snippets. Covers namespace changes, threading (CoreDispatcher to DispatcherQueue), windowing (CoreWindow to AppWindow), dialogs, pickers, sharing, printing, background tasks, and the most common Copilot code generation mistakes.
git clone https://github.com/github/awesome-copilot
T=$(mktemp -d) && git clone --depth=1 https://github.com/github/awesome-copilot "$T" && mkdir -p ~/.claude/skills && cp -r "$T/plugins/winui3-development/skills/winui3-migration-guide" ~/.claude/skills/github-awesome-copilot-winui3-migration-guide && rm -rf "$T"
plugins/winui3-development/skills/winui3-migration-guide/SKILL.mdWinUI 3 Migration Guide
Use this skill when migrating UWP apps to WinUI 3 / Windows App SDK, or when verifying that generated code uses correct WinUI 3 APIs instead of legacy UWP patterns.
Namespace Changes
All
Windows.UI.Xaml.* namespaces move to Microsoft.UI.Xaml.*:
| UWP Namespace | WinUI 3 Namespace |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| (for dispatcher) |
Top 3 Most Common Copilot Mistakes
1. ContentDialog Without XamlRoot
// ❌ WRONG — Throws InvalidOperationException in WinUI 3 var dialog = new ContentDialog { Title = "Error", Content = "Something went wrong.", CloseButtonText = "OK" }; await dialog.ShowAsync();
// ✅ CORRECT — Set XamlRoot before showing var dialog = new ContentDialog { Title = "Error", Content = "Something went wrong.", CloseButtonText = "OK", XamlRoot = this.Content.XamlRoot // Required in WinUI 3 }; await dialog.ShowAsync();
2. MessageDialog Instead of ContentDialog
// ❌ WRONG — UWP API, not available in WinUI 3 desktop var dialog = new Windows.UI.Popups.MessageDialog("Are you sure?", "Confirm"); await dialog.ShowAsync();
// ✅ CORRECT — Use ContentDialog var dialog = new ContentDialog { Title = "Confirm", Content = "Are you sure?", PrimaryButtonText = "Yes", CloseButtonText = "No", XamlRoot = this.Content.XamlRoot }; var result = await dialog.ShowAsync(); if (result == ContentDialogResult.Primary) { // User confirmed }
3. CoreDispatcher Instead of DispatcherQueue
// ❌ WRONG — CoreDispatcher does not exist in WinUI 3 await Dispatcher.RunAsync(CoreDispatcherPriority.Normal, () => { StatusText.Text = "Done"; });
// ✅ CORRECT — Use DispatcherQueue DispatcherQueue.TryEnqueue(() => { StatusText.Text = "Done"; }); // With priority: DispatcherQueue.TryEnqueue(DispatcherQueuePriority.High, () => { ProgressBar.Value = 100; });
Windowing Migration
Window Reference
// ❌ WRONG — Window.Current does not exist in WinUI 3 var currentWindow = Window.Current;
// ✅ CORRECT — Use a static property in App public partial class App : Application { public static Window MainWindow { get; private set; } protected override void OnLaunched(LaunchActivatedEventArgs args) { MainWindow = new MainWindow(); MainWindow.Activate(); } } // Access anywhere: App.MainWindow
Window Management
| UWP API | WinUI 3 API |
|---|---|
| |
| |
| |
| |
| |
| property |
| |
Title Bar
| UWP API | WinUI 3 API |
|---|---|
| |
| |
Dialogs and Pickers Migration
File/Folder Pickers
// ❌ WRONG — UWP style, no window handle var picker = new FileOpenPicker(); picker.FileTypeFilter.Add(".txt"); var file = await picker.PickSingleFileAsync();
// ✅ CORRECT — Initialize with window handle var picker = new FileOpenPicker(); var hwnd = WinRT.Interop.WindowNative.GetWindowHandle(App.MainWindow); WinRT.Interop.InitializeWithWindow.Initialize(picker, hwnd); picker.FileTypeFilter.Add(".txt"); var file = await picker.PickSingleFileAsync();
Threading Migration
| UWP Pattern | WinUI 3 Equivalent |
|---|---|
| |
| |
| No equivalent — restructure async code |
| Not available — use |
Key difference: UWP uses ASTA (Application STA) with built-in reentrancy blocking. WinUI 3 uses standard STA without this protection. Watch for reentrancy issues when async code pumps messages.
Background Tasks Migration
// ❌ WRONG — UWP IBackgroundTask public sealed class MyTask : IBackgroundTask { public void Run(IBackgroundTaskInstance taskInstance) { } }
// ✅ CORRECT — Windows App SDK AppLifecycle using Microsoft.Windows.AppLifecycle; // Register for activation var args = AppInstance.GetCurrent().GetActivatedEventArgs(); if (args.Kind == ExtendedActivationKind.AppNotification) { // Handle background activation }
App Settings Migration
| Scenario | Packaged App | Unpackaged App |
|---|---|---|
| Simple settings | | JSON file in |
| Local file storage | | |
GetForCurrentView() Replacements
All
GetForCurrentView() patterns are unavailable in WinUI 3 desktop apps:
| UWP API | WinUI 3 Replacement |
|---|---|
| Use properties |
| |
| Win32 or |
| Not available — track windows manually |
| Handle back navigation in directly |
Testing Migration
UWP unit test projects do not work with WinUI 3. You must migrate to the WinUI 3 test project templates.
| UWP | WinUI 3 |
|---|---|
| Unit Test App (Universal Windows) | Unit Test App (WinUI in Desktop) |
| Standard MSTest project with UWP types | Must use WinUI test app for Xaml runtime |
for all tests | for logic, for XAML/UI tests |
| Class Library (Universal Windows) | Class Library (WinUI in Desktop) |
// ✅ WinUI 3 unit test — use [UITestMethod] for any XAML interaction [UITestMethod] public void TestMyControl() { var control = new MyLibrary.MyUserControl(); Assert.AreEqual(expected, control.MyProperty); }
Key: The
[UITestMethod] attribute tells the test runner to execute the test on the XAML UI thread, which is required for instantiating any Microsoft.UI.Xaml type.
Migration Checklist
- Replace all
using directives withWindows.UI.Xaml.*Microsoft.UI.Xaml.* - Replace
withWindows.UI.ColorsMicrosoft.UI.Colors - Replace
withCoreDispatcher.RunAsyncDispatcherQueue.TryEnqueue - Replace
withWindow.Current
static propertyApp.MainWindow - Add
to allXamlRoot
instancesContentDialog - Initialize all pickers with
InitializeWithWindow.Initialize(picker, hwnd) - Replace
withMessageDialogContentDialog - Replace
/ApplicationView
withCoreWindowAppWindow - Replace
withCoreApplicationViewTitleBarAppWindowTitleBar - Replace all
calls withGetForCurrentView()
equivalentsAppWindow - Update interop for Share and Print managers
- Replace
withIBackgroundTask
activationAppLifecycle - Update project file: TFM to
, addnet10.0-windows10.0.22621.0<UseWinUI>true</UseWinUI> - Migrate unit tests to Unit Test App (WinUI in Desktop) project; use
for XAML tests[UITestMethod] - Test both packaged and unpackaged configurations