ReadMe.md
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.
Target | Branch | Status | Recommended package version |
---|---|---|---|
Production | rel/7.0.2 | ||
Pre-release beta testing | main |
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.
Contribution 🚀
Do you want to contribute? Check out our Windows Community Toolkit Wiki page to learn more about contribution and guidelines.
NuGet Packages 📦
NuGet is a standard package manager for .NET applications which is built into Visual Studio. When you open solution in Visual Studio, choose the Tools menu > NuGet Package Manager > Manage NuGet packages for solution... Enter one of the package names mentioned in Windows Community Toolkit Nuget Packages table to search for it online.
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 October 2018 Update (1809) SDK 17763 and above; however, refer to specific documentation on each feature for more information.
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.
Roadmap 🌎
Read what we plan for next iterations, and feel free to ask questions.
Check out our Preview Packages Wiki Page to learn more about updating your NuGet sources in Visual Studio, then you can also get pre-release packages of upcoming versions to try.
Code of Conduct 📄
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.
.NET Foundation
This project is supported by the .NET Foundation.