-
Notifications
You must be signed in to change notification settings - Fork 157
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
121 changed files
with
15,397 additions
and
15,393 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| ############################################################################### | ||
| # Set default behavior to automatically normalize line endings. | ||
| ############################################################################### | ||
| * text=auto |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,45 +1,45 @@ | ||
| --- | ||
| title: Getting Started with the Windows Community Toolkit | ||
| author: nmetulev | ||
| description: Overview of how to get started with the Windows Community Toolkit to build amazing UWP apps | ||
| keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp toolkit, get started, visual studio | ||
| --- | ||
|
|
||
| # Getting Started with the Windows Community Toolkit | ||
|
|
||
| The toolkit is available as NuGet packages that can be added to any existing or new project using Visual Studio. | ||
|
|
||
| 1. Download [Visual Studio 2017](https://developer.microsoft.com/windows/downloads) and ensure you choose the **Universal Windows Platform development** Workload in the Visual Studio installer. | ||
|
|
||
| > [!NOTE] | ||
| > Visual Studio 2015 is not supported with the Windows Community Toolkit 2.0 or higher | ||
| 2. Open an existing project, or create a new project using the Blank App template under Visual C# -> Windows -> Universal. **Important**: Build 16299 or higher is supported by current version of the Toolkit. | ||
|
|
||
| 3. In Solution Explorer panel, right click on your project name and select **Manage NuGet Packages**. Search for **Microsoft.Toolkit.UWP**, and choose your desired [NuGet Packages](Nuget-Packages.md) from the list. | ||
|
|
||
|  | ||
|
|
||
| 4. Add a reference to the toolkit in your XAML pages or C# | ||
|
|
||
| * In your XAML page, add a reference at the top of your page: | ||
|
|
||
| ```xaml | ||
| xmlns:controls="using:Microsoft.Toolkit.Uwp.UI.Controls" | ||
| ``` | ||
|
|
||
| * In your C# page, add the namespaces to the toolkit: | ||
|
|
||
| ```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/windowstoolkitapp). | ||
|
|
||
| ## Other Resources | ||
|
|
||
| Download the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp) 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/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! | ||
| --- | ||
| title: Getting Started with the Windows Community Toolkit | ||
| author: nmetulev | ||
| description: Overview of how to get started with the Windows Community Toolkit to build amazing UWP apps | ||
| keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp toolkit, get started, visual studio | ||
| --- | ||
|
|
||
| # Getting Started with the Windows Community Toolkit | ||
|
|
||
| The toolkit is available as NuGet packages that can be added to any existing or new project using Visual Studio. | ||
|
|
||
| 1. Download [Visual Studio 2017](https://developer.microsoft.com/windows/downloads) and ensure you choose the **Universal Windows Platform development** Workload in the Visual Studio installer. | ||
|
|
||
| > [!NOTE] | ||
| > Visual Studio 2015 is not supported with the Windows Community Toolkit 2.0 or higher | ||
| 2. Open an existing project, or create a new project using the Blank App template under Visual C# -> Windows -> Universal. **Important**: Build 16299 or higher is supported by current version of the Toolkit. | ||
|
|
||
| 3. In Solution Explorer panel, right click on your project name and select **Manage NuGet Packages**. Search for **Microsoft.Toolkit.UWP**, and choose your desired [NuGet Packages](Nuget-Packages.md) from the list. | ||
|
|
||
|  | ||
|
|
||
| 4. Add a reference to the toolkit in your XAML pages or C# | ||
|
|
||
| * In your XAML page, add a reference at the top of your page: | ||
|
|
||
| ```xaml | ||
| xmlns:controls="using:Microsoft.Toolkit.Uwp.UI.Controls" | ||
| ``` | ||
|
|
||
| * In your C# page, add the namespaces to the toolkit: | ||
|
|
||
| ```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/windowstoolkitapp). | ||
|
|
||
| ## Other Resources | ||
|
|
||
| Download the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp) 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/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! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,52 +1,52 @@ | ||
| --- | ||
| title: Windows Community Toolkit Nuget Packages | ||
| author: nmetulev | ||
| description: The Windows Community Toolkit is updated regularly with new controls, services, APIs, and more importantly, bug fixes. Make sure to regularly update your nuget packages | ||
| keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp toolkit, nuget, visual studio | ||
| --- | ||
|
|
||
| # Windows Community Toolkit Nuget Packages | ||
|
|
||
| NuGet is a standard package manager for .Net applications that is built into Visual Studio. From your open solution choose the *Tools* menu, *NuGet Package Manager*, *Manage NuGet packages for solution...* to open the UI. Enter one of the package names below to search for it online. | ||
|
|
||
| | NuGet Package Name | Description | | ||
| | --- | --- | | ||
| | Microsoft.Toolkit | .NET Standard NuGet package containing common code | | ||
| | Microsoft.Toolkit.HighPerformance | .NET Standard and .NET Core NuGet package with performance oriented helpers, extensions, etc. | | ||
| | Microsoft.Toolkit.Parsers | .NET Standard NuGet package containing cross-platform parsers, such as Markdown and RSS | | ||
| | Microsoft.Toolkit.Services | .NET Standard NuGet package containing cross-platform services | | ||
| | Microsoft.Toolkit.Uwp | Main NuGet package includes code only helpers such as Colors conversion tool, Storage file handling, a Stream helper class, etc. | | ||
| | Microsoft.Toolkit.Uwp.Notifications | Notifications Package - Generate tile, toast, and badge notifications for Windows 10 via code. Includes intellisense support to avoid having to use the XML syntax | | ||
| | Microsoft.Toolkit.Uwp.Notifications.Javascript | Notification Packages for JavaScript | | ||
| | 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.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 | | ||
|
|
||
| ## Search in Visual Studio | ||
|
|
||
| Searching in Visual Studio package manager you should see a list similar to the one below (version numbers may be different, but names should be the same). | ||
|
|
||
|  | ||
|
|
||
| ## Update Nuget Packages | ||
|
|
||
| The Windows Community Toolkit is updated regularly with new controls, services, APIs, and more importantly, bug fixes. To make sure you are on the latest version, open your project in Visual Studio, choose the **Tools** menu, select **NuGet Package Manager** -> **Manage NuGet Packages for Solution...** and select the *Updates* tab. Select the package you want to update and click Instal to update to the latest version. | ||
|
|
||
| ## 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. | ||
|
|
||
| ## Windows 10 Store App | ||
|
|
||
| Want to see the controls and animations in action before jumping into the code? We have published the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp) to the Windows 10 store. Download the app and play with the controls live to see what they do before ever writing a line of code. | ||
|
|
||
| ## GitHub Repository | ||
|
|
||
| Visit the [Windows Community Toolkit Github Repository](https://aka.ms/uwptoolkit) to see the current source code, what is coming next, and to clone the repository. Community contributions are welcome! | ||
| --- | ||
| title: Windows Community Toolkit Nuget Packages | ||
| author: nmetulev | ||
| description: The Windows Community Toolkit is updated regularly with new controls, services, APIs, and more importantly, bug fixes. Make sure to regularly update your nuget packages | ||
| keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp toolkit, nuget, visual studio | ||
| --- | ||
|
|
||
| # Windows Community Toolkit Nuget Packages | ||
|
|
||
| NuGet is a standard package manager for .Net applications that is built into Visual Studio. From your open solution choose the *Tools* menu, *NuGet Package Manager*, *Manage NuGet packages for solution...* to open the UI. Enter one of the package names below to search for it online. | ||
|
|
||
| | NuGet Package Name | Description | | ||
| | --- | --- | | ||
| | Microsoft.Toolkit | .NET Standard NuGet package containing common code | | ||
| | Microsoft.Toolkit.HighPerformance | .NET Standard and .NET Core NuGet package with performance oriented helpers, extensions, etc. | | ||
| | Microsoft.Toolkit.Parsers | .NET Standard NuGet package containing cross-platform parsers, such as Markdown and RSS | | ||
| | Microsoft.Toolkit.Services | .NET Standard NuGet package containing cross-platform services | | ||
| | Microsoft.Toolkit.Uwp | Main NuGet package includes code only helpers such as Colors conversion tool, Storage file handling, a Stream helper class, etc. | | ||
| | Microsoft.Toolkit.Uwp.Notifications | Notifications Package - Generate tile, toast, and badge notifications for Windows 10 via code. Includes intellisense support to avoid having to use the XML syntax | | ||
| | Microsoft.Toolkit.Uwp.Notifications.Javascript | Notification Packages for JavaScript | | ||
| | 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.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 | | ||
|
|
||
| ## Search in Visual Studio | ||
|
|
||
| Searching in Visual Studio package manager you should see a list similar to the one below (version numbers may be different, but names should be the same). | ||
|
|
||
|  | ||
|
|
||
| ## Update Nuget Packages | ||
|
|
||
| The Windows Community Toolkit is updated regularly with new controls, services, APIs, and more importantly, bug fixes. To make sure you are on the latest version, open your project in Visual Studio, choose the **Tools** menu, select **NuGet Package Manager** -> **Manage NuGet Packages for Solution...** and select the *Updates* tab. Select the package you want to update and click Instal to update to the latest version. | ||
|
|
||
| ## 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. | ||
|
|
||
| ## Windows 10 Store App | ||
|
|
||
| Want to see the controls and animations in action before jumping into the code? We have published the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp) to the Windows 10 store. Download the app and play with the controls live to see what they do before ever writing a line of code. | ||
|
|
||
| ## GitHub Repository | ||
|
|
||
| Visit the [Windows Community Toolkit Github Repository](https://aka.ms/uwptoolkit) to see the current source code, what is coming next, and to clone the repository. Community contributions are welcome! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,33 @@ | ||
| --- | ||
| title: Windows Community Toolkit controls in the Visual Studio Toolbox | ||
| author: nmetulev | ||
| description: Adding the Windows Community Toolkit to your Visual Studio Toolbox simplifies the development workflow with the Visual Studio designer | ||
| keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp toolkit, visual studio, toolbox | ||
| --- | ||
|
|
||
| # Adding the Windows Community Toolkit to your Visual Studio Toolbox (for version 2.0 or below) | ||
|
|
||
| > [!NOTE] | ||
| > Starting with version 2.1, the Windows Community Toolkit controls will be automatically available in the Visual Studio Toolbox as soon as the NuGet package is installed. | ||
| 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. | ||
|
|
||
| 2) Open any XAML page and select the Toolbox on the left side of Visual Studio. | ||
|
|
||
| 3) Right click in a blank area and select *Add Tab*. Name the tab *Windows Community Toolkit Controls*. | ||
|
|
||
| 4) Right click in the tab you just created and select *Choose Items...*. Then select *Browse* from the *Choose Toolbox Items* dialog and navigate to the folder on your machine: | ||
|
|
||
| ``` | ||
| c:\Users\%USERNAME%\.nuget\packages\Microsoft.Toolkit.Uwp.UI.Controls\ | ||
| ``` | ||
| a. Choose the folder name matching the version you have installed, then continue to the *lib\uap10.0* folder and select the *Microsoft.Toolkit.Uwp.UI.Controls.dll* file. You should end up with a dialog similar to the one shown below. | ||
|  | ||
| 5) Your toolbox should now have a list of UI Controls from the toolkit that you can drag and drop onto your XAML surfaces. | ||
|  | ||
| --- | ||
| title: Windows Community Toolkit controls in the Visual Studio Toolbox | ||
| author: nmetulev | ||
| description: Adding the Windows Community Toolkit to your Visual Studio Toolbox simplifies the development workflow with the Visual Studio designer | ||
| keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp toolkit, visual studio, toolbox | ||
| --- | ||
|
|
||
| # Adding the Windows Community Toolkit to your Visual Studio Toolbox (for version 2.0 or below) | ||
|
|
||
| > [!NOTE] | ||
| > Starting with version 2.1, the Windows Community Toolkit controls will be automatically available in the Visual Studio Toolbox as soon as the NuGet package is installed. | ||
| 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. | ||
|
|
||
| 2) Open any XAML page and select the Toolbox on the left side of Visual Studio. | ||
|
|
||
| 3) Right click in a blank area and select *Add Tab*. Name the tab *Windows Community Toolkit Controls*. | ||
|
|
||
| 4) Right click in the tab you just created and select *Choose Items...*. Then select *Browse* from the *Choose Toolbox Items* dialog and navigate to the folder on your machine: | ||
|
|
||
| ``` | ||
| c:\Users\%USERNAME%\.nuget\packages\Microsoft.Toolkit.Uwp.UI.Controls\ | ||
| ``` | ||
| a. Choose the folder name matching the version you have installed, then continue to the *lib\uap10.0* folder and select the *Microsoft.Toolkit.Uwp.UI.Controls.dll* file. You should end up with a dialog similar to the one shown below. | ||
|  | ||
| 5) Your toolbox should now have a list of UI Controls from the toolkit that you can drag and drop onto your XAML surfaces. | ||
|  |
Oops, something went wrong.