From 201a8fe029cf5eb663a0137cde325de50ad958aa Mon Sep 17 00:00:00 2001 From: "Michael Hawker MSFT (XAML Llama)" <24302614+michael-hawker@users.noreply.github.com> Date: Thu, 7 Sep 2023 03:51:41 -0700 Subject: [PATCH] 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 Co-authored-by: Niels Laute --- .../CommunityToolkit.WinUI.Animations.csproj | 8 +++ components/Animations/src/ReadMe.md | 31 ++++++++++ .../CommunityToolkit.WinUI.Behaviors.csproj | 8 +++ components/Behaviors/src/ReadMe.md | 39 ++++++++++++ ...oolkit.WinUI.Controls.CameraPreview.csproj | 8 +++ components/CameraPreview/src/ReadMe.md | 38 ++++++++++++ .../CommunityToolkit.WinUI.Collections.csproj | 8 +++ components/Collections/src/ReadMe.md | 27 ++++++++ .../CommunityToolkit.WinUI.Converters.csproj | 11 +++- components/Converters/src/ReadMe.md | 43 +++++++++++++ ...mmunityToolkit.WinUI.DeveloperTools.csproj | 8 +++ components/DeveloperTools/src/ReadMe.md | 39 ++++++++++++ .../CommunityToolkit.WinUI.Extensions.csproj | 10 ++- components/Extensions/src/ReadMe.md | 55 +++++++++++++++++ ...kit.WinUI.Controls.HeaderedControls.csproj | 8 +++ components/HeaderedControls/src/ReadMe.md | 40 ++++++++++++ .../src/CommunityToolkit.WinUI.Helpers.csproj | 8 +++ components/Helpers/src/ReadMe.md | 31 ++++++++++ ...Toolkit.WinUI.Controls.ImageCropper.csproj | 8 +++ components/ImageCropper/src/ReadMe.md | 38 ++++++++++++ ...nUI.Controls.LayoutTransformControl.csproj | 8 +++ .../LayoutTransformControl/src/ReadMe.md | 38 ++++++++++++ .../src/CommunityToolkit.WinUI.Media.csproj | 8 +++ components/Media/src/ReadMe.md | 61 +++++++++++++++++++ ...lkit.WinUI.Controls.MetadataControl.csproj | 8 +++ components/MetadataControl/src/ReadMe.md | 38 ++++++++++++ ...tyToolkit.WinUI.Controls.Primitives.csproj | 8 +++ components/Primitives/src/ReadMe.md | 45 ++++++++++++++ ...yToolkit.WinUI.Controls.RadialGauge.csproj | 8 +++ components/RadialGauge/src/ReadMe.md | 38 ++++++++++++ ...oolkit.WinUI.Controls.RangeSelector.csproj | 8 +++ components/RangeSelector/src/ReadMe.md | 38 ++++++++++++ ...olkit.WinUI.Controls.RichSuggestBox.csproj | 8 +++ components/RichSuggestBox/src/ReadMe.md | 38 ++++++++++++ ...ityToolkit.WinUI.Controls.Segmented.csproj | 8 +++ components/Segmented/src/ReadMe.md | 38 ++++++++++++ ...kit.WinUI.Controls.SettingsControls.csproj | 8 +++ components/SettingsControls/src/ReadMe.md | 39 ++++++++++++ ...munityToolkit.WinUI.Controls.Sizers.csproj | 8 +++ components/Sizers/src/ReadMe.md | 41 +++++++++++++ ...it.WinUI.Controls.TokenizingTextBox.csproj | 8 +++ components/TokenizingTextBox/src/ReadMe.md | 38 ++++++++++++ .../CommunityToolkit.WinUI.Triggers.csproj | 8 +++ components/Triggers/src/ReadMe.md | 45 ++++++++++++++ 44 files changed, 1057 insertions(+), 2 deletions(-) create mode 100644 components/Animations/src/ReadMe.md create mode 100644 components/Behaviors/src/ReadMe.md create mode 100644 components/CameraPreview/src/ReadMe.md create mode 100644 components/Collections/src/ReadMe.md create mode 100644 components/Converters/src/ReadMe.md create mode 100644 components/DeveloperTools/src/ReadMe.md create mode 100644 components/Extensions/src/ReadMe.md create mode 100644 components/HeaderedControls/src/ReadMe.md create mode 100644 components/Helpers/src/ReadMe.md create mode 100644 components/ImageCropper/src/ReadMe.md create mode 100644 components/LayoutTransformControl/src/ReadMe.md create mode 100644 components/Media/src/ReadMe.md create mode 100644 components/MetadataControl/src/ReadMe.md create mode 100644 components/Primitives/src/ReadMe.md create mode 100644 components/RadialGauge/src/ReadMe.md create mode 100644 components/RangeSelector/src/ReadMe.md create mode 100644 components/RichSuggestBox/src/ReadMe.md create mode 100644 components/Segmented/src/ReadMe.md create mode 100644 components/SettingsControls/src/ReadMe.md create mode 100644 components/Sizers/src/ReadMe.md create mode 100644 components/TokenizingTextBox/src/ReadMe.md create mode 100644 components/Triggers/src/ReadMe.md diff --git a/components/Animations/src/CommunityToolkit.WinUI.Animations.csproj b/components/Animations/src/CommunityToolkit.WinUI.Animations.csproj index ba23950d..a2f7b97c 100644 --- a/components/Animations/src/CommunityToolkit.WinUI.Animations.csproj +++ b/components/Animations/src/CommunityToolkit.WinUI.Animations.csproj @@ -6,6 +6,7 @@ CommunityToolkit.WinUI.AnimationsRns true + ReadMe.md @@ -22,6 +23,13 @@ + + + True + \ + + + diff --git a/components/Animations/src/ReadMe.md b/components/Animations/src/ReadMe.md new file mode 100644 index 00000000..9d9c6e56 --- /dev/null +++ b/components/Animations/src/ReadMe.md @@ -0,0 +1,31 @@ + +# Windows Community Toolkit - Animations + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following in the `CommunityToolkit.WinUI.Animations` namespace: + +- AnimationBuilder +- AnimationSet +- Connected Animations Helpers +- Expressions +- Implicit Animations +- ScrollViewerExtensions + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Animations` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Animations` package. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details. diff --git a/components/Behaviors/src/CommunityToolkit.WinUI.Behaviors.csproj b/components/Behaviors/src/CommunityToolkit.WinUI.Behaviors.csproj index ba1e8334..29806f05 100644 --- a/components/Behaviors/src/CommunityToolkit.WinUI.Behaviors.csproj +++ b/components/Behaviors/src/CommunityToolkit.WinUI.Behaviors.csproj @@ -5,11 +5,19 @@ CommunityToolkit.WinUI.BehaviorsRns + ReadMe.md + + + True + \ + + + diff --git a/components/Behaviors/src/ReadMe.md b/components/Behaviors/src/ReadMe.md new file mode 100644 index 00000000..7a6176b1 --- /dev/null +++ b/components/Behaviors/src/ReadMe.md @@ -0,0 +1,39 @@ + +# Windows Community Toolkit - Behaviors + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following in the `CommunityToolkit.WinUI.Behaviors` namespace: + +- AnimationCompletedTriggerBehavior +- AnimationStartedTriggerBehavior +- AutoSelectBehavior +- FadeHeaderBehavior +- FocusBehavior +- InvokeActionsActivity +- KeyDownTriggerBehavior +- NavigateToUriAction +- QuickReturnHeaderBehavior +- StartAnimationAction +- StackedNotificationBehavior +- StopAnimationAction +- StickyHeaderBehavior +- ViewportBehavior + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Behaviors` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Behaviors` package. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details. diff --git a/components/CameraPreview/src/CommunityToolkit.WinUI.Controls.CameraPreview.csproj b/components/CameraPreview/src/CommunityToolkit.WinUI.Controls.CameraPreview.csproj index 3ba4bffa..3d67e821 100644 --- a/components/CameraPreview/src/CommunityToolkit.WinUI.Controls.CameraPreview.csproj +++ b/components/CameraPreview/src/CommunityToolkit.WinUI.Controls.CameraPreview.csproj @@ -5,6 +5,7 @@ CommunityToolkit.WinUI.Controls.CameraPreviewRns + ReadMe.md @@ -14,6 +15,13 @@ + + + True + \ + + + $(PackageIdPrefix).$(PackageIdVariant).Controls.$(ToolkitComponentName) diff --git a/components/CameraPreview/src/ReadMe.md b/components/CameraPreview/src/ReadMe.md new file mode 100644 index 00000000..edad1eeb --- /dev/null +++ b/components/CameraPreview/src/ReadMe.md @@ -0,0 +1,38 @@ + +# Windows Community Toolkit - CameraPreview + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following controls in the `CommunityToolkit.WinUI.Controls` namespace: + +- CameraPreview + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Controls.CameraPreview` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Controls.CameraPreview` package. + +## WinUI Resources (UWP) + +For UWP projects, the WinUI 2 reference requires you include the WinUI XAML Resources in your App.xaml file: + +```xml + + + +``` + +See [Getting Started in WinUI 2](https://learn.microsoft.com/windows/apps/winui/winui2/getting-started) for more information. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details. diff --git a/components/Collections/src/CommunityToolkit.WinUI.Collections.csproj b/components/Collections/src/CommunityToolkit.WinUI.Collections.csproj index 46ae012f..dc96566b 100644 --- a/components/Collections/src/CommunityToolkit.WinUI.Collections.csproj +++ b/components/Collections/src/CommunityToolkit.WinUI.Collections.csproj @@ -5,12 +5,20 @@ CommunityToolkit.WinUI.CollectionsRns + ReadMe.md + + + True + \ + + + diff --git a/components/Collections/src/ReadMe.md b/components/Collections/src/ReadMe.md new file mode 100644 index 00000000..095d112d --- /dev/null +++ b/components/Collections/src/ReadMe.md @@ -0,0 +1,27 @@ + +# Windows Community Toolkit - Collections + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following in the `CommunityToolkit.WinUI.Collections` namespace: + +- AdvancedCollectionView +- IncrementalLoadingCollection + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Collections` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Collections` package. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details. diff --git a/components/Converters/src/CommunityToolkit.WinUI.Converters.csproj b/components/Converters/src/CommunityToolkit.WinUI.Converters.csproj index fbaef3e6..0f343fb2 100644 --- a/components/Converters/src/CommunityToolkit.WinUI.Converters.csproj +++ b/components/Converters/src/CommunityToolkit.WinUI.Converters.csproj @@ -5,11 +5,20 @@ CommunityToolkit.WinUI.ConvertersRns + ReadMe.md + + + True + \ + + + + - + diff --git a/components/Converters/src/ReadMe.md b/components/Converters/src/ReadMe.md new file mode 100644 index 00000000..e0a2d5ee --- /dev/null +++ b/components/Converters/src/ReadMe.md @@ -0,0 +1,43 @@ + +# Windows Community Toolkit - Converters + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following converters in the `CommunityToolkit.WinUI.Converters` namespace: + +- BoolNegationConverter +- BoolToObjectConverter +- BoolToVisibilityConverter +- CollectionVisibilityConverter +- ColorToDisplayNameConverter +- DoubleToObjectConverter +- DoubleToVisibilityConverter +- EmptyCollectionToObjectConverter +- EmptyObjectToObjectConverter +- EmptyStringToObjectConverter +- FileSizeToFriendlyStringConverter +- IFormattableToStringConverter +- ResourceNameToResourceStringConverter +- StringFormatConverter +- StringVisibilityConverter +- TaskResultConverter +- TypeToObjectConverter +- VisibilityToBoolConverter + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Converters` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Converters` package. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details. diff --git a/components/DeveloperTools/src/CommunityToolkit.WinUI.DeveloperTools.csproj b/components/DeveloperTools/src/CommunityToolkit.WinUI.DeveloperTools.csproj index 95866e1b..53ddef61 100644 --- a/components/DeveloperTools/src/CommunityToolkit.WinUI.DeveloperTools.csproj +++ b/components/DeveloperTools/src/CommunityToolkit.WinUI.DeveloperTools.csproj @@ -5,8 +5,16 @@ CommunityToolkit.WinUI.DeveloperToolsRns + ReadMe.md + + + True + \ + + + diff --git a/components/DeveloperTools/src/ReadMe.md b/components/DeveloperTools/src/ReadMe.md new file mode 100644 index 00000000..9dbbc511 --- /dev/null +++ b/components/DeveloperTools/src/ReadMe.md @@ -0,0 +1,39 @@ + +# Windows Community Toolkit - DeveloperTools + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following controls in the `CommunityToolkit.WinUI.DeveloperTools` namespace: + +- AlignmentGrid +- FocusTracker + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.DeveloperTools` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.DeveloperTools` package. + +## WinUI Resources (UWP) + +For UWP projects, the WinUI 2 reference requires you include the WinUI XAML Resources in your App.xaml file: + +```xml + + + +``` + +See [Getting Started in WinUI 2](https://learn.microsoft.com/windows/apps/winui/winui2/getting-started) for more information. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details. diff --git a/components/Extensions/src/CommunityToolkit.WinUI.Extensions.csproj b/components/Extensions/src/CommunityToolkit.WinUI.Extensions.csproj index 9891b024..44bf4145 100644 --- a/components/Extensions/src/CommunityToolkit.WinUI.Extensions.csproj +++ b/components/Extensions/src/CommunityToolkit.WinUI.Extensions.csproj @@ -6,13 +6,21 @@ CommunityToolkit.WinUI.ExtensionsRns true + ReadMe.md - + + True + \ + + + + + all diff --git a/components/Extensions/src/ReadMe.md b/components/Extensions/src/ReadMe.md new file mode 100644 index 00000000..9e629c24 --- /dev/null +++ b/components/Extensions/src/ReadMe.md @@ -0,0 +1,55 @@ + +# Windows Community Toolkit - Extensions + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following in the `CommunityToolkit.WinUI` namespace: + +- AttachedDropShadow +- AttachedShadowBase +- BitmapIconExtension +- BitmapIconSourceExtension +- DependencyObjectExtensions +- DispatcherQueueExtensions +- DispatcherQueueTimerExtensions +- EnumValuesExtension +- FontIconExtension +- FontIconSourceExtension +- FrameworkElementExtensions +- HyperlinkExtensions +- ListViewExtensions +- MatrixExtensions +- NullableBoolExtension +- OnDeviceExtension +- PointExtensions +- RectExtensions +- RotateTransformExtensions +- ScaleTransformExtensions +- ScrollViewerExtensions +- SizeExtensions +- SkewTransformExtensions +- StringExtensions +- SurfaceDialOptions +- TextBoxExtensions +- TranslateTransformExtensions +- TypedEventHandlerExtensions +- UIElementExtensions +- VisualExtensions + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Extensions` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Extensions` package. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details. diff --git a/components/HeaderedControls/src/CommunityToolkit.WinUI.Controls.HeaderedControls.csproj b/components/HeaderedControls/src/CommunityToolkit.WinUI.Controls.HeaderedControls.csproj index dd63e8ce..5a611917 100644 --- a/components/HeaderedControls/src/CommunityToolkit.WinUI.Controls.HeaderedControls.csproj +++ b/components/HeaderedControls/src/CommunityToolkit.WinUI.Controls.HeaderedControls.csproj @@ -5,11 +5,19 @@ CommunityToolkit.WinUI.Controls.HeaderedControlsRns + ReadMe.md + + + True + \ + + + $(PackageIdPrefix).$(PackageIdVariant).Controls.$(ToolkitComponentName) diff --git a/components/HeaderedControls/src/ReadMe.md b/components/HeaderedControls/src/ReadMe.md new file mode 100644 index 00000000..499ce8b1 --- /dev/null +++ b/components/HeaderedControls/src/ReadMe.md @@ -0,0 +1,40 @@ + +# Windows Community Toolkit - HeaderedControls + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following controls in the `CommunityToolkit.WinUI.Controls` namespace: + +- HeaderedContentControl +- HeaderedItemsControl +- HeaderedTreeView + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Controls.HeaderedControls` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Controls.HeaderedControls` package. + +## WinUI Resources (UWP) + +For UWP projects, the WinUI 2 reference requires you include the WinUI XAML Resources in your App.xaml file: + +```xml + + + +``` + +See [Getting Started in WinUI 2](https://learn.microsoft.com/windows/apps/winui/winui2/getting-started) for more information. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details. diff --git a/components/Helpers/src/CommunityToolkit.WinUI.Helpers.csproj b/components/Helpers/src/CommunityToolkit.WinUI.Helpers.csproj index 53916c9e..9dd3b0be 100644 --- a/components/Helpers/src/CommunityToolkit.WinUI.Helpers.csproj +++ b/components/Helpers/src/CommunityToolkit.WinUI.Helpers.csproj @@ -5,11 +5,19 @@ CommunityToolkit.WinUI.HelpersRns + ReadMe.md + + + + True + \ + + diff --git a/components/Helpers/src/ReadMe.md b/components/Helpers/src/ReadMe.md new file mode 100644 index 00000000..241f010e --- /dev/null +++ b/components/Helpers/src/ReadMe.md @@ -0,0 +1,31 @@ + +# Windows Community Toolkit - Helpers + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following controls in the `CommunityToolkit.WinUI.Helpers` namespace: + +- CameraHelper +- ColorHelper +- CompositionTargetHelper +- NetworkHelper +- ScreenUnitHelper +- WeakEventListener + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Helpers` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Helpers` package. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details. diff --git a/components/ImageCropper/src/CommunityToolkit.WinUI.Controls.ImageCropper.csproj b/components/ImageCropper/src/CommunityToolkit.WinUI.Controls.ImageCropper.csproj index f85e9ca4..c8dcbedf 100644 --- a/components/ImageCropper/src/CommunityToolkit.WinUI.Controls.ImageCropper.csproj +++ b/components/ImageCropper/src/CommunityToolkit.WinUI.Controls.ImageCropper.csproj @@ -5,6 +5,7 @@ CommunityToolkit.WinUI.Controls.ImageCropperRns + ReadMe.md @@ -14,6 +15,13 @@ + + + True + \ + + + $(PackageIdPrefix).$(PackageIdVariant).Controls.$(ToolkitComponentName) diff --git a/components/ImageCropper/src/ReadMe.md b/components/ImageCropper/src/ReadMe.md new file mode 100644 index 00000000..07942198 --- /dev/null +++ b/components/ImageCropper/src/ReadMe.md @@ -0,0 +1,38 @@ + +# Windows Community Toolkit - ImageCropper + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following controls in the `CommunityToolkit.WinUI.Controls` namespace: + +- ImageCropper + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Controls.ImageCropper` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Controls.ImageCropper` package. + +## WinUI Resources (UWP) + +For UWP projects, the WinUI 2 reference requires you include the WinUI XAML Resources in your App.xaml file: + +```xml + + + +``` + +See [Getting Started in WinUI 2](https://learn.microsoft.com/windows/apps/winui/winui2/getting-started) for more information. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details. diff --git a/components/LayoutTransformControl/src/CommunityToolkit.WinUI.Controls.LayoutTransformControl.csproj b/components/LayoutTransformControl/src/CommunityToolkit.WinUI.Controls.LayoutTransformControl.csproj index 5277f8ee..bcc83cc7 100644 --- a/components/LayoutTransformControl/src/CommunityToolkit.WinUI.Controls.LayoutTransformControl.csproj +++ b/components/LayoutTransformControl/src/CommunityToolkit.WinUI.Controls.LayoutTransformControl.csproj @@ -5,6 +5,7 @@ CommunityToolkit.WinUI.Controls.LayoutTransformControlRns + ReadMe.md @@ -14,6 +15,13 @@ + + + True + \ + + + $(PackageIdPrefix).$(PackageIdVariant).Controls.$(ToolkitComponentName) diff --git a/components/LayoutTransformControl/src/ReadMe.md b/components/LayoutTransformControl/src/ReadMe.md new file mode 100644 index 00000000..b766ca90 --- /dev/null +++ b/components/LayoutTransformControl/src/ReadMe.md @@ -0,0 +1,38 @@ + +# Windows Community Toolkit - LayoutTransformControl + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following controls in the `CommunityToolkit.WinUI.Controls` namespace: + +- LayoutTransformControl + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Controls.LayoutTransformControl` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Controls.LayoutTransformControl` package. + +## WinUI Resources (UWP) + +For UWP projects, the WinUI 2 reference requires you include the WinUI XAML Resources in your App.xaml file: + +```xml + + + +``` + +See [Getting Started in WinUI 2](https://learn.microsoft.com/windows/apps/winui/winui2/getting-started) for more information. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details. diff --git a/components/Media/src/CommunityToolkit.WinUI.Media.csproj b/components/Media/src/CommunityToolkit.WinUI.Media.csproj index ac0892cf..219132e1 100644 --- a/components/Media/src/CommunityToolkit.WinUI.Media.csproj +++ b/components/Media/src/CommunityToolkit.WinUI.Media.csproj @@ -5,11 +5,19 @@ CommunityToolkit.WinUI.MediaRns + ReadMe.md + + + True + \ + + + diff --git a/components/Media/src/ReadMe.md b/components/Media/src/ReadMe.md new file mode 100644 index 00000000..ffda77d2 --- /dev/null +++ b/components/Media/src/ReadMe.md @@ -0,0 +1,61 @@ + +# Windows Community Toolkit - Media + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following in the `CommunityToolkit.WinUI.Media` namespace: + +- AcrylicBrush +- AttachedCardShadow +- BackdropBlurBrush +- BackdropGammaTransferBrush +- BackdropInvertBrush +- BackdropSaturationBrush +- BackdropSepiaBrush +- BlendEffect +- BlurEffect +- BlurEffectAnimation +- CanvasBlurBrush +- ColorEffectAnimation +- CrossFadeEffect +- CrossFadeEffectAnimation +- ExposureEffect +- ExposureEffectAnimation +- GrayscaleEffect +- HueRotationEffect +- HueRotationEffectAnimation +- ImageBlendBrush +- InvertEffect +- LuminanceToAlphaEffect +- OpacityEffect +- OpacityEffectAnimation +- PipelineBuilder +- PipelineVisualFactory +- SaturationEffect +- SaturationEffectAnimation +- SepiaEffect +- SepiaEffectAnimation +- ShadeEffect +- SurfaceLoader +- TemperatureAndTintEffect +- TilesBrush +- TintEffect +- XamlCompositionBrush + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Media` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Media` package. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details. diff --git a/components/MetadataControl/src/CommunityToolkit.WinUI.Controls.MetadataControl.csproj b/components/MetadataControl/src/CommunityToolkit.WinUI.Controls.MetadataControl.csproj index 602b8aa3..be69e426 100644 --- a/components/MetadataControl/src/CommunityToolkit.WinUI.Controls.MetadataControl.csproj +++ b/components/MetadataControl/src/CommunityToolkit.WinUI.Controls.MetadataControl.csproj @@ -5,11 +5,19 @@ CommunityToolkit.WinUI.Controls.MetadataControlRns + ReadMe.md + + + True + \ + + + $(PackageIdPrefix).$(PackageIdVariant).Controls.$(ToolkitComponentName) diff --git a/components/MetadataControl/src/ReadMe.md b/components/MetadataControl/src/ReadMe.md new file mode 100644 index 00000000..a4b513ed --- /dev/null +++ b/components/MetadataControl/src/ReadMe.md @@ -0,0 +1,38 @@ + +# Windows Community Toolkit - MetadataControl + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following controls in the `CommunityToolkit.WinUI.Controls` namespace: + +- MetadataControl + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Controls.MetadataControl` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Controls.MetadataControl` package. + +## WinUI Resources (UWP) + +For UWP projects, the WinUI 2 reference requires you include the WinUI XAML Resources in your App.xaml file: + +```xml + + + +``` + +See [Getting Started in WinUI 2](https://learn.microsoft.com/windows/apps/winui/winui2/getting-started) for more information. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details. diff --git a/components/Primitives/src/CommunityToolkit.WinUI.Controls.Primitives.csproj b/components/Primitives/src/CommunityToolkit.WinUI.Controls.Primitives.csproj index be91a84b..6ccdcaa9 100644 --- a/components/Primitives/src/CommunityToolkit.WinUI.Controls.Primitives.csproj +++ b/components/Primitives/src/CommunityToolkit.WinUI.Controls.Primitives.csproj @@ -5,6 +5,7 @@ CommunityToolkit.WinUI.Controls.PrimitivesRns + ReadMe.md @@ -14,6 +15,13 @@ + + + True + \ + + + $(PackageIdPrefix).$(PackageIdVariant).Controls.$(ToolkitComponentName) diff --git a/components/Primitives/src/ReadMe.md b/components/Primitives/src/ReadMe.md new file mode 100644 index 00000000..b8aafe28 --- /dev/null +++ b/components/Primitives/src/ReadMe.md @@ -0,0 +1,45 @@ + +# Windows Community Toolkit - Primitives + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following controls in the `CommunityToolkit.WinUI.Controls` namespace: + +- ConstrainedBox +- DockPanel +- StaggeredLayout +- StaggeredPanel +- SwitchPresenter +- UniformGrid +- WrapLayout +- WrapPanel + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Controls.Primitives` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Controls.Primitives` package. + +## WinUI Resources (UWP) + +For UWP projects, the WinUI 2 reference requires you include the WinUI XAML Resources in your App.xaml file: + +```xml + + + +``` + +See [Getting Started in WinUI 2](https://learn.microsoft.com/windows/apps/winui/winui2/getting-started) for more information. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details. diff --git a/components/RadialGauge/src/CommunityToolkit.WinUI.Controls.RadialGauge.csproj b/components/RadialGauge/src/CommunityToolkit.WinUI.Controls.RadialGauge.csproj index 3bf1671a..5f8dc680 100644 --- a/components/RadialGauge/src/CommunityToolkit.WinUI.Controls.RadialGauge.csproj +++ b/components/RadialGauge/src/CommunityToolkit.WinUI.Controls.RadialGauge.csproj @@ -5,6 +5,7 @@ CommunityToolkit.WinUI.Controls.RadialGaugeRns + ReadMe.md @@ -15,6 +16,13 @@ + + + True + \ + + + $(PackageIdPrefix).$(PackageIdVariant).Controls.$(ToolkitComponentName) diff --git a/components/RadialGauge/src/ReadMe.md b/components/RadialGauge/src/ReadMe.md new file mode 100644 index 00000000..3587bb54 --- /dev/null +++ b/components/RadialGauge/src/ReadMe.md @@ -0,0 +1,38 @@ + +# Windows Community Toolkit - RadialGauge + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following controls in the `CommunityToolkit.WinUI.Controls` namespace: + +- RadialGauge + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Controls.RadialGauge` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Controls.RadialGauge` package. + +## WinUI Resources (UWP) + +For UWP projects, the WinUI 2 reference requires you include the WinUI XAML Resources in your App.xaml file: + +```xml + + + +``` + +See [Getting Started in WinUI 2](https://learn.microsoft.com/windows/apps/winui/winui2/getting-started) for more information. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details. diff --git a/components/RangeSelector/src/CommunityToolkit.WinUI.Controls.RangeSelector.csproj b/components/RangeSelector/src/CommunityToolkit.WinUI.Controls.RangeSelector.csproj index 8c05ebcd..5f0eeb98 100644 --- a/components/RangeSelector/src/CommunityToolkit.WinUI.Controls.RangeSelector.csproj +++ b/components/RangeSelector/src/CommunityToolkit.WinUI.Controls.RangeSelector.csproj @@ -5,6 +5,7 @@ CommunityToolkit.WinUI.Controls.RangeSelectorRns + ReadMe.md @@ -14,6 +15,13 @@ + + + True + \ + + + $(PackageIdPrefix).$(PackageIdVariant).Controls.$(ToolkitComponentName) diff --git a/components/RangeSelector/src/ReadMe.md b/components/RangeSelector/src/ReadMe.md new file mode 100644 index 00000000..2b016327 --- /dev/null +++ b/components/RangeSelector/src/ReadMe.md @@ -0,0 +1,38 @@ + +# Windows Community Toolkit - RangeSelector + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following controls in the `CommunityToolkit.WinUI.Controls` namespace: + +- RangeSelector + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Controls.RangeSelector` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Controls.RangeSelector` package. + +## WinUI Resources (UWP) + +For UWP projects, the WinUI 2 reference requires you include the WinUI XAML Resources in your App.xaml file: + +```xml + + + +``` + +See [Getting Started in WinUI 2](https://learn.microsoft.com/windows/apps/winui/winui2/getting-started) for more information. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details. diff --git a/components/RichSuggestBox/src/CommunityToolkit.WinUI.Controls.RichSuggestBox.csproj b/components/RichSuggestBox/src/CommunityToolkit.WinUI.Controls.RichSuggestBox.csproj index 8e697f0c..7459ba25 100644 --- a/components/RichSuggestBox/src/CommunityToolkit.WinUI.Controls.RichSuggestBox.csproj +++ b/components/RichSuggestBox/src/CommunityToolkit.WinUI.Controls.RichSuggestBox.csproj @@ -5,6 +5,7 @@ CommunityToolkit.WinUI.Controls.RichSuggestBoxRns + ReadMe.md @@ -14,6 +15,13 @@ + + + True + \ + + + $(PackageIdPrefix).$(PackageIdVariant).Controls.$(ToolkitComponentName) diff --git a/components/RichSuggestBox/src/ReadMe.md b/components/RichSuggestBox/src/ReadMe.md new file mode 100644 index 00000000..73fdb899 --- /dev/null +++ b/components/RichSuggestBox/src/ReadMe.md @@ -0,0 +1,38 @@ + +# Windows Community Toolkit - RichSuggestBox + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following controls in the `CommunityToolkit.WinUI.Controls` namespace: + +- RichSuggestBox + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Controls.RichSuggestBox` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Controls.RichSuggestBox` package. + +## WinUI Resources (UWP) + +For UWP projects, the WinUI 2 reference requires you include the WinUI XAML Resources in your App.xaml file: + +```xml + + + +``` + +See [Getting Started in WinUI 2](https://learn.microsoft.com/windows/apps/winui/winui2/getting-started) for more information. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details. diff --git a/components/Segmented/src/CommunityToolkit.WinUI.Controls.Segmented.csproj b/components/Segmented/src/CommunityToolkit.WinUI.Controls.Segmented.csproj index 5cc12018..bb36cade 100644 --- a/components/Segmented/src/CommunityToolkit.WinUI.Controls.Segmented.csproj +++ b/components/Segmented/src/CommunityToolkit.WinUI.Controls.Segmented.csproj @@ -5,6 +5,7 @@ CommunityToolkit.WinUI.Controls.SegmentedRns + ReadMe.md @@ -14,6 +15,13 @@ + + + True + \ + + + $(PackageIdPrefix).$(PackageIdVariant).Controls.$(ToolkitComponentName) diff --git a/components/Segmented/src/ReadMe.md b/components/Segmented/src/ReadMe.md new file mode 100644 index 00000000..326aad66 --- /dev/null +++ b/components/Segmented/src/ReadMe.md @@ -0,0 +1,38 @@ + +# Windows Community Toolkit - Segmented + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following controls in the `CommunityToolkit.WinUI.Controls` namespace: + +- Segmented + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Controls.Segmented` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Controls.Segmented` package. + +## WinUI Resources (UWP) + +For UWP projects, the WinUI 2 reference requires you include the WinUI XAML Resources in your App.xaml file: + +```xml + + + +``` + +See [Getting Started in WinUI 2](https://learn.microsoft.com/windows/apps/winui/winui2/getting-started) for more information. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details. diff --git a/components/SettingsControls/src/CommunityToolkit.WinUI.Controls.SettingsControls.csproj b/components/SettingsControls/src/CommunityToolkit.WinUI.Controls.SettingsControls.csproj index f93a2340..8a420fac 100644 --- a/components/SettingsControls/src/CommunityToolkit.WinUI.Controls.SettingsControls.csproj +++ b/components/SettingsControls/src/CommunityToolkit.WinUI.Controls.SettingsControls.csproj @@ -5,11 +5,19 @@ CommunityToolkit.WinUI.Controls.SettingsControlsRns + ReadMe.md + + + True + \ + + + diff --git a/components/SettingsControls/src/ReadMe.md b/components/SettingsControls/src/ReadMe.md new file mode 100644 index 00000000..a12ae1fa --- /dev/null +++ b/components/SettingsControls/src/ReadMe.md @@ -0,0 +1,39 @@ + +# Windows Community Toolkit - SettingsControls + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following controls in the `CommunityToolkit.WinUI.Controls` namespace: + +- SettingsCard +- SettingsExpander + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Controls.SettingsControls` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Controls.SettingsControls` package. + +## WinUI Resources (UWP) + +For UWP projects, the WinUI 2 reference requires you include the WinUI XAML Resources in your App.xaml file: + +```xml + + + +``` + +See [Getting Started in WinUI 2](https://learn.microsoft.com/windows/apps/winui/winui2/getting-started) for more information. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details. diff --git a/components/Sizers/src/CommunityToolkit.WinUI.Controls.Sizers.csproj b/components/Sizers/src/CommunityToolkit.WinUI.Controls.Sizers.csproj index f519d94b..0817ab02 100644 --- a/components/Sizers/src/CommunityToolkit.WinUI.Controls.Sizers.csproj +++ b/components/Sizers/src/CommunityToolkit.WinUI.Controls.Sizers.csproj @@ -5,11 +5,19 @@ CommunityToolkit.WinUI.Controls.SizersRns + ReadMe.md + + + True + \ + + + diff --git a/components/Sizers/src/ReadMe.md b/components/Sizers/src/ReadMe.md new file mode 100644 index 00000000..b81e9e6a --- /dev/null +++ b/components/Sizers/src/ReadMe.md @@ -0,0 +1,41 @@ + +# Windows Community Toolkit - Sizers + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following controls in the `CommunityToolkit.WinUI.Controls` namespace: + +- ContentSizer +- GridSplitter +- PropertySizer +- SizerBase + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Controls.Sizers` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Controls.Sizers` package. + +## WinUI Resources (UWP) + +For UWP projects, the WinUI 2 reference requires you include the WinUI XAML Resources in your App.xaml file: + +```xml + + + +``` + +See [Getting Started in WinUI 2](https://learn.microsoft.com/windows/apps/winui/winui2/getting-started) for more information. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details. diff --git a/components/TokenizingTextBox/src/CommunityToolkit.WinUI.Controls.TokenizingTextBox.csproj b/components/TokenizingTextBox/src/CommunityToolkit.WinUI.Controls.TokenizingTextBox.csproj index 36aa368b..afb4148f 100644 --- a/components/TokenizingTextBox/src/CommunityToolkit.WinUI.Controls.TokenizingTextBox.csproj +++ b/components/TokenizingTextBox/src/CommunityToolkit.WinUI.Controls.TokenizingTextBox.csproj @@ -5,6 +5,7 @@ CommunityToolkit.WinUI.Controls.TokenizingTextBoxRns + ReadMe.md @@ -16,6 +17,13 @@ + + + True + \ + + + $(PackageIdPrefix).$(PackageIdVariant).Controls.$(ToolkitComponentName) diff --git a/components/TokenizingTextBox/src/ReadMe.md b/components/TokenizingTextBox/src/ReadMe.md new file mode 100644 index 00000000..31441bd2 --- /dev/null +++ b/components/TokenizingTextBox/src/ReadMe.md @@ -0,0 +1,38 @@ + +# Windows Community Toolkit - TokenizingTextBox + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following controls in the `CommunityToolkit.WinUI.Controls` namespace: + +- TokenizingTextBox + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Controls.TokenizingTextBox` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Controls.TokenizingTextBox` package. + +## WinUI Resources (UWP) + +For UWP projects, the WinUI 2 reference requires you include the WinUI XAML Resources in your App.xaml file: + +```xml + + + +``` + +See [Getting Started in WinUI 2](https://learn.microsoft.com/windows/apps/winui/winui2/getting-started) for more information. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details. diff --git a/components/Triggers/src/CommunityToolkit.WinUI.Triggers.csproj b/components/Triggers/src/CommunityToolkit.WinUI.Triggers.csproj index 32d1aff8..6c8bd884 100644 --- a/components/Triggers/src/CommunityToolkit.WinUI.Triggers.csproj +++ b/components/Triggers/src/CommunityToolkit.WinUI.Triggers.csproj @@ -5,6 +5,7 @@ CommunityToolkit.WinUI.TriggersRns + ReadMe.md @@ -14,6 +15,13 @@ + + + True + \ + + + $(PackageIdPrefix).$(PackageIdVariant).$(ToolkitComponentName) diff --git a/components/Triggers/src/ReadMe.md b/components/Triggers/src/ReadMe.md new file mode 100644 index 00000000..0a5d20cc --- /dev/null +++ b/components/Triggers/src/ReadMe.md @@ -0,0 +1,45 @@ + +# Windows Community Toolkit - Triggers + +This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org). + +## Package Contents + +This package contains the following triggers in the `CommunityToolkit.WinUI` namespace: + +- CompareStateTrigger +- ControlSizeTrigger +- IsEqualStateTrigger +- IsNotEqualStateTrigger +- IsNullOrEmptyStateTrigger +- NetworkConnectionStateTrigger +- RegexStateTrigger +- UserHandPreferenceStateTrigger + +## Which Package is for me? + +If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Triggers` package. + +If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Triggers` package. + +## WinUI Resources (UWP) + +For UWP projects, the WinUI 2 reference requires you include the WinUI XAML Resources in your App.xaml file: + +```xml + + + +``` + +See [Getting Started in WinUI 2](https://learn.microsoft.com/windows/apps/winui/winui2/getting-started) for more information. + +## Documentation + +Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs + +## License + +MIT + +See License.md in package for more details.