You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Welcome to the home of Windows Community Toolkit. Our components are built on top of [WinUI 2](https://aka.ms/winuigithub), [WinUI 3](https://aka.ms/winui3), and [Uno Platform](https://platform.uno)!
17
+
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](https://aka.ms/winuigithub), [WinUI 3](https://aka.ms/winui3), and [Uno Platform](https://platform.uno)!
7
18
8
-
They enable developers to build great experiences for Windows with .NET!
19
+
Please read the [Getting Started with the Windows Community Toolkit](https://docs.microsoft.com/dotnet/communitytoolkit/windows/getting-started) page for more detailed information about using the Toolkit in your app.
9
20
10
-
_Building something cool? Want to engage with other developers? Want to contribute to the Toolkit? **[Engage in the discussion here!](https://github.com/CommunityToolkit/Windows/discussions)**_
21
+
> [!NOTE]
22
+
> If you're updating from a pre-8.x version of the Windows Community Toolkit, see [our migration notes here](https://aka.ms/toolkit/windows/migration).
11
23
12
-
## Getting Started
24
+
## Windows Community Toolkit Gallery app
13
25
14
-
### [Try out our Sample Gallery from the Microsoft Store](https://aka.ms/windowstoolkitapp)
26
+
Want to see the Toolkit in action before jumping into the code? Download and play with the [Windows Community Toolkit Gallery](https://aka.ms/windowstoolkitapp) from the Microsoft Store.
15
27
16
-
Want to see the toolkit in action before jumping into the code? Download and play with the [Windows Community Toolkit Gallery](https://aka.ms/windowstoolkitapp) from the Store.
28
+
<palign="center">
29
+
<imgsrc="docs/images/gallery.png"alt="Windows Community Toolkit Gallery"width="480"/>
Please read the [Getting Started with the Windows Community Toolkit](https://docs.microsoft.com/dotnet/communitytoolkit/windows/getting-started) page for more detailed information about using the toolkit.
19
37
20
-
If you're updating from a pre-8.x version of the Windows Community Toolkit, see [our migration notes here](https://aka.ms/toolkit/windows/migration).
21
38
22
-
### Windows Community Toolkit Labs
23
39
24
-
Have an idea for a new feature? Want to checkout the latest things being built. _[Then head over to Windows Community Toolkit Labs](https://aka.ms/toolkit/labs/windows)_.
40
+
## 👏 Contribute to the Windows Community Toolkit
25
41
26
-
You can even see the latest components [live in your browser!](https://toolkitlabs.dev)
42
+
Have an idea for a new feature? Want to checkout the latest things being built? [Then head over to Windows Community Toolkit Labs](https://aka.ms/toolkit/labs/windows).
27
43
28
-
## Clone the repository
44
+
Building something cool? Want to engage with other developers? Want to contribute to the Toolkit? **[Engage in the discussion here!](https://github.com/CommunityToolkit/Windows/discussions)**
45
+
46
+
## 📋 Getting started with Windows Community Toolkit
47
+
48
+
### 1. Set up the environment
49
+
50
+
> [!NOTE]
51
+
> The Windows Community Toolkit requires [Visual Studio 2022](https://visualstudio.microsoft.com/vs/) 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](https://learn.microsoft.com/windows/apps/get-started/start-here).
52
+
53
+
**Required [Visual Studio components](https://learn.microsoft.com/windows/apps/get-started/start-here?tabs=vs-2022-17-10#required-workloads-and-components):**
54
+
- Windows application development
55
+
- .NET desktop development
56
+
- Windows 10 SDK, version 2004 (10.0.19041.0)
57
+
- Windows 10 21H1 (Build 19043) or greater
58
+
59
+
### 2. Clone the repository
29
60
30
61
The [tooling](https://github.com/CommunityToolkit/Tooling-Windows-Submodule) is in a submodule, so you'll need to use `--recurse-submodules` when cloning or pulling for the first time:
- Visual Studio 2022 (UWP & Desktop Workloads for .NET)
39
-
- .NET 8 SDK
40
-
- Windows 10 SDK, version 2004 (10.0.19041.0)
41
-
- Windows 10 21H1 (Build 19043) or greater
67
+
### 3. Run build scripts & open solution
42
68
- Run `dotnet tool restore` from the project root to install SlnGen
43
69
- Run build scripts from the [Developer Command Prompt for Visual Studio](https://learn.microsoft.com/visualstudio/ide/reference/command-prompt-powershell) or from elsewhere after adding `MSBuild.exe` to your PATH
44
70
71
+
45
72
## 🚀 Contribution
46
73
47
74
We're always looking for a helping hand, [look for issues that we need help with here](https://github.com/CommunityToolkit/Windows/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) or head over to [Windows Community Toolkit Labs](https://aka.ms/toolkit/labs/windows) to try or build new features.
@@ -50,7 +77,7 @@ Even just improving our docs and samples for existing components here, or adding
50
77
51
78
Check out our [Windows Community Toolkit Wiki](https://aka.ms/wct/wiki) page to learn more about contribution and guidelines in general (to be updated more soon).
52
79
53
-
## 📦 NuGet Packages
80
+
## 📦 NuGet packages
54
81
55
82
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…*
56
83
@@ -59,9 +86,6 @@ There are now two sets of packages for each component:
59
86
-`CommunityToolkit.Uwp.*` for UWP + WinUI 2 or Uno.UI
60
87
-`CommunityToolkit.WinUI.*` for Windows App SDK + WinUI 3 or Uno.WinUI
61
88
62
-
## 📫 Features <aname="supported"></a>
63
-
64
-
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.
0 commit comments