Skip to content

Commit f9487fa

Browse files
committed
docs: Update Readme
1 parent 124d7ec commit f9487fa

File tree

1 file changed

+47
-6
lines changed

1 file changed

+47
-6
lines changed

ReadMe.md

Lines changed: 47 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# Uno Platform port of Windows Community Toolkit
22

3-
This port allows for [Uno Platform based](https://github.com/unoplatform/uno) apps to use [Windows Community Toolkit](https://github.com/Microsoft/WindowsCommunityToolkit)
3+
This port allows for [Uno Platform based](https://github.com/unoplatform/uno) apps to use [Windows Community Toolkit](https://github.com/Microsoft/WindowsCommunityToolkit) for WinUI 3
44
on Windows, iOS, macOS, Android, WebAssembly and Linux.
55

6+
See below on this page for information about UWP.
7+
68
The following packages are available:
7-
- Uno.Microsoft.Toolkit [![NuGet](https://img.shields.io/nuget/v/Uno.Microsoft.Toolkit.svg)](https://www.nuget.org/packages/Uno.Microsoft.Toolkit)
9+
- Uno.CommunityToolkit.Common [![NuGet](https://img.shields.io/nuget/v/CommunityToolkit.Common.svg)](https://www.nuget.org/packages/CommunityToolkit.Common)
810
- Uno.CommunityToolkit.WinUI [![NuGet](https://img.shields.io/nuget/v/Uno.CommunityToolkit.WinUI.svg)](https://www.nuget.org/packages/Uno.CommunityToolkit.WinUI)
911
- Uno.CommunityToolkit.WinUI.Connectivity [![NuGet](https://img.shields.io/nuget/v/Uno.CommunityToolkit.WinUI.Connectivity.svg)](https://www.nuget.org/packages/Uno.CommunityToolkit.WinUI.Connectivity)
1012
- Uno.CommunityToolkit.WinUI.DeveloperTools [![NuGet](https://img.shields.io/nuget/v/Uno.CommunityToolkit.WinUI.DeveloperTools.svg)](https://www.nuget.org/packages/Uno.CommunityToolkit.WinUI.DeveloperTools)
@@ -25,15 +27,54 @@ The following packages are available:
2527

2628
These packages are providing support for the Uno Platform supported targets (iOS, Android, macOS, WebAssembly and Skia GTK/WPF/Tizen).
2729

30+
On Windows projects (the WinUI 3 Desktop head), please install the official [Windows Community Toolkit packages](https://github.com/Microsoft/WindowsCommunityToolkit) for WinUI 3.
31+
32+
If you are building a library, use the following to conditionally include the toolkit builds:
33+
34+
```xml
35+
<ItemGroup Condition="'$(TargetFramework)' == 'net5.0-windows10.0.19041'">
36+
<PackageReference Include="CommunityToolkit.WinUI.Controls" Version="7.1.100" />
37+
</ItemGroup>
38+
<ItemGroup Condition="'$(TargetFramework)' != 'net5.0-windows10.0.19041'">
39+
<PackageReference Include="Uno.CommunityToolkit.WinUI.Controls" Version="7.1.100" />
40+
</ItemGroup>
41+
```
42+
43+
## Support for UWP
44+
45+
As the original Community Toolkit does, this fork also provides binaries for UWP, and the branch [`unorel/7.1`](https://github.com/unoplatform/Uno.WindowsCommunityToolkit/tree/unorel/7.1) is used to provide this support.
46+
47+
The following packages are available from this branch:
48+
- Uno.Microsoft.Toolkit [![NuGet](https://img.shields.io/nuget/v/Uno.Microsoft.Toolkit.svg)](https://www.nuget.org/packages/Uno.Microsoft.Toolkit)
49+
- Uno.Microsoft.Toolkit.Uwp [![NuGet](https://img.shields.io/nuget/v/Uno.Microsoft.Toolkit.Uwp.svg)](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.Uwp)
50+
- Uno.Microsoft.Toolkit.Uwp.Connectivity [![NuGet](https://img.shields.io/nuget/v/Uno.Microsoft.Toolkit.Uwp.Connectivity.svg)](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.Uwp.Connectivity)
51+
- Uno.Microsoft.Toolkit.Uwp.DeveloperTools [![NuGet](https://img.shields.io/nuget/v/Uno.Microsoft.Toolkit.Uwp.DeveloperTools.svg)](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.Uwp.DeveloperTools)
52+
- Uno.Microsoft.Toolkit.Uwp.UI [![NuGet](https://img.shields.io/nuget/v/Uno.Microsoft.Toolkit.Uwp.UI.svg)](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.Uwp.UI)
53+
- Uno.Microsoft.Toolkit.Uwp.UI.Animations [![NuGet](https://img.shields.io/nuget/v/Uno.Microsoft.Toolkit.Uwp.UI.Animations.svg)](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.Uwp.UI.Animations)
54+
- Uno.Microsoft.Toolkit.Uwp.UI.Behaviors [![NuGet](https://img.shields.io/nuget/v/Uno.Microsoft.Toolkit.Uwp.UI.Behaviors.svg)](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.Uwp.UI.Behaviors)
55+
- Uno.Microsoft.Toolkit.Uwp.UI.Controls [![NuGet](https://img.shields.io/nuget/v/Uno.Microsoft.Toolkit.Uwp.UI.Controls.svg)](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.Uwp.UI.Controls)
56+
- Uno.Microsoft.Toolkit.Uwp.UI.Controls.Core [![NuGet](https://img.shields.io/nuget/v/Uno.Microsoft.Toolkit.Uwp.UI.Controls.Core.svg)](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.Uwp.UI.Controls.Core)
57+
- Uno.Microsoft.Toolkit.Uwp.UI.Controls.DataGrid [![NuGet](https://img.shields.io/nuget/v/Uno.Microsoft.Toolkit.Uwp.UI.Controls.DataGrid.svg)](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.Uwp.UI.Controls.DataGrid)
58+
- Uno.Microsoft.Toolkit.Uwp.UI.Controls.Input [![NuGet](https://img.shields.io/nuget/v/Uno.Microsoft.Toolkit.Uwp.UI.Controls.Input.svg)](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.Uwp.UI.Controls.Input)
59+
- Uno.Microsoft.Toolkit.Uwp.UI.Controls.Layout [![NuGet](https://img.shields.io/nuget/v/Uno.Microsoft.Toolkit.Uwp.UI.Controls.Layout.svg)](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.Uwp.UI.Controls.Layout)
60+
- Uno.Microsoft.Toolkit.Uwp.UI.Controls.Markdown [![NuGet](https://img.shields.io/nuget/v/Uno.Microsoft.Toolkit.Uwp.UI.Controls.Markdown.svg)](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.Uwp.UI.Controls.Markdown)
61+
- Uno.Microsoft.Toolkit.Uwp.UI.Controls.Media [![NuGet](https://img.shields.io/nuget/v/Uno.Microsoft.Toolkit.Uwp.UI.Controls.Media.svg)](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.Uwp.UI.Controls.Media)
62+
- Uno.Microsoft.Toolkit.Uwp.UI.Controls.Primitives [![NuGet](https://img.shields.io/nuget/v/Uno.Microsoft.Toolkit.Uwp.UI.Controls.Primitives.svg)](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.Uwp.UI.Controls.Primitives)
63+
- Uno.Microsoft.Toolkit.Uwp.UI.Media [![NuGet](https://img.shields.io/nuget/v/Uno.Microsoft.Toolkit.Uwp.UI.Media.svg)](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.Uwp.UI.Media)
64+
65+
## Using the Uno Platform Windows Community Toolkit packages for UWP
66+
67+
These packages are providing support for the Uno Platform supported targets (iOS, Android, macOS, WebAssembly and Skia GTK/WPF/Tizen).
68+
2869
On Windows projects (the UWP head), please install the official [Windows Community Toolkit packages](https://github.com/Microsoft/WindowsCommunityToolkit).
2970

30-
If you are building for library, use the following to conditionally include the toolkit builds:
71+
If you are building a library, use the following to conditionally include the toolkit builds:
3172

3273
```xml
3374
<ItemGroup Condition="'$(TargetFramework)' == 'uap10.0.17763'">
34-
<PackageReference Include="CommunityToolkit.WinUI.Controls" Version="7.0.0" />
75+
<PackageReference Include="Microsoft.Toolkit.Uwp.Controls" Version="7.1.10" />
3576
</ItemGroup>
3677
<ItemGroup Condition="'$(TargetFramework)' != 'uap10.0.17763'">
37-
<PackageReference Include="Uno.CommunityToolkit.WinUI.Controls" Version="7.0.0" />
78+
<PackageReference Include="Uno.Microsoft.Toolkit.Uwp.Controls" Version="7.1.10" />
3879
</ItemGroup>
39-
```
80+
```

0 commit comments

Comments
 (0)