Note: This is a fork of the Xamarin.CommunityToolkit that is used by the
company Bittner + Krull Softwaresysteme GmbH. It was created in preparation
of providing a pull request or since the original project isn't maintained
anymore and/or doesn't accept PRs. No support is provided for this fork.
The NuGet package produced by this project has the prefix Bk. and is
released in this GitHub project for anyone to be used. The remainder of this
README is the original unmodified version of the file.
The Xamarin Community Toolkit is a collection of common elements for mobile development with Xamarin.Forms that people tend to replicate across multiple apps. It simplifies and demonstrates common developer tasks when building apps with Xamarin.Forms.
More information on the support timeline for the Xamarin Community Toolkit can be found on our wiki.
If you like to live dangerously, you can use our nightly feed to try out the latest and greatest.
| Build Server | Type | Platform | Status |
|---|---|---|---|
| Azure DevOps | Build | Windows & Mac |
Browsing the sample app is the best place to start exploring what's available today.
The Toolkit is available via NuGet, and should be installed into all of your projects (shared and individual platforms):
- NuGet Official Releases:
- NuGet Nightly Releases:
Browse with the NuGet manager in your IDE to install them or run this command:
Install-Package Xamarin.CommunityToolkit
Note that the C# Markup Extensions are in a separate package, install that with:
Install-Package Xamarin.CommunityToolkit.Markup
After installation, start using the features you're after.
If you're using XAML, you can add this namespace to your root node to get access to all the goodness the Toolkit has to offer without having to add all kinds of namespaces seperately: xmlns:xct="http://xamarin.com/schemas/2020/toolkit". I.e.:
<ContentPage xmlns="http://xamarin.com/schemas/2014/forms" xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
xmlns:xct="http://xamarin.com/schemas/2020/toolkit">
<xct:AvatarView />
<!-- The rest of your page here -->
</ContentPage>The documentation is still under construction, but we've published the most important things over at Microsoft Docs.
If you want to contribute some of the missing bits you can do this over at the official Docs repo as contributions are very much welcomed!
If you have one or more of these common pieces of code that you are always replicating across apps, don't hesitate to contribute! We aim to be the first NuGet package you install when creating a new Xamarin.Forms app!
Please have a look at our contribution guide before you get started, as well as some information on the wiki. Also take note of the Code of Conduct we adhere to.
To structure our project, we have adopted a range of namespaces. You can find them below with a short description of what you will find where. For simply consuming the Toolkit in XAML you can use our simplified namespace. See the Getting Started section above.
| Namespace | Description |
|---|---|
| Xamarin.CommunityToolkit.Core | Core objects that do not fit other namespaces and are used by multiple other components |
| Xamarin.CommunityToolkit.Behaviors | Extended behaviors for the Xamarin.Forms components |
| Xamarin.CommunityToolkit.Converters | XAML converters, used to converted your data binding data into something your XAML understands |
| Xamarin.CommunityToolkit.Effects | Effects to apply light-weight renderer changes to the Xamarin.Forms renderers |
| Xamarin.CommunityToolkit.Extensions | XAML Markup Extensions to make your XAML even more functional |
| Xamarin.CommunityToolkit.ObjectModel | Things that have to do with your models and objects. Probably handy for your MVVM needs |
| Xamarin.CommunityToolkit.UI.Views | Controls such as TabView, etc. |
| Xamarin.CommunityToolkit.SampleApp | Sample App where you can find all of the above for reference. Learn how to use them and see how it all looks |
| Xamarin.CommunityToolkit.UnitTests | This is where our unit tests live. Please keep growing them! |
| Xamarin.CommunityToolkit.Markup | Everthing that has to do with writing your UI in C# code. Also known as C# Markup Extensions |
As a part of the .NET Foundation, we have adopted the .NET Foundation Code of Conduct. Please familiarize yourself with that before participating with this repository. Thanks!
This project is supported by the .NET Foundation.