C#
Clone or download
Latest commit a225831 Jul 10, 2018

README.md

Xamarin Community Toolkit

The Xamarin Community Toolkit for Xamarin.Forms is a collection of Animations, Behaviors, Converters, and Effects for mobile development with Xamarin.Forms. It simplifies and demonstrates common developer tasks building iOS, Android, and UWP apps with Xamarin.Forms.

Build status

Target Branch Status
Toolkit master Build status

Development NuGet feed: https://www.myget.org/F/xamarin-toolkit/api/v3/index.json

Contributing

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

Building Xamarin Community Toolkit

Xamarin Community Toolkit is built with the new SDK style projects with multi-targeting enabled. This means that all code for iOS, Android, and UWP exist inside of the Xamarin Community Toolkit project.

If building on Visual Studio 2017 simply open the solution and build the project.

If using Visual Studio for Mac the project can be built at the command line with MSBuild. To change the project type that you are working with simply edit Toolkit.csproj and modify the TargetFrameworks for only the project type you want to use.

Xamarin Community Toolkit Sample App

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

Follow the build instructions above to build the full library.

Features and documentation

Documentation for our features is currently being transfered to http://docs.microsoft.com. Until this migration is complete, you can find the current Markdown files under /docs.

Animations

Behaviors

Converters

Effects

Feedback and Requests

Please use GitHub issues for questions, comments, feature requests, or if would like to vote on what others are recommending.

Principles

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

For more information see the Code of Conduct.

License

MIT License, see license file.