pinkuburu/windowscommunitytoolkit

The Windows Community Toolkit is a collection of helpers, extensions, and custom controls. It simplifies and demonstrates common developer tasks building .NET apps with UWP and the Windows App SDK / WinUI 3 for Windows 10 and Windows 11. The toolkit is part of the .NET Foundation.

🧰 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 and Windows 11. It contains components and helpers for both UWP and WinUI 3/WinAppSDK applications. Find out more about our support for WinUI 3 here.

Note: Our general helpers for .NET are now the .NET Community Toolkit, including the MVVM Toolkit.

Target	Branch	Status	Recommended package version
Production (UWP)	rel/7.1.2
Production (WinAppSDK/WinUI 3)	rel/winui/7.1.2
Previews	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.

🧪 Windows Community Toolkit Labs 💻

We're in the process of migrating our development process to the upcoming Toolkit Labs for Windows, find out more here.

⁉ Support

If you need help with something or have an idea, feel free to start a Discussion or find us on Discord. If you have detailed repro steps, open an issue here instead.

🚀 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

1. The toolkit will be kept simple.
2. As soon as a comparable feature is available in the Windows SDK for Windows, it will be marked as deprecated.
3. All features will be supported for two Windows SDK for Windows release cycles or until another principle supersedes it.

🌍 Roadmap

See our 2022 Plans here.

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.

🏆 Contributors

Made with contrib.rocks.