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	rel/2.1.0
Pre-release beta testing	master

Getting started

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

Documentation

All documentation for the toolkit is hosted on Microsoft Docs. All API documentation can be found at the .NET API Browser.

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 Package Name	Description
Microsoft.Toolkit	.NET Standard NuGet package containing common code
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 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.Connectivity	API helpers such as BluetoothLEHelper and Networking
Microsoft.Toolkit.Uwp.DeveloperTools	XAML user controls and services to help developer building their app

Supported SDKs

Anniversary Update (14393)
Creators Update (15063)
Fall Creators Update (16299)

Features

Animations

Controls

Developer Tools

Extensions

Code Helpers

Services

Notifications

Tiles
Toasts

Feedback and Requests

Please use GitHub issues for bug reports and feature requests. For feature requests, please also create en entry in our Uservoice. For general questions and support, please use Stack Overflow where questions should be tagged with the tag uwp-community-toolkit

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 iterations, 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.

moswald / uwpcommunitytoolkit Goto Github PK

uwpcommunitytoolkit's Introduction