Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: MD009 trailing whitespace #462

Merged
merged 2 commits into from
Mar 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .markdownlint.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
{
"default": true,
"MD009": false,
"MD013": false,
"MD024": false,
"MD025": {
Expand Down
8 changes: 4 additions & 4 deletions docs/Getting-Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,16 @@ The toolkit is available as NuGet packages that can be added to any existing or

* In your C# page, add the namespaces to the toolkit:

```csharp
```csharp
using Microsoft.Toolkit.Uwp;
```

5. You can copy and paste code snippets for each feature from the [Windows Community Toolkit Sample App](https://aka.ms/uwptoolkitapp).
5. You can copy and paste code snippets for each feature from the [Windows Community Toolkit Sample App](https://aka.ms/uwptoolkitapp).

## Other Resources
## Other Resources

Download the [Windows Community Toolkit Sample App](https://aka.ms/uwptoolkitapp) from the Windows store to see the controls in an actual app.

We recommend developers who are new to UWP to visit the [Getting Started with UWP Development](https://developer.microsoft.com/en-us/windows/getstarted) pages on the Developer portal.
We recommend developers who are new to UWP to visit the [Getting Started with UWP Development](https://developer.microsoft.com/en-us/windows/getstarted) pages on the Developer portal.

Visit the [Windows Community Toolkit Github Repository](https://aka.ms/uwptoolkit) to see the current source code, what is coming next, and clone the repository. Community contributions are welcome!
10 changes: 5 additions & 5 deletions docs/Nuget-Packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ NuGet is a standard package manager for .Net applications that is built into Vis
| Microsoft.Toolkit.Uwp.Services | Services Package - This NuGet package includes the service helpers for Facebook, LinkedIn, Microsoft Graph, Twitter and more |
| Microsoft.Toolkit.Uwp.UI | UI Packages - XAML converters, Visual tree extensions, and other extensions and helpers for your XAML UI |
| Microsoft.Toolkit.Uwp.UI.Animations | Animations and Composition behaviors such as Blur, Fade, Rotate, etc. |
| Microsoft.Toolkit.Uwp.UI.Controls | XAML Controls such as RadialGauge, RangeSelector, etc. |
| Microsoft.Toolkit.Uwp.UI.Controls.DataGrid | XAML DataGrid control |
| Microsoft.Toolkit.Uwp.UI.Controls | XAML Controls such as RadialGauge, RangeSelector, etc. |
| Microsoft.Toolkit.Uwp.UI.Controls.DataGrid | XAML DataGrid control |
| Microsoft.Toolkit.Uwp.UI.Controls.Layout | XAML layout controls such as WrapLayout, StaggeredLayout, etc. |
| Microsoft.Toolkit.Uwp.UI.Lottie | Library for rendering Adobe AfterEffects animations natively in Windows apps |
| Microsoft.Toolkit.Uwp.UI.Media | Brushes, Win2D/Composition effects, and helpers to create visual effects |
| Microsoft.Toolkit.Uwp.Connectivity | API helpers such as BluetoothLEHelper and Networking |
| Microsoft.Toolkit.Uwp.DeveloperTools | XAML user controls and services to help developer building their app |
| Microsoft.Toolkit.Uwp.Connectivity | API helpers such as BluetoothLEHelper and Networking |
| Microsoft.Toolkit.Uwp.DeveloperTools | XAML user controls and services to help developer building their app |

## Search in Visual Studio

Expand All @@ -41,7 +41,7 @@ The Windows Community Toolkit is updated regularly with new controls, services,

## Getting Started

Read the [getting Started with the Windows Community Toolkit](getting-started.md) for more instructions on using these NuGet Packages in your own projects.
Read the [getting Started with the Windows Community Toolkit](getting-started.md) for more instructions on using these NuGet Packages in your own projects.

## Windows 10 Store App

Expand Down
2 changes: 1 addition & 1 deletion docs/Toolbox-Support.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp

Add the Windows Community Toolkit controls into the Visual Studio toolbox by following these steps:

1) Add the *Microsoft.Toolkit.Uwp.UI.Controls* NuGet package to your application.
1) Add the *Microsoft.Toolkit.Uwp.UI.Controls* NuGet package to your application.

2) Open any XAML page and select the Toolbox on the left side of Visual Studio.

Expand Down
2 changes: 1 addition & 1 deletion docs/animations/Blur.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Await MyUIElement.Blur(value:=5, duration:=2500, delay:=250).StartAsync() ' B
- Use this to shift the focus to foreground controls.

**Sample Code**

```xaml
<Grid>
<Grid>
Expand Down
2 changes: 1 addition & 1 deletion docs/animations/CompositionAnimations.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ KeyFrames permit more than one target value that is reached at a point along the

## AnimationCollection

A collection of animations.
A collection of animations.

### AnimationCollection Properties

Expand Down
10 changes: 5 additions & 5 deletions docs/animations/Expressions.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp
- [Requirements](#requirements)
- [API](#api)

## <a name="quick-start"></a>Quick Start
## <a name="quick-start"></a>Quick Start

Welcome to the ExpressionBuilder classes! The ExpressionBuilder classes are a C#-only alternative to building Expressions with type safety. Below is a quick introduction to using the ExpressionBuilder classes with your application. Complete documentation and walkthroughs will start from [Intro](#intro) section.

Expand All @@ -80,7 +80,7 @@ To use the ExpressionBuilder in your app, add the Microsoft.Toolkit.Uwp.UI.Anima

```csharp
using Microsoft.Toolkit.Uwp.UI.Animations.Expressions;
```
```

Once you have the nuget package added to your project, you are all set to start using the ExpressionBuilder classes!

Expand All @@ -90,9 +90,9 @@ Once you have the nuget package added to your project, you are all set to start

A brief recap of ExpressionAnimations:

- ExpressionAnimations are a type of CompositionAnimations used to create mathematical relationships between Composition Objects. Simple examples include making a relationship such that one object will move relative to another.
- ExpressionAnimations are a type of CompositionAnimations used to create mathematical relationships between Composition Objects. Simple examples include making a relationship such that one object will move relative to another.

- Like other CompositionAnimations, ExpressionAnimations are templates, meaning you can create an Expression and use it to animate multiple objects. You can also change aspects of the animation and have those changes take effect the next time you animate an object (without affecting any previously connected animations).
- Like other CompositionAnimations, ExpressionAnimations are templates, meaning you can create an Expression and use it to animate multiple objects. You can also change aspects of the animation and have those changes take effect the next time you animate an object (without affecting any previously connected animations).

- For more information on ExpressionAnimations, [please check our documentation](https://docs.microsoft.com/uwp/api/Windows.UI.Composition.ExpressionAnimation).

Expand Down Expand Up @@ -126,7 +126,7 @@ Before we highlight how to use the classes, let's reiterate the core components

- Keywords: a set of known phrases to the Expression language to provide specific behaviors (referencing the CurrentValue, etc.)

- Operators: The glue that brings together all the components of an equation. Your typical mathematical operators (+, -, *, /)
- Operators: The glue that brings together all the components of an equation. Your typical mathematical operators (+, -, *, /)

On the surface, the ExpressionBuilder classes provide three major components to build Expressions with:

Expand Down
2 changes: 1 addition & 1 deletion docs/animations/Light.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Await MyUIElement.Light(distance:=5, duration:=2500, delay:=250, color:=Colors.R
- Use this to create chaining animations with other animations. Visit the [AnimationSet](AnimationSet.md) documentation for more information.

**Sample Code**

```csharp
var anim = MyUIElement.Light(5).Offset(offsetX: 100, offsetY: 100).Saturation(0.5).Scale(scaleX: 2, scaleY: 2);
anim.SetDurationForAll(2500);
Expand Down
2 changes: 1 addition & 1 deletion docs/animations/lottie-scenarios/getting_started_json.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ You probably have a JSON file that was exported from [Adobe AfterEffects](https:
xmlns:lottie="using:Microsoft.Toolkit.Uwp.UI.Lottie"
```

4. Add the JSON file to your project:
4. Add the JSON file to your project:
* Add _LottieLogo1.json_ to the /AnimatedVisuals folder and include by right-clicking > Add > Existing Item.
* Set its [Build Action](https://docs.microsoft.com/visualstudio/ide/build-actions) to **Content** in the Properties window.

Expand Down
12 changes: 6 additions & 6 deletions docs/archive/HamburgerMenu.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ End Class

## <a name="navview"></a> Moving to NavigationView

The Windows 10 Fall Creators Update SDK now includes the [NavigationView](https://docs.microsoft.com/windows/uwp/controls-and-patterns/navigationview) control among other new controls and APIs. This is great news for the Windows Community Toolkit as it means that one of its most popular controls, the HamburgerMenu, has a comparable counterpart in the Windows SDK and it is very easy to transition to the NavigationView if you are already using the HamburgerMenu.
The Windows 10 Fall Creators Update SDK now includes the [NavigationView](https://docs.microsoft.com/windows/uwp/controls-and-patterns/navigationview) control among other new controls and APIs. This is great news for the Windows Community Toolkit as it means that one of its most popular controls, the HamburgerMenu, has a comparable counterpart in the Windows SDK and it is very easy to transition to the NavigationView if you are already using the HamburgerMenu.

The HamburgerMenu and NavigationView share the same concepts and provide the same functionality with one major exception being the NavigationView takes advantage of the new fluent design system. In fact, the NavigationView does everything the HamburgerMenu does and even more.

Expand All @@ -215,7 +215,7 @@ The HamburgerMenu and NavigationView share the same concepts and provide the sam
| ItemClick | ItemInvoked |

The *OptionsItemsSource* and *OptionItemsTemplate* is not available in the NavigationView. Instead, the NavigationView has two additional new properties that provide a much more flexible way of handling settings and optional items:
- An optional property for app settings. Simply set the property *IsSettingsVisible* to true and the NavigationView will display the settings button at the bottom. You can even customize the settings item
- An optional property for app settings. Simply set the property *IsSettingsVisible* to true and the NavigationView will display the settings button at the bottom. You can even customize the settings item

```csharp
var settingsItem = HamburgerMenu.SettingsItem as NavigationViewItem;
Expand All @@ -229,7 +229,7 @@ The HamburgerMenu and NavigationView share the same concepts and provide the sam
settingsItem.Icon = New FontIcon() With {.Glyph = "?"}
```

- Free-form content in the pane's footer, by adding any content in the new *PaneFooter* property
- Free-form content in the pane's footer, by adding any content in the new *PaneFooter* property

In addition, the NavigationView introduces new classes for quickly adding navigation items and grouping items. You can use the new NavigationViewItem, NavigationViewItemSeparator and NavigationViewItemHeader to directly populate the MenuItems and get the look you want

Expand All @@ -247,8 +247,8 @@ Using this property will enable you to take advantage of the NavigationView on d
Version 3.0 of the Windows Community Toolkit adds another related property called **UseNavigationViewSettingsWhenPossible**. When this and UseNavigationViewWhenPossible are both set to true, the control will attempt to detect any of the OptionsItems that represent settings and map this to the built in Settings item in the NavigationView. If the control fails to detect the correct item, you can tell it which item to use by setting the Tag property of the OPtionsItem to the value "setting".

> [!NOTE]
> The `ItemClick` and `OptionsItemClick` events will continue to work but the EventArgs will be null when `UseNavigationViewWhenPossible` is set to true. There is a new event called `ItemInvoked` that should be used instead. This new event will include information about the clicked item and whether it is an item or options item. This event also works if UseNavigationViewWhenPossible is set to false.
>
> The `ItemClick` and `OptionsItemClick` events will continue to work but the EventArgs will be null when `UseNavigationViewWhenPossible` is set to true. There is a new event called `ItemInvoked` that should be used instead. This new event will include information about the clicked item and whether it is an item or options item. This event also works if UseNavigationViewWhenPossible is set to false.
>
> [!NOTE]
> The PaneBackground will not have any effect when `UseNavigationViewWhenPossible` is set to null. To change the pane background of the NavigationView, modify the two theme resources by overwriting them in your App.xaml. See the [NavigationVew documentation](https://docs.microsoft.com/windows/uwp/design/controls-and-patterns/navigationview#customizing-backgrounds) for more details.

Expand All @@ -268,7 +268,7 @@ There are several HamburgerMenu properties that have no effect when the Hamburge
[HamburgerMenu Sample Page Source](https://github.com/Microsoft/WindowsCommunityToolkit/tree/rel/4.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/HamburgerMenu)
. You can see this in action in [Windows Community Toolkit Sample App](https://www.microsoft.com/store/apps/9NBLGGH4TLCQ).

## Default Template
## Default Template

[HamburgerMenu XAML File](https://github.com/Microsoft/WindowsCommunityToolkit/blob/rel/4.0.0/Microsoft.Toolkit.Uwp.UI.Controls/HamburgerMenu/HamburgerMenu.xaml) is the XAML template used in the toolkit for the default styling.

Expand Down
2 changes: 1 addition & 1 deletion docs/archive/PullToRefreshListview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp
> [!NOTE]
> The PullToRefreshListView is no longer available in the Windows Community Toolkit. Please use the [RefreshContainer](https://docs.microsoft.com/windows/uwp/design/controls-and-patterns/pull-to-refresh). Read the [Moving to RefreshContainer](#refreshcontainer) section for more info.

The [PullToRefreshListView Control](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.controls.pulltorefreshlistview), is derived from the built-in List View in XAML. It lets the user pull down beyond the top limit on the listview to trigger a refresh of the content. This control can create rich, animations, and is easy to use.
The [PullToRefreshListView Control](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.controls.pulltorefreshlistview), is derived from the built-in List View in XAML. It lets the user pull down beyond the top limit on the listview to trigger a refresh of the content. This control can create rich, animations, and is easy to use.

This control is very common on mobile devices, where the user can pull from the top to force a content refresh in applications like Twitter.

Expand Down
2 changes: 1 addition & 1 deletion docs/archive/SlidableListItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ There are several SlidableListItem properties that have no effect when the Slida

[SlidableListItem Sample Page Source](https://github.com/Microsoft/WindowsCommunityToolkit/tree/rel/4.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/SlidableListItem). You can see this in action in [Windows Community Toolkit Sample App](https://www.microsoft.com/store/apps/9NBLGGH4TLCQ).

## Default Template
## Default Template

[SlidableListItem XAML File](https://github.com/Microsoft/WindowsCommunityToolkit/blob/rel/4.0.0/Microsoft.Toolkit.Uwp.UI.Controls/SlidableListItem/SlidableListItem.xaml) is the XAML template used in the toolkit for the default styling.

Expand Down
2 changes: 1 addition & 1 deletion docs/collections/ObservableGroups.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ It extends [INotifyPropertyChanged](https://docs.microsoft.com/dotnet/api/system
| Property | Type | Description |
| -- | -- | -- |
| Key | object | The key of the group. It is immutable. |
| Count | int | The number of items currently in the grouped collection. |
| Count | int | The number of items currently in the grouped collection. |

## Sample Project

Expand Down
2 changes: 1 addition & 1 deletion docs/controls/AdaptiveGridView.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ dev_langs:
- vb
---

# AdaptiveGridView XAML Control
# AdaptiveGridView XAML Control

The [AdaptiveGridView Control](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.controls.adaptivegridview) presents items in a evenly-spaced set of columns to fill the total available display space. It reacts to changes in the layout as well as the content so it can adapt to different form factors automatically.

Expand Down
4 changes: 2 additions & 2 deletions docs/controls/BladeView.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ dev_langs:
- vb
---

# BladeView XAML Control
# BladeView XAML Control

The [BladeView Control](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.controls.bladeview) provides a container to host [BladeItem](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.controls.bladeitem) as extra detail pages in, for example, a master-detail scenario. The control is based on how the Azure Portal works.

Expand Down Expand Up @@ -79,7 +79,7 @@ The [BladeView Control](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.
For example: if you set `AutoCollapseCountThreshold` to 3, the BladeView will start counting all BladeItems that are open in the BladeView and have their `TitleBarVisibility` property set to Visible. When the n+1 BladeItem, in our case the 4th one, is being added, the BladeView will auto collapse all n BladeItems except for the last one. All additional BladeItems that are added afterwards will trigger the same effect; collapse all BladeItems except for the last open one.

*Sample Code*

```xaml
<controls:BladeView AutoCollapseCountThreshold="3">
<controls:BladeItem>
Expand Down
2 changes: 1 addition & 1 deletion docs/controls/Carousel.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ dev_langs:
- vb
---

# Carousel XAML Control
# Carousel XAML Control

The [Carousel](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.uwp.ui.controls.carousel) control provides a new control, inherited from the [ItemsControl](https://docs.microsoft.com/uwp/api/Windows.UI.Xaml.Controls.ItemsControl), representing a nice and smooth carousel.
This control lets you specify a lot of properties for a flexible layouting.
Expand Down
4 changes: 2 additions & 2 deletions docs/controls/DataGrid.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ keywords: windows 10, uwp, uwp community toolkit, uwp toolkit, DataGrid, xaml co

# DataGrid XAML control

The DataGrid control provides a flexible way to display a collection of data in rows and columns.
The DataGrid control provides a flexible way to display a collection of data in rows and columns.

![DataGrid control](../resources/images/Controls/DataGrid/DataGrid.gif)

The built-in column types include a text column, a check box column, a combobox column and a template column for hosting custom content. The built-in row type includes a drop-down details section that you can use to display additional content below the cell values.

The DataGrid control supports common table formatting options, such as alternating row backgrounds and foregrounds and the ability to show or hide headers, grid lines, and scroll bars. Additionally, the control provides several style and template properties that you can use to completely change the appearance of the control and its rows, columns, cells, and row or column headers.

The DataGrid has built-in support for Narrator and Touch Narrator to help blind users to navigate and interact easily with the control. Additionally, the control has built-in support for extensive keyboard navigation through cells, headers, rows and columns.
The DataGrid has built-in support for Narrator and Touch Narrator to help blind users to navigate and interact easily with the control. Additionally, the control has built-in support for extensive keyboard navigation through cells, headers, rows and columns.

> [!div class="nextstepaction"]
> [Try it in the sample app](uwpct://Controls?sample=DataGrid)
Expand Down
2 changes: 1 addition & 1 deletion docs/controls/HeaderedContentControl.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The [HeaderedContentControl](https://docs.microsoft.com/dotnet/api/microsoft.too
- The `Header` property can be set to a string, or any xaml elements. If binding the `Header` to an object that is not a string, use the `HeaderTemplate` to control how the content is rendered.

*Sample Code*

```xaml
<controls:HeaderedContentControl Header="This is the header!"/>

Expand Down
Loading