Skip to content

Latest commit

 

History

History
126 lines (92 loc) · 8.48 KB

readme.md

File metadata and controls

126 lines (92 loc) · 8.48 KB

UWP Community Toolkit

The UWP Community Toolkit is a collection of helper functions, custom controls, and app services. It simplifies and demonstrates common developer tasks building UWP apps for Windows 10.

Build status

Target Branch Status Recommended Nuget packages version
Production master Build status NuGet
Pre-release beta testing dev Build status MyGet

Getting started

Please read the getting Started with the UWP Toolkit page for more detailed information about using the toolkit.

UWP Community Toolkit Sample App

Want to see the toolkit in action before jumping into the code? Download and play with the UWP Toolkit Sample App from the Store.

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.

Once you search you should see a list similar to the one below (versions may be different, but names should be the same).

nuget packages

NuGet Package Name description
Microsoft.Toolkit.Uwp Main NuGet package includes code only helpers such as Colors conversion tool, Internet Connection detection, 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 Bing, Facebook, LinkedIn, Microsoft Graph and Twitter.
Microsoft.Toolkit.Uwp.UI UI Packages - XAML converters, Visual tree 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.

Features

Animations

Controls

Code Helpers

Services

Notifications

Feedback and Requests

Please use GitHub issues for questions or comments.

If you have specific feature requests or would like to vote on what others are recommending visit our UWP Community Toolkit User Voice.

Contributing

Do you want to contribute? Here are our contribution guidelines.

Principles

  • Principle #1: The toolkit will be kept simple.
  • Principle #2: As soon as a comparable feature is available in the Windows SDK for Windows 10, it will be marked as deprecated.
  • Principle #3: All features will be supported for two Windows SDK for Windows 10 release cycles or until another principle supersedes it.

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.

Roadmap

Read what we plan for next iteration, and feel free to ask questions.

By adding this (Nuget repo | Gallery) to your Visual Studio, you can also get pre-release packages of upcoming version.

.NET Foundation

This project is supported by the .NET Foundation.