Skip to content

Commit 69d4ee3

Browse files
committed
Added deprecation warnings to outdated docs
1 parent 6caa0ce commit 69d4ee3

File tree

10 files changed

+34
-20
lines changed

10 files changed

+34
-20
lines changed

docs/animations/Blur.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ dev_langs:
1010

1111
# Blur
1212

13+
> [!WARNING]
14+
> This behavior is no longer available in the Windows Community Toolkit. Please use the effects from the `Microsoft.Toolkit.Uwp.UI.Media` package and the helpers such as the [`PipelineVisualFactory`](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.media.PipelineVisualFactory) type.
15+
1316
The [Blur animation](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions.blur) blurs a XAML element by increasing or decreasing pixel size. Blur animation is applied to all the XAML elements in its parent control/panel. Blur animation doesn't affect the functionality of the control.
1417

1518
> [!div class="nextstepaction"]

docs/animations/CompositionAnimations.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp
77

88
# Composition Animations in XAML
99

10+
> [!WARNING]
11+
> These animation types have been updated with some breaking changes, please refer to the docs for the [`AnimationSet`](AnimationSet.md) and [`ImplicitAnimationSet`](ImplicitAnimationSet.md) types. For a comprehensive list of all the available APIs, use the .NET API browser instead.
12+
1013
[Composition animations](https://docs.microsoft.com/windows/uwp/composition/composition-animation) in the universal windows platform provide a powerful and efficient way to run animations in your application UI and have been designed to ensure that your animations run at 60 FPS independent of the UI thread.
1114

1215
These XAML elements enable developer to specify composition animations directly in their XAML code to enable scenarios such as Implicit animations

docs/animations/Fade.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ dev_langs:
1010

1111
# Fade
1212

13+
> [!WARNING]
14+
> This behavior is no longer available in the Windows Community Toolkit. Please use the effects from the `Microsoft.Toolkit.Uwp.UI.Media` package and the helpers such as the [`PipelineVisualFactory`](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.media.PipelineVisualFactory) type.
15+
1316
The [Fade animation](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions.fade) fades objects, in and out, over time. Fade animation is applied to all the XAML elements in its parent control/panel. Fade animation doesn't affect the functionality of the control.
1417

1518
> [!div class="nextstepaction"]

docs/animations/ImplicitAnimations.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp
77

88
# Implicit Composition Animations in XAML
99

10+
> [!WARNING]
11+
> These animation types have been updated with some breaking changes, please refer to the docs for the [`ImplicitAnimationSet`](ImplicitAnimationSet.md) type. For a comprehensive list of all the available APIs, use the .NET API browser instead.
12+
1013
Implicit Animations are Composition Animations that are used to describe how and when animations occur as a response to direct property changes, such as Opacity or Offset. Show and Hide animations describe the animation to be applied to an element when the Visibility is changed, or the element is added/removed to the visual tree.
1114

1215
**Prerequisites** - [Composition Animation in XAML](https://docs.microsoft.com/windows/communitytoolkit/animations/compositionanimations)

docs/animations/Light.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ dev_langs:
1111
# Light
1212

1313
> [!NOTE]
14-
> The Light effect will be removed in a future major release. Please use [XAML lighting](https://docs.microsoft.com/windows/uwp/composition/xaml-lighting) instead.
14+
> The Light effect has been removed from the Windows Community Toolkit. Please use [XAML lighting](https://docs.microsoft.com/windows/uwp/composition/xaml-lighting) instead.
1515
1616
The [Light animation](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions.light) behavior performs a point light (A point source of light that emits light in all directions) in the middle of a given UIElement. You set the distance property of the light to determine how bright the light will be. The closer the light source, the darker the UI element will be.
1717

docs/animations/Offset.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ dev_langs:
1010

1111
# Offset
1212

13+
> [!WARNING]
14+
> This behavior is no longer available in the Windows Community Toolkit. Please refer to the docs for the [`AnimationSet`](AnimationSet.md) and [`ImplicitAnimationSet`](ImplicitAnimationSet.md) types instead.
15+
1316
The [Offset animation](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions.offset) is used to move the control from one place to another. Offset animation is applied to all the XAML elements in its parent control/panel. Offset animation doesn't affect the functionality of the control.
1417

1518
> [!div class="nextstepaction"]

docs/animations/Rotate.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ dev_langs:
1010

1111
# Rotate
1212

13+
> [!WARNING]
14+
> This behavior is no longer available in the Windows Community Toolkit. Please refer to the docs for the [`AnimationSet`](AnimationSet.md) and [`ImplicitAnimationSet`](ImplicitAnimationSet.md) types instead.
15+
1316
The [Rotate animation](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions.rotate) allows users to modify and animate the control's rotation. Rotate animation is applied to all the XAML elements in its parent control/panel. Rotate animation doesn't affect the functionality of the control.
1417

1518
> [!div class="nextstepaction"]

docs/animations/Saturation.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ dev_langs:
1010

1111
# Saturation
1212

13+
> [!WARNING]
14+
> This behavior is no longer available in the Windows Community Toolkit. Please use the effects from the `Microsoft.Toolkit.Uwp.UI.Media` package and the helpers such as the [`PipelineVisualFactory`](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.media.PipelineVisualFactory) type.
15+
1316
The [Saturation animation](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions.saturation) selectively saturates a XAML element. Saturation animation is applied to all the XAML elements in its parent control/panel. Saturation animation doesn't affect the functionality of the control.
1417

1518
> [!div class="nextstepaction"]

docs/animations/Scale.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ dev_langs:
1010

1111
# Scale
1212

13+
> [!WARNING]
14+
> This behavior is no longer available in the Windows Community Toolkit. Please refer to the docs for the [`AnimationSet`](AnimationSet.md) and [`ImplicitAnimationSet`](ImplicitAnimationSet.md) types instead.
15+
1316
The [Scale animation](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions.scale) allows you to change a control's scale by increasing or decreasing the control through animation. Scale animation is applied to all the XAML elements in its parent control/panel. Scale animation doesn't affect the functionality of the control.
1417

1518
> [!div class="nextstepaction"]

docs/toc.md

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -126,22 +126,10 @@
126126
## [AnimationBuilder](animations/AnimationBuilder.md)
127127
## [AnimationSet](animations/AnimationSet.md)
128128
## [ImplicitAnimationSet](animations/ImplicitAnimationSet.md)
129-
## [Blur](animations/Blur.md)
130-
131-
## [Composition Animations](animations/CompositionAnimations.md)
132-
133129
## [Connected Animations](animations/ConnectedAnimations.md)
134130

135131
## [ExpressionBuilder](animations/Expressions.md)
136-
137-
## [Fade](animations/Fade.md)
138-
139132
## [FadeHeader](animations/FadeHeader.md)
140-
141-
## [Implicit Animations](animations/ImplicitAnimations.md)
142-
143-
## [Light](animations/Light.md)
144-
145133
## [Lottie](animations/Lottie.md)
146134

147135
### [Getting Started with Lottie-Windows](animations/lottie-scenarios/getting_started_json.md)
@@ -157,14 +145,7 @@
157145
### [The Asynchronous Play Method](animations/lottie-scenarios/async_play.md)
158146

159147
### [Handling Failure and Down-level](animations/lottie-scenarios/fallback.md)
160-
161-
## [Offset](animations/Offset.md)
162148
## [ItemsReorderAnimation](animations/ItemsReorderAnimation.md)
163-
## [Rotate](animations/Rotate.md)
164-
165-
## [Saturation](animations/Saturation.md)
166-
167-
## [Scale](animations/Scale.md)
168149

169150
# Brushes
170151

@@ -344,6 +325,15 @@
344325

345326
### [ParallaxService](archive/ParallaxService.md)
346327
### [ReorderGridAnimation](animations/ReorderGrid.md)
328+
### [Blur](animations/Blur.md)
329+
### [Composition Animations](animations/CompositionAnimations.md)
330+
### [Fade](animations/Fade.md)
331+
### [Implicit Animations](animations/ImplicitAnimations.md)
332+
### [Light](animations/Light.md)
333+
### [Offset](animations/Offset.md)
334+
### [Rotate](animations/Rotate.md)
335+
### [Saturation](animations/Saturation.md)
336+
### [Scale](animations/Scale.md)
347337
## Controls
348338

349339
### [HamburgerMenu](archive/HamburgerMenu.md)

0 commit comments

Comments
 (0)