Skip to content

Latest commit

 

History

History
110 lines (69 loc) · 5.37 KB

ReadMe.md

File metadata and controls

110 lines (69 loc) · 5.37 KB

Windows Community Toolkit Gallery

Windows Community Toolkit

Documentation · Labs · Tooling

The Windows Community Toolkit is a rich set of controls, helpers and extensions designed to streamline Windows app development and to create great experiences for Windows. Our components are built on top of WinUI 2, WinUI 3, and Uno Platform!

Please read the Getting Started with the Windows Community Toolkit page for more detailed information about using the Toolkit in your app.

Note

If you're updating from a pre-8.x version of the Windows Community Toolkit, see our migration notes here.

Windows Community Toolkit Gallery app

Want to see the Toolkit in action before jumping into the code? Download and play with the Windows Community Toolkit Gallery from the Microsoft Store.

Windows Community Toolkit Gallery

Store badge

👏 Contribute to the Windows Community Toolkit

Have an idea for a new feature? Want to checkout the latest things being built? Then head over to Windows Community Toolkit Labs.

Building something cool? Want to engage with other developers? Want to contribute to the Toolkit? Engage in the discussion here!

📋 Getting started with Windows Community Toolkit

1. Set up the environment

Note

The Windows Community Toolkit requires Visual Studio 2022 or later to build and Windows 10 or later to execute. If you're building an app with WinUI and Windows App SDK for the first time, follow these installation instructions.

Required Visual Studio components:

  • Windows application development
  • .NET desktop development
  • Windows 10 SDK, version 2004 (10.0.19041.0)
  • Windows 10 21H1 (Build 19043) or greater

2. Clone the repository

The tooling is in a submodule, so you'll need to use --recurse-submodules when cloning or pulling for the first time:

git clone --recurse-submodules https://github.com/CommunityToolkit/Windows.git

3. Run build scripts & open solution

🚀 Contribution

We're always looking for a helping hand, look for issues that we need help with here or head over to Windows Community Toolkit Labs to try or build new features.

Even just improving our docs and samples for existing components here, or adding new tests can be a huge help!

Check out our Windows Community Toolkit Wiki page to learn more about contribution and guidelines in general (to be updated more soon).

📦 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…

There are now two sets of packages for each component:

  • CommunityToolkit.Uwp.* for UWP + WinUI 2 or Uno.UI
  • CommunityToolkit.WinUI.* for Windows App SDK + WinUI 3 or Uno.WinUI

💠 Principles

  1. The toolkit will provide features that are needed for a wide-array of developers, are easy-to-use, and maintainable.
  2. As soon as a comparable feature is available in the Windows SDK for Windows, it will be marked as deprecated.
  3. We will fix issues forward and stay up-to-date on top of WinUI 2 and 3 updates supporting the minimum OS level that they also support.

📄 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

Toolkit Contributors

Made with contrib.rocks.