Skip to content

Commit c3ca4d8

Browse files
Merge pull request #274 from MicrosoftDocs/mhawker/live-update-6.0
Update docs from master for 6.0.0 Release
2 parents e535f61 + d9d8092 commit c3ca4d8

File tree

125 files changed

+2113
-952
lines changed

Some content is hidden

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

125 files changed

+2113
-952
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,17 @@ The Windows Community Toolkit is a collection of helper functions, custom contro
55
## Contributing
66
Do you want to contribute or update the docs? Read the [contribution guidelines](CONTRIBUTING.md)
77

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.
815

916
## Documentation Links
10-
- [Staging review](https://review.docs.microsoft.com/en-us/windows/uwpcommunitytoolkit/?branch=master)
11-
- [Live site](https://docs.microsoft.com/en-us/windows/uwpcommunitytoolkit)
17+
- [Staging review from 'master' branch](https://review.docs.microsoft.com/en-us/windows/uwpcommunitytoolkit/?branch=master)
18+
- [Live site from 'live' branch](https://docs.microsoft.com/en-us/windows/uwpcommunitytoolkit)
1219

1320
## Microsoft Open Source Code of Conduct
1421
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).

docs/.template.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ dev_langs:
1212
<!-- It is recommended to check how the Documentation will look in the sample app, before Merging a PR -->
1313

1414
# Title
15+
1516
<!-- Describe your control -->
1617
The [Control Name](API-Link) ...
1718
<!-- 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) ...
2728
> Some warning note
2829
-->
2930

31+
> [!div class="nextstepaction"]
32+
> [Try it in the sample app](uwpct://categoryName?sample=pageName)
33+
3034
## Syntax
3135

3236
```csharp
@@ -85,10 +89,10 @@ The [Control Name](API-Link) ...
8589
<!-- 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 -->
8690
<!-- Optional: Codes to achieve real-world use case with the output. For eg: Check https://docs.microsoft.com/windows/communitytoolkit/animations/animationset#examples -->
8791

88-
## Sample Code
92+
## Sample Project
8993

9094
<!-- 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).
9296

9397
## Requirements
9498

@@ -115,13 +119,13 @@ The [Control Name](API-Link) ...
115119
[Microsoft.Toolkit.Uwp.DeveloperTools](https://www.nuget.org/packages/Microsoft.Toolkit.Uwp.DeveloperTools/)
116120
-->
117121

118-
## API Source Code
122+
## API
119123

120-
- [control/helper name source code](source-code-link)
124+
* [control/helper name source code](source-code-link)
121125

122126
## Related Topics
123127

124128
<!-- Optional -->
125129

126-
- [Topic 1](link)
127-
- [Topic 2](link)
130+
* [Topic 1](link)
131+
* [Topic 2](link)

docs/animations/AnimationSet.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,6 @@ You can change the way how the animation interpolates between keyframes by defin
182182
183183
## Related
184184

185-
- [ ClAnimationSetCompletedEventArgsass](hTopicsttps://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationsetcompletedeventargs)
185+
- [AnimationSetCompletedEventArgs](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationsetcompletedeventargs)
186186
187-
- [ Class](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions)
188-
AnimationExtensions
187+
- [AnimationExtensions](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.animations.animationextensions)

docs/animations/Blur.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ dev_langs:
1212

1313
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.
1414

15+
> [!div class="nextstepaction"]
16+
> [Try it in the sample app](uwpct://Animations?sample=Blur)
17+
1518
## Syntax
1619

1720
```xaml
@@ -105,7 +108,7 @@ Await MyUIElement.Blur(value:=5, duration:=2500, delay:=250).StartAsync() ' B
105108

106109
## Sample Project
107110

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).
109112

110113
## Requirements
111114

@@ -120,5 +123,5 @@ Await MyUIElement.Blur(value:=5, duration:=2500, delay:=250).StartAsync() ' B
120123

121124
## Related Topics
122125

123-
- [AnimationSet Class](https://docs.microsoft.com/windows/communitytoolkit/animations/animationset)
124-
- [CompositionEffectBrush Class](https://docs.microsoft.com/uwp/api/Windows.UI.Composition.CompositionEffectBrush)
126+
* [AnimationSet Class](https://docs.microsoft.com/windows/communitytoolkit/animations/animationset)
127+
* [CompositionEffectBrush Class](https://docs.microsoft.com/uwp/api/Windows.UI.Composition.CompositionEffectBrush)

docs/animations/ConnectedAnimations.md

Lines changed: 36 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ title: Connected Animations XAML Attached Properties
33
author: nmetulev
44
description: The Connected Animation XAML Attached Properties enable connected animations to be defined in your XAML code
55
keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp toolkit, connected animations, animation, coordinated animations
6+
dev_langs:
7+
- csharp
8+
- vb
69
---
710

811
# Connected Animations XAML Attached Properties
@@ -11,11 +14,14 @@ keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp
1114

1215
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.
1316

17+
> [!div class="nextstepaction"]
18+
> [Try it in the sample app](uwpct://Animations?sample=Connected%20Animations)
19+
1420
## Syntax
1521

1622
```xaml
1723
<Page ...
18-
xmlns:animations="using:Microsoft.Toolkit.Uwp.UI.Animations"/>
24+
xmlns:animations="using:Microsoft.Toolkit.Uwp.UI.Animations">
1925

2026
<Border x:Name="Element" animations:Connected.Key="item"></Border>
2127

@@ -29,6 +35,7 @@ The Connected Animations XAML Attached Properties enable connected animations to
2935
</DataTemplate>
3036
</GridView.ItemTemplate>
3137
</GridView>
38+
</Page>
3239
```
3340

3441
## Sample Output
@@ -38,40 +45,51 @@ The Connected Animations XAML Attached Properties enable connected animations to
3845
## XAML Attached Properties
3946

4047
### Connected.Key
48+
4149
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
4250

4351
### Connected.AnchorElement
52+
4453
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
4554

4655
### Connected.ListItemKey
56+
4757
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
4858

4959
### Connected.ListItemElementName
60+
5061
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.
5162

5263
## Registering elements in code behind
5364

5465
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:
5566

5667
### RegisterElementForConnectedAnimation(this Page page, string key, UIElement element, IEnumerable<UIElement> anchors = null)
68+
5769
Registers a UIElement with the ConnectedAnimations service to run automatically on page navigation
5870

5971
### UnregisterElementForConnectedAnimation(this Page page, string key)
72+
6073
Unregisters a UIElement from the ConnectedAnimations service
6174

6275
### AttachAnchorElementForConnectedAnimation(this Page page, UIElement element, UIElement anchor)
76+
6377
Add an anchor element to animate alongside the main element
6478

6579
### RemoveAnchoredElementForConnectedAnimation(this Page page, UIElement element, UIElement anchor)
80+
6681
Remove an anchor element from animating alongside the main element
6782

6883
### RegisterListItemForConnectedAnimation(this Page page, ListViewBase listViewBase, string key, string elementName)
84+
6985
Registers an element (part of a DataTemplate in a list control) with the ConnectedAnimations service to run automatically on page navigation
7086

7187
### UnregisterListItemForConnectedAnimation(this Page page, ListViewBase listViewBase, string key)
88+
7289
Unregisters an element (part of a DataTemplate in a list control) from the ConnectedAnimations service
7390

7491
## Select List Item to be animated
92+
7593
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.
7694

7795
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
8199
Frame.SetListDataItemForNextConnectedAnnimation(dataItemToAnimate);
82100
Frame.Navigate(typeof(DetailsPage), dataItemToAnimate.Id);
83101
```
102+
```vb
103+
' dataItemToAnimate is an object in the ListViewBase.ItemsSource collection
104+
Frame.SetListDataItemForNextConnectedAnnimation(dataItemToAnimate)
105+
Frame.Navigate(GetType(DetailsPage), dataItemToAnimate.Id)
106+
```
84107

85-
This method is also helpful when navigating back to an item different from the item it was navigated from.
108+
This method is also helpful when navigating back to an item different from the item it was navigated from.
86109

87110
```csharp
88111
Frame.SetListDataItemForNextConnectedAnnimation(dataItemToAnimate);
89112
Frame.GoBack();
90113
```
114+
```vb
115+
Frame.SetListDataItemForNextConnectedAnnimation(dataItemToAnimate)
116+
Frame.GoBack()
117+
```
91118

92119
## Examples
93120

@@ -99,14 +126,14 @@ We need a set a key for the element to be connected with another element in a di
99126

100127
```xaml
101128
<Grid>
102-
<Border Height="100" Width="100" Background="Purple"
103-
VerticalAlignment="Center" HorizontalAlignment="Center"
104-
animations:Connected.Key="item"/>
129+
<Border Height="100" Width="100" Background="Purple"
130+
VerticalAlignment="Center" HorizontalAlignment="Center"
131+
animations:Connected.Key="item" />
105132
</Grid>
106133
```
107134

108135
**In second page**
109-
136+
110137
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.
111138

112139
```xaml
@@ -163,9 +190,9 @@ In this page, you just need to give the same key.
163190
</StackPanel>
164191
```
165192

166-
## Sample Code
193+
## Sample Project
167194

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).
169196

170197
## Requirements
171198

@@ -180,4 +207,4 @@ In this page, you just need to give the same key.
180207

181208
## Related Topics
182209

183-
- [ConnectedAnimationService Class](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Media.Animation.ConnectedAnimationService)
210+
* [ConnectedAnimationService Class](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Media.Animation.ConnectedAnimationService)

docs/animations/Fade.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ dev_langs:
1212

1313
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.
1414

15+
> [!div class="nextstepaction"]
16+
> [Try it in the sample app](uwpct://Animations?sample=Fade)
17+
1518
## Syntax
1619

1720
```xaml
@@ -103,8 +106,7 @@ You can change the way how the animation interpolates between keyframes by defin
103106

104107
## Sample Project
105108

106-
[Fade Behavior Sample Page Source](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+
[Fade Behavior Sample Page Source](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).
108110
109111
## Requirements
110112

@@ -119,5 +121,5 @@ You can change the way how the animation interpolates between keyframes by defin
119121
120122
## Related Topics
121123

122-
- [AnimationSet Class](https://docs.microsoft.com/windows/communitytoolkit/animations/animationset)
123-
- [Storyboard Class](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Media.Animation.Storyboard)
124+
* [AnimationSet Class](https://docs.microsoft.com/windows/communitytoolkit/animations/animationset)
125+
* [Storyboard Class](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Media.Animation.Storyboard)

docs/animations/FadeHeader.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ dev_langs:
1212

1313
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.
1414

15+
> [!div class="nextstepaction"]
16+
> [Try it in the sample app](uwpct://Animations?sample=FadeHeader)
17+
1518
## Syntax
1619

1720
***Implicit usage***: Automatically detects the Header element by finding the ListViewBase (note: GridView uses ListViewBase)
@@ -80,7 +83,7 @@ Microsoft.Xaml.Interactivity.Interaction.GetBehaviors(MyListView).Add(New FadeHe
8083

8184
## Sample Project
8285

83-
[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).
8487

8588
## Requirements
8689

@@ -95,4 +98,4 @@ Microsoft.Xaml.Interactivity.Interaction.GetBehaviors(MyListView).Add(New FadeHe
9598

9699
## Related Topics
97100

98-
- [ListViewBase Header](https://docs.microsoft.com/uwp/api/windows.ui.xaml.controls.listviewbase#Windows_UI_Xaml_Controls_ListViewBase_Header)
101+
* [ListViewBase Header](https://docs.microsoft.com/uwp/api/windows.ui.xaml.controls.listviewbase#Windows_UI_Xaml_Controls_ListViewBase_Header)

0 commit comments

Comments
 (0)