Skip to content

Commit 201a8fe

Browse files
michael-hawkerArlodotexeniels9001
authored
Add Readmes to each component (#224)
* Add readmes to packages * Added standard readme to each component sample * Sorting items alphabetically * Update components/Collections/src/ReadMe.md * Add PackageReadmeFile directly to csproj files... --------- Co-authored-by: Arlo Godfrey <arlo.godfrey@outlook.com> Co-authored-by: Niels Laute <niels.laute@live.nl>
1 parent 241b30a commit 201a8fe

File tree

44 files changed

+1057
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+1057
-2
lines changed

‎components/Animations/src/CommunityToolkit.WinUI.Animations.csproj‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
<!-- Rns suffix is required for namespaces shared across projects. See https://github.com/CommunityToolkit/Labs-Windows/issues/152 -->
77
<RootNamespace>CommunityToolkit.WinUI.AnimationsRns</RootNamespace>
88
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
9+
<PackageReadmeFile>ReadMe.md</PackageReadmeFile>
910
</PropertyGroup>
1011

1112
<ItemGroup>
@@ -22,6 +23,13 @@
2223
<ProjectReference Include="$(ToolkitExtensionSourceProject)" />
2324
</ItemGroup>
2425

26+
<ItemGroup>
27+
<None Include="ReadMe.md">
28+
<Pack>True</Pack>
29+
<PackagePath>\</PackagePath>
30+
</None>
31+
</ItemGroup>
32+
2533
<!-- Sets this up as a toolkit component's source project -->
2634
<Import Project="$(ToolingDirectory)\ToolkitComponent.SourceProject.props" />
2735
</Project>

‎components/Animations/src/ReadMe.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
2+
# Windows Community Toolkit - Animations
3+
4+
This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org).
5+
6+
## Package Contents
7+
8+
This package contains the following in the `CommunityToolkit.WinUI.Animations` namespace:
9+
10+
- AnimationBuilder
11+
- AnimationSet
12+
- Connected Animations Helpers
13+
- Expressions
14+
- Implicit Animations
15+
- ScrollViewerExtensions
16+
17+
## Which Package is for me?
18+
19+
If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Animations` package.
20+
21+
If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Animations` package.
22+
23+
## Documentation
24+
25+
Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs
26+
27+
## License
28+
29+
MIT
30+
31+
See License.md in package for more details.

‎components/Behaviors/src/CommunityToolkit.WinUI.Behaviors.csproj‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,19 @@
55

66
<!-- Rns suffix is required for namespaces shared across projects. See https://github.com/CommunityToolkit/Labs-Windows/issues/152 -->
77
<RootNamespace>CommunityToolkit.WinUI.BehaviorsRns</RootNamespace>
8+
<PackageReadmeFile>ReadMe.md</PackageReadmeFile>
89
</PropertyGroup>
910

1011
<!-- Sets this up as a toolkit component's source project -->
1112
<Import Project="$(ToolingDirectory)\ToolkitComponent.SourceProject.props" />
1213

14+
<ItemGroup>
15+
<None Include="ReadMe.md">
16+
<Pack>True</Pack>
17+
<PackagePath>\</PackagePath>
18+
</None>
19+
</ItemGroup>
20+
1321
<ItemGroup>
1422
<ProjectReference Include="$(ToolkitAnimationSourceProject)" />
1523
<ProjectReference Include="$(ToolkitExtensionSourceProject)" />

‎components/Behaviors/src/ReadMe.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
2+
# Windows Community Toolkit - Behaviors
3+
4+
This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org).
5+
6+
## Package Contents
7+
8+
This package contains the following in the `CommunityToolkit.WinUI.Behaviors` namespace:
9+
10+
- AnimationCompletedTriggerBehavior
11+
- AnimationStartedTriggerBehavior
12+
- AutoSelectBehavior
13+
- FadeHeaderBehavior
14+
- FocusBehavior
15+
- InvokeActionsActivity
16+
- KeyDownTriggerBehavior
17+
- NavigateToUriAction
18+
- QuickReturnHeaderBehavior
19+
- StartAnimationAction
20+
- StackedNotificationBehavior
21+
- StopAnimationAction
22+
- StickyHeaderBehavior
23+
- ViewportBehavior
24+
25+
## Which Package is for me?
26+
27+
If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Behaviors` package.
28+
29+
If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Behaviors` package.
30+
31+
## Documentation
32+
33+
Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs
34+
35+
## License
36+
37+
MIT
38+
39+
See License.md in package for more details.

‎components/CameraPreview/src/CommunityToolkit.WinUI.Controls.CameraPreview.csproj‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
<!-- Rns suffix is required for namespaces shared across projects. See https://github.com/CommunityToolkit/Labs-Windows/issues/152 -->
77
<RootNamespace>CommunityToolkit.WinUI.Controls.CameraPreviewRns</RootNamespace>
8+
<PackageReadmeFile>ReadMe.md</PackageReadmeFile>
89
</PropertyGroup>
910

1011
<ItemGroup>
@@ -14,6 +15,13 @@
1415
<!-- Sets this up as a toolkit component's source project -->
1516
<Import Project="$(ToolingDirectory)\ToolkitComponent.SourceProject.props" />
1617

