| topic | languages | products | ||
|---|---|---|---|---|
sample |
|
|
Windows Community Toolkit
The Windows Community Toolkit is a collection of helper functions, custom controls, and app services. It simplifies and demonstrates common developer patterns when building experiences for Windows 10.
Build Status
| Target | Branch | Status | Recommended package version |
|---|---|---|---|
| Production | rel/6.0.0 |  |
|
| 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.
NuGet Packages
NuGet is a standard package manager for .NET applications which is built into Visual Studio. To open the UI, from your open solution, choose the Tools menu > NuGet Package Manager > Manage NuGet packages for solution... . Enter one of the package names below to search for it online.
Once you do a search, you should see a list similar to the one below (versions may be different, but names should be the same).
| NuGet Package Name | Description |
|---|---|
| Microsoft.Toolkit | .NET Standard NuGet package containing common code |
| Microsoft.Toolkit.HighPerformance | .NET Standard and .NET Core NuGet package with performance oriented helpers, extensions, etc. |
| Microsoft.Toolkit.Parsers | .NET Standard NuGet package containing cross-platform parsers, such as Markdown and RSS |
| Microsoft.Toolkit.Services | .NET Standard NuGet package containing cross-platform services |
| Microsoft.Toolkit.Uwp | Main NuGet package includes code only helpers such as Colors conversion tool, Storage file handling, a Stream helper class, etc. |
| Microsoft.Toolkit.Uwp.Notifications | Notifications Package - Generate tile, toast, and badge notifications for Windows 10 via code. Includes intellisense support to avoid having to use the XML syntax |
| Microsoft.Toolkit.Uwp.Notifications.Javascript | Notification Packages for JavaScript |
| Microsoft.Toolkit.Uwp.Services | Services Package - This NuGet package includes the service helpers for Facebook, LinkedIn, Microsoft Graph, Twitter and more |
| Microsoft.Toolkit.Uwp.UI | UI Packages - XAML converters, Visual tree extensions, and other extensions and helpers for your XAML UI |
| Microsoft.Toolkit.Uwp.UI.Animations | Animations and Composition behaviors such as Blur, Fade, Rotate, etc. |
| Microsoft.Toolkit.Uwp.UI.Controls | XAML Controls such as RadialGauge, RangeSelector, etc. |
| Microsoft.Toolkit.Uwp.UI.Controls.DataGrid | XAML DataGrid control |
| Microsoft.Toolkit.Uwp.UI.Controls.Layout | XAML layout controls such as WrapLayout, StaggeredLayout, etc. |
| Microsoft.Toolkit.Uwp.UI.Lottie | Library for rendering Adobe AfterEffects animations natively in Windows apps |
| Microsoft.Toolkit.Uwp.UI.Media | Brushes, Win2D/Composition effects, and helpers to create visual effects |
| Microsoft.Toolkit.Uwp.Connectivity | API helpers such as BluetoothLEHelper and Networking |
| Microsoft.Toolkit.Uwp.DeveloperTools | XAML user controls and services to help developer building their app |
Features
The Features list refers to all the currently available features that can be found in the Windows Community Toolkit. Most features should work with the Falls Creator Update SDK 16299 and above; however, refer to specific documentation on each feature for more information.
Feedback and Requests
Please use GitHub Issues for bug reports and feature requests.
For general questions and support, please use Stack Overflow where questions should be tagged with the tag windows-community-toolkit.
Required Dependencies
The following dependencies are required for building the Windows Community Toolkit repo and sample app:
- Visual Studio 2019 with UWP and .NET workloads
- You'll also need to check the
C++ (v142) Universal Windows Platform toolsoption under the UWP workload
- You'll also need to check the
- Windows SDK October 2018 Update 17763
- Sample App - Windows SDK May 2019 Update 18362 - Important: If you're building the Sample App on 2004, you must install the 19041 SDK and re-target the app ref.
- .NET Core 3.1 SDK
- .NET Framework 4.6.2 Developer Pack
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.