topic: sample languages:
- csharp products:
-
windows
Windows Community Toolkit - WPF and Windows Forms
This repository contains all controls for WPF and WinForms to simplify and demonstate usage of UWP controls.
For everything else in the Windows Community Toolkit (UWP controls, .NET Standard web services, helpers and more), start here
🚨 Archival Notice - 8/30/2023
With the release of Xaml Islands for Windows App SDK 1.4 this repo is being archived.
All feature/issue/discussion inquires related to XAML Islands should be directed to the WindowsAppSDK repository here.
XAML Islands Notice
The set of WPF and WinForms controls found here are only designed to work with .NET Core 3.1, not .NET 5 and above. These controls are using the XAML Islands Windows 10 APIs included within the Windows 10 OS which won't be improved anymore.
WinUI 3's XAML Islands is the path forward to these .NET apps that want to use .NET 5 and WinUI. WinUI 3's XAML Islands are still in development, and we recommend reviewing the WinUI 3 roadmap to get the latest updates. This repository will be archived once WinUI 3's XAML Islands is released.
In the meantime, we suggest you investigate WinUI 3 Desktop as a solution to access Win32 APIs while using the latest native UX platform. See here for more details.
Build Status
| Target | Branch | Status | Recommended NuGet packages version |
|---|---|---|---|
| Pre-release beta testing | master |  |
Getting Started
Please read the getting Started with the Windows Community Toolkit page for more detailed information about using the toolkit.
Documentation
All documentation for the toolkit is hosted on Microsoft Docs. All API documentation can be found at the .NET API Browser.
Windows Community Toolkit Sample App
Want to see the toolkit in action before jumping into the code? Download and play with the Windows Community Toolkit Sample App from the Store.
Controls
| Control | Minimum supported OS | Description |
|---|---|---|
| WindowsXamlHost | Windows 10, version 1809 | Adds built-in or custom UWP controls to the User Interface (UI) of WPF or Windows Forms desktop application. |
| WebView | Windows 10, version 1803 | Uses the Microsoft Edge rendering engine to show web content. |
| WebViewCompatible | Windows 7 | Provides a version of WebView that is compatible with more OS versions. This control uses the Microsoft Edge rendering engine to show web content on Windows 10 version 1803 and later, and the Internet Explorer rendering engine to show web content on earlier versions of Windows 10, Windows 8.x, and Windows 7. |
| InkCanvas InkToolbar |
Windows 10, version 1809 | Provide a surface and related toolbars for Windows Ink-based user interaction in your Windows Forms or WPF desktop application. |
| MediaPlayerElement | Windows 10, version 1809 | Embeds a view that streams and renders media content such as video in your Windows Forms or WPF desktop application. |
| MapControls | Windows 10, version 1809 | Enables a symbolic or photorealistic map in your Windows Forms or WPF desktop application. |
WebView Notice
New: Try out the pre-release preview of WebView2 for .NET here. 🎉🎉🎉
WebView2 will replace the WebView control in the toolkit, as laid out in the introduction to WebView2 here. This means that we've deprecated the WebView control within the Toolkit and are working with the Edge team to convey all the requirements from the open issues here.
Over the next few months, they'll be processing the open requests to ensure the scenarios folks are using WebView for will be supported with its replacement in the future. You can provide feedback directly to the Edge team here. Thank you for using WebView!
Feedback and Requests
Please use GitHub Issues for bug reports and feature requests.
For feature requests, please also create an entry in our UserVoice.
For general questions and support, please use Stack Overflow where questions should be tagged with the tag windows-community-toolkit.
Contributing
Do you want to contribute? Here are our contribution guidelines.
Principles
- Principle #1: The toolkit will be kept simple.
- Principle #2: As soon as a comparable feature is available in the Windows SDK for Windows 10, it will be marked as deprecated.
- Principle #3: All features will be supported for two Windows SDK for Windows 10 release cycles or until another principle supersedes it.
This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.
Roadmap
Read what we plan for next iterations, and feel free to ask questions.
By adding this (NuGet repo | Gallery) to your NuGet sources in Visual Studio, you can also get pre-release packages of upcoming versions.
.NET Foundation
This project is supported by the .NET Foundation.