18+
<ItemGroup>
19+
<None Include="ReadMe.md">
20+
<Pack>True</Pack>
21+
<PackagePath>\</PackagePath>
22+
</None>
23+
</ItemGroup>
24+
1725
<PropertyGroup>
1826
<PackageId>$(PackageIdPrefix).$(PackageIdVariant).Controls.$(ToolkitComponentName)</PackageId>
1927
</PropertyGroup>

‎components/CameraPreview/src/ReadMe.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
2+
# Windows Community Toolkit - CameraPreview
3+
4+
This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org).
5+
6+
## Package Contents
7+
8+
This package contains the following controls in the `CommunityToolkit.WinUI.Controls` namespace:
9+
10+
- CameraPreview
11+
12+
## Which Package is for me?
13+
14+
If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Controls.CameraPreview` package.
15+
16+
If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Controls.CameraPreview` package.
17+
18+
## WinUI Resources (UWP)
19+
20+
For UWP projects, the WinUI 2 reference requires you include the WinUI XAML Resources in your App.xaml file:
21+
22+
```xml
23+
<Application.Resources>
24+
<XamlControlsResources xmlns="using:Microsoft.UI.Xaml.Controls" />
25+
</Application.Resources>
26+
```
27+
28+
See [Getting Started in WinUI 2](https://learn.microsoft.com/windows/apps/winui/winui2/getting-started) for more information.
29+
30+
## Documentation
31+
32+
Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs
33+
34+
## License
35+
36+
MIT
37+
38+
See License.md in package for more details.

‎components/Collections/src/CommunityToolkit.WinUI.Collections.csproj‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,20 @@
55

66
<!-- Rns suffix is required for namespaces shared across projects. See https://github.com/CommunityToolkit/Labs-Windows/issues/152 -->
77
<RootNamespace>CommunityToolkit.WinUI.CollectionsRns</RootNamespace>
8+
<PackageReadmeFile>ReadMe.md</PackageReadmeFile>
89
</PropertyGroup>
910

1011
<ItemGroup>
1112
<ProjectReference Include="$(ToolkitHelperSourceProject)"/>
1213
</ItemGroup>
1314

15+
<ItemGroup>
16+
<None Include="ReadMe.md">
17+
<Pack>True</Pack>
18+
<PackagePath>\</PackagePath>
19+
</None>
20+
</ItemGroup>
21+
1422
<!-- Sets this up as a toolkit component's source project -->
1523
<Import Project="$(ToolingDirectory)\ToolkitComponent.SourceProject.props" />
1624
</Project>

‎components/Collections/src/ReadMe.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
2+
# Windows Community Toolkit - Collections
3+
4+
This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org).
5+
6+
## Package Contents
7+
8+
This package contains the following in the `CommunityToolkit.WinUI.Collections` namespace:
9+
10+
- AdvancedCollectionView
11+
- IncrementalLoadingCollection
12+
13+
## Which Package is for me?
14+
15+
If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Collections` package.
16+
17+
If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Collections` package.
18+
19+
## Documentation
20+
21+
Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs
22+
23+
## License
24+
25+
MIT
26+
27+
See License.md in package for more details.

‎components/Converters/src/CommunityToolkit.WinUI.Converters.csproj‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,20 @@
55

66
<!-- Rns suffix is required for namespaces shared across projects. See https://github.com/CommunityToolkit/Labs-Windows/issues/152 -->
77
<RootNamespace>CommunityToolkit.WinUI.ConvertersRns</RootNamespace>
8+
<PackageReadmeFile>ReadMe.md</PackageReadmeFile>
89
</PropertyGroup>
910

11+
<ItemGroup>
12+
<None Include="ReadMe.md">
13+
<Pack>True</Pack>
14+
<PackagePath>\</PackagePath>
15+
</None>
16+
</ItemGroup>
17+
1018
<!-- Sets this up as a toolkit component's source project -->
1119
<Import Project="$(ToolingDirectory)\ToolkitComponent.SourceProject.props" />
20+
1221
<ItemGroup>
13-
<PackageReference Include="CommunityToolkit.Common" Version="8.1.0" />
22+
<PackageReference Include="CommunityToolkit.Common" Version="8.2.1" />
1423
</ItemGroup>
1524
</Project>

‎components/Converters/src/ReadMe.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
2+
# Windows Community Toolkit - Converters
3+
4+
This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org).
5+
6+
## Package Contents
7+
8+
This package contains the following converters in the `CommunityToolkit.WinUI.Converters` namespace:
9+
10+
- BoolNegationConverter
11+
- BoolToObjectConverter
12+
- BoolToVisibilityConverter
13+
- CollectionVisibilityConverter
14+
- ColorToDisplayNameConverter
15+
- DoubleToObjectConverter
16+
- DoubleToVisibilityConverter
17+
- EmptyCollectionToObjectConverter
18+
- EmptyObjectToObjectConverter
19+
- EmptyStringToObjectConverter
20+
- FileSizeToFriendlyStringConverter
21+
- IFormattableToStringConverter
22+
- ResourceNameToResourceStringConverter
23+
- StringFormatConverter
24+
- StringVisibilityConverter
25+
- TaskResultConverter
26+
- TypeToObjectConverter
27+
- VisibilityToBoolConverter
28+
29+
## Which Package is for me?
30+
31+
If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Converters` package.
32+
33+
If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Converters` package.
34+
35+
## Documentation
36+
37+
Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs
38+
39+
## License
40+
41+
MIT
42+
43+
See License.md in package for more details.

0 commit comments

Comments
 (0)