Members of the community are rebooting this library under the guidance of the Xamarin team. 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. If you're looking for the historical code to reference, please check the legacy branch.
If you like to live dangerously (and while we are preparing our v1), you can use our nightly feed to try out packages right now.
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 your projects:
Now all you need to do is use it!
For example, to use the AvatarView
you first include the toolkit namespace:
xmlns:views="clr-namespace:Xamarin.CommunityToolkit.UI.Views;assembly=Xamarin.CommunityToolkit"
Then place the view in your XAML:
<views:AvatarView Text="DO" Size="46" Color="#FF3300" TextColor="White" />
Of course, AvatarView
also supports Source
for loading images plus a few other properties. Check it out!
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 app!
Please have a look at our contribution guide before you get started.
- 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.
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.
Namespace | Description |
---|---|
Xamarin.CommunityToolkit | Main NuGet package includes code only helpers, etc. |
Xamarin.CommunityToolkit.UI | UI Packages - XAML converters, Visual tree extensions, and other extensions and helpers for your XAML UI |
Xamarin.CommunityToolkit.UI.Controls | Controls such as TabView, etc. |
Xamarin.CommunityToolkit.UI.Layout | Layouts such as WrapLayout, etc. |
Xamarin.CommunityToolkit.SampleApp | Sample App where you can find all of the above for reference. How to use them and see how it looks |
Xamarin.CommunityToolkit.UnitTests | This is where our unit tests live. Please keep growing them! |