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
Copy file name to clipboardExpand all lines: README.md
+9-2Lines changed: 9 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -5,10 +5,17 @@ The Windows Community Toolkit is a collection of helper functions, custom contro
5
5
## Contributing
6
6
Do you want to contribute or update the docs? Read the [contribution guidelines](CONTRIBUTING.md)
7
7
8
+
When opening a PR, start by forking this repository. Then, based on the type of change you're making you'll need to create a new branch from either the `master` or `live` branches:
9
+
10
+
:new::books: For documentation for new features, please base your fork off the master branch.
11
+
12
+
:exclamation: If you have a typo or existing document improvement to an already shipped feature, please base your change off of the [live branch](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs/tree/live). This will allow us to get the change to the published documentation between releases.
13
+
14
+
We will periodically merge updates from the live branch to master to keep master in-sync with the published docs. When we make a new release, we will push master to the live branch in order to publish documentation for new features.
Copy file name to clipboardExpand all lines: docs/.template.md
+10-6Lines changed: 10 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,7 @@ dev_langs:
12
12
<!-- It is recommended to check how the Documentation will look in the sample app, before Merging a PR -->
13
13
14
14
# Title
15
+
15
16
<!-- Describe your control -->
16
17
The [Control Name](API-Link) ...
17
18
<!-- You can get your API link from https://docs.microsoft.com/dotnet/api/?term=Microsoft.Toolkit. Make sure you remove the "?view=uwp-toolkit-x.x.x" from the end and country/region specific keyword like "en-us" of the URL eg: https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.helpers.printhelper -->
@@ -27,6 +28,9 @@ The [Control Name](API-Link) ...
27
28
> Some warning note
28
29
-->
29
30
31
+
> [!div class="nextstepaction"]
32
+
> [Try it in the sample app](uwpct://categoryName?sample=pageName)
33
+
30
34
## Syntax
31
35
32
36
```csharp
@@ -85,10 +89,10 @@ The [Control Name](API-Link) ...
85
89
<!-- Use <example> and <code> tags in C# to create a Propertie/method specific examples. For more info - https://docs.microsoft.com/dotnet/csharp/programming-guide/xmldoc/example -->
86
90
<!-- Optional: Codes to achieve real-world use case with the output. For eg: Check https://docs.microsoft.com/windows/communitytoolkit/animations/animationset#examples -->
87
91
88
-
## Sample Code
92
+
## Sample Project
89
93
90
94
<!-- Link to the sample page in the Windows Community Toolkit Sample App -->
91
-
[control/helper name sample page Source](sample-page-link). You can see this in action in [Windows Community Toolkit Sample App](https://www.microsoft.com/store/apps/9NBLGGH4TLCQ).
95
+
[control/helper name sample page Source](sample-page-link). You can [see this in action](uwpct://CategoryName?sample=pageName) in [Windows Community Toolkit Sample App](http://aka.ms/uwptoolkitapp).
92
96
93
97
## Requirements
94
98
@@ -115,13 +119,13 @@ The [Control Name](API-Link) ...
Copy file name to clipboardExpand all lines: docs/animations/Blur.md
+6-3Lines changed: 6 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,9 @@ dev_langs:
12
12
13
13
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.
14
14
15
+
> [!div class="nextstepaction"]
16
+
> [Try it in the sample app](uwpct://Animations?sample=Blur)
17
+
15
18
## Syntax
16
19
17
20
```xaml
@@ -105,7 +108,7 @@ Await MyUIElement.Blur(value:=5, duration:=2500, delay:=250).StartAsync() ' B
105
108
106
109
## Sample Project
107
110
108
-
[Blur Behavior Sample Page Source](https://github.com/Microsoft/WindowsCommunityToolkit//tree/master/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Blur). You can see this in action in [Windows Community Toolkit Sample App](https://www.microsoft.com/store/apps/9NBLGGH4TLCQ)
111
+
[Blur Behavior Sample Page Source](https://github.com/Microsoft/WindowsCommunityToolkit//tree/master/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Blur). You can [see this in action](uwpct://Animations?sample=Blur) in the [Windows Community Toolkit Sample App](http://aka.ms/uwptoolkitapp).
109
112
110
113
## Requirements
111
114
@@ -120,5 +123,5 @@ Await MyUIElement.Blur(value:=5, duration:=2500, delay:=250).StartAsync() ' B
description: The Connected Animation XAML Attached Properties enable connected animations to be defined in your XAML code
5
5
keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp toolkit, connected animations, animation, coordinated animations
6
+
dev_langs:
7
+
- csharp
8
+
- vb
6
9
---
7
10
8
11
# Connected Animations XAML Attached Properties
@@ -11,11 +14,14 @@ keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp
11
14
12
15
The Connected Animations XAML Attached Properties enable connected animations to be defined directly in your XAML code by simply adding a Key to the element that should animate. There are also attached properties to enable coordinated animations and animations in lists and grids.
13
16
17
+
> [!div class="nextstepaction"]
18
+
> [Try it in the sample app](uwpct://Animations?sample=Connected%20Animations)
@@ -29,6 +35,7 @@ The Connected Animations XAML Attached Properties enable connected animations to
29
35
</DataTemplate>
30
36
</GridView.ItemTemplate>
31
37
</GridView>
38
+
</Page>
32
39
```
33
40
34
41
## Sample Output
@@ -38,40 +45,51 @@ The Connected Animations XAML Attached Properties enable connected animations to
38
45
## XAML Attached Properties
39
46
40
47
### Connected.Key
48
+
41
49
Registers element with the [ConnectedAnimationsService](https://msdn.microsoft.com/library/windows/apps/windows.ui.xaml.media.animation.connectedanimation.aspx). For the animation to work, the same key must be registered on two different pages when navigating
42
50
43
51
### Connected.AnchorElement
52
+
44
53
To enable [coordinated animations](https://docs.microsoft.com/windows/uwp/style/connected-animation#coordinated-animation), use the AnchorElement attached property on the element that should appear alongside the connected animation element by specifying the connected animation element
45
54
46
55
### Connected.ListItemKey
56
+
47
57
Registers a ListView/GridView for connected animations. When navigating from/to a page that is using this property, the connected animation will use the item passed as a **parameter** in the page navigation to select the item in the list that should animated. See *Select List Item to be animated* section below for more details. The *Connected.ListItemElementName* attached property must also be set for the animation to be registered
48
58
49
59
### Connected.ListItemElementName
60
+
50
61
Specifies what named element in the DataTemplate of an item should animate. The Connected.ListItemKey attached property must also be set for the animation to be registered.
51
62
52
63
## Registering elements in code behind
53
64
54
65
In cases where an element has not loaded before the navigation completes, the attached properties are not able to access the element properties to register it for the connected animation. In those case, you can register the element through code behind inside the OnNavigatedTo method. The following extension methods are available:
Unregisters an element (part of a DataTemplate in a list control) from the ConnectedAnimations service
73
90
74
91
## Select List Item to be animated
92
+
75
93
The helper uses the page navigation parameter to decide which list item will be animated during the page navigation. However, in some cases the parameter passed during page navigation is not part of the list. For example, you might be only passing the id of an item as a navigation parameter and not the item itself.
76
94
77
95
In those cases, you can use the **SetListDataItemForNextConnectedAnnimation** extension method before page navigation to specify which item should be animated.
@@ -81,13 +99,22 @@ In those cases, you can use the **SetListDataItemForNextConnectedAnnimation** ex
We need to set the same key for the element to be connected with. Also, You can anchor another element to move along the connected animation path.
111
138
112
139
```xaml
@@ -163,9 +190,9 @@ In this page, you just need to give the same key.
163
190
</StackPanel>
164
191
```
165
192
166
-
## Sample Code
193
+
## Sample Project
167
194
168
-
[Connected Animations sample page source](https://github.com/Microsoft/WindowsCommunityToolkit//tree/master/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Connected%20Animations). You can see this in action in [Windows Community Toolkit Sample App](https://www.microsoft.com/store/apps/9NBLGGH4TLCQ).
195
+
[Connected Animations sample page source](https://github.com/Microsoft/WindowsCommunityToolkit//tree/master/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Connected%20Animations). You can [see this in action](uwpct://Animations?sample=Connected%20Animations) in the [Windows Community Toolkit Sample App](http://aka.ms/uwptoolkitapp).
169
196
170
197
## Requirements
171
198
@@ -180,4 +207,4 @@ In this page, you just need to give the same key.
Copy file name to clipboardExpand all lines: docs/animations/Fade.md
+6-4Lines changed: 6 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,9 @@ dev_langs:
12
12
13
13
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.
14
14
15
+
> [!div class="nextstepaction"]
16
+
> [Try it in the sample app](uwpct://Animations?sample=Fade)
17
+
15
18
## Syntax
16
19
17
20
```xaml
@@ -103,8 +106,7 @@ You can change the way how the animation interpolates between keyframes by defin
103
106
104
107
## Sample Project
105
108
106
-
[FadeBehaviorSamplePageSource](https://github.com/Microsoft/WindowsCommunityToolkit//tree/master/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Fade). You can see this in action in [Windows Community Toolkit Sample App](https://www.microsoft.com/store/apps/9NBLGGH4TLCQ).
107
-
109
+
[FadeBehaviorSamplePageSource](https://github.com/Microsoft/WindowsCommunityToolkit//tree/master/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Fade). You can [see this in action](uwpct://Animations?sample=Fade) in the [Windows Community Toolkit Sample App](http://aka.ms/uwptoolkitapp).
108
110
109
111
## Requirements
110
112
@@ -119,5 +121,5 @@ You can change the way how the animation interpolates between keyframes by defin
Copy file name to clipboardExpand all lines: docs/animations/FadeHeader.md
+5-2Lines changed: 5 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,9 @@ dev_langs:
12
12
13
13
The [FadeHeader](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.animations.behaviors.fadeheaderbehavior) fades a ListView or GridView Header UIElement when the user scrolls. The UIElement fades out to 0 opacity when the edge of the Header reaches the edge of the visible bounds of the ListElement.
14
14
15
+
> [!div class="nextstepaction"]
16
+
> [Try it in the sample app](uwpct://Animations?sample=FadeHeader)
17
+
15
18
## Syntax
16
19
17
20
***Implicit usage***: Automatically detects the Header element by finding the ListViewBase (note: GridView uses ListViewBase)
[FadeHeader Behavior Sample Page Source](https://github.com/Microsoft/WindowsCommunityToolkit//tree/master/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/FadeHeader). You can see this in action in [Windows Community Toolkit Sample App](https://www.microsoft.com/store/apps/9NBLGGH4TLCQ).
86
+
[FadeHeader Behavior Sample Page Source](https://github.com/Microsoft/WindowsCommunityToolkit//tree/master/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/FadeHeader). You can [see this in action](uwpct://Animations?sample=FadeHeader) in the [Windows Community Toolkit Sample App](http://aka.ms/uwptoolkitapp).
0 commit comments