Xamarin.Forms official home
Switch branches/tags
tag-test3 tag-test2 tag-test1 rui-3.0.0 release-3.4.0-rc1.3 release-3.4.0-rc1.2 release-3.4.0-rc1.1 release-3.4.0-rc1 release-3.3.0-sr1.2 release-3.3.0-sr1.1 release-3.3.0-sr1 release-3.3.0-rc0 release-3.2.0 release-3.2.0-sr1 release-3.1.0-sr3 release-3.1.0-sr2 release-3.1.0-sr1.1 release-3.1.0-sr1 release-3.1.0-rc1 release-3.0.0-sr4.1 release-3.0.0-sr4 release-3.0.0-sr3 release-3.0.0-sr2 release-3.0.0-sr1 release-3.0.0-rc2 release-3.0.0-rc1 release-2.5.1 release-2.5.1-sr4 release-2.5.1-sr3 release-2.5.1-sr2 release-2.5.1-sr1 release-2.5.0 release-2.5.0-sr5 release-2.5.0-sr4 release-2.5.0-sr3 release-2.5.0-sr2 release-2.5.0-sr1 release-2.4.99-rc1 release-2.4.0 release-2.4.0-sr6 release-2.4.0-sr5 release-2.4.0-sr4 release-2.4.0-sr3 release-2.4.0-sr2 release-2.4.0-sr1 release-2.4.0-rc2 release-2.3.5 release-2.3.4 release-2.3.4-sr6 release-2.3.4-sr5 release-2.3.4-sr4 release-2.3.4-sr3 release-2.3.4-sr2 release-2.3.4-sr1 release-2.3.3 release-2.3.3-sr2 release-2.3.3-sr1.1 release-2.3.3-sr1 release-2.3.3-hf1 release-2.3.2 release-2.3.2-hf1 release-2.3.1 release-2.3.0 release-2.3.0-hf1 release-2.2.0 release-2.2.0-hf1 beta-cycle6buildtest beta-9.99.99-rui beta-9.9.999-rui beta-9.9.99-rui beta-9.9.15.5-rui beta-9.9.9.9-rui beta-9.9.9-rui beta-9.9.8-rui beta-3.5.0-pre1.1 beta-3.5.0-pre1 beta-3.4.0-rui beta-3.4.0-pre2.2 beta-3.4.0-pre2.1 beta-3.4.0-pre2 beta-3.4.0-pre1 beta-3.3.0-pre3 beta-3.3.0-pre2 beta-3.3.0-pre1 beta-3.2.0-pre3 beta-3.2.0-pre2 beta-3.2.0-pre1.1 beta-3.2.0-pre1 beta-3.1.0-pre4.1 beta-3.1.0-pre4 beta-3.1.0-pre3 beta-3.1.0-pre2.3 beta-3.1.0-pre2.2 beta-3.1.0-pre2 beta-3.1.0-pre1.2 beta-3.1.0-pre1 beta-3.0.0-rui beta-3.0.0-pre4.4 beta-3.0.0-pre4.3 beta-3.0.0-pre4.2
Nothing to show
Clone or download
Permalink
Failed to load latest commit information.
.github Move github files to .github dir (#4288) Nov 6, 2018
.nuspec Merge branch '3.3.0' into 3.4.0 Oct 22, 2018
AndroidNative [All] ScaleX and ScaleY (#1280) May 7, 2018
EmbeddingTestBeds Merge branch '3.4.0' Nov 6, 2018
PagesGallery [Android] Convert android projects to package reference (#4310) Nov 6, 2018
Stubs [Enhancement] Add CollectionView progress behind feature flag (#4265) Nov 13, 2018
XFCorePostProcessor.Tasks [Tasks] multitarget the build tasks (#3895) Oct 11, 2018
Xamarin.Flex Merge branch '3.0.0' into 3.1.0 May 7, 2018
Xamarin.Forms.Build @ 1821d28 [Enhancement] Add CollectionView progress behind feature flag (#4265) Nov 13, 2018
Xamarin.Forms.Build.Tasks Merge branch '3.4.0' Nov 9, 2018
Xamarin.Forms.ControlGallery.Android [Enhancement] Add CollectionView progress behind feature flag (#4265) Nov 13, 2018
Xamarin.Forms.ControlGallery.GTK [iOS] Restore NativeViewWrapper registration (#2772) May 22, 2018
Xamarin.Forms.ControlGallery.MacOS [iOS] Restore NativeViewWrapper registration (#2772) May 22, 2018
Xamarin.Forms.ControlGallery.Tizen [Controls] Support NativeView to ControlGallery.Tizen (#3079) Jun 21, 2018
Xamarin.Forms.ControlGallery.WPF [WPF] Fix FontFamily Assignment in platform specific project (#3225) f… Aug 7, 2018
Xamarin.Forms.ControlGallery.WindowsUniversal [Enhancement] Add CollectionView progress behind feature flag (#4265) Nov 13, 2018
Xamarin.Forms.ControlGallery.iOS [Enhancement] Add CollectionView progress behind feature flag (#4265) Nov 13, 2018
Xamarin.Forms.Controls.Issues/Xamarin.Forms.Controls.Issues.Shared [iOS] fix for SearchBar background color (#4229) Nov 13, 2018
Xamarin.Forms.Controls [Enhancement] Add CollectionView progress behind feature flag (#4265) Nov 13, 2018
Xamarin.Forms.Core.Android.UITests [UITest] Update Xamarin UITest packages Sep 19, 2018
Xamarin.Forms.Core.Design [Enhancement] Add CollectionView progress behind feature flag (#4265) Nov 13, 2018
Xamarin.Forms.Core.UITests.Shared [UITests] Try fix iOS failing tests (#4264) Nov 13, 2018
Xamarin.Forms.Core.UnitTests [Enhancement] Add CollectionView progress behind feature flag (#4265) Nov 13, 2018
Xamarin.Forms.Core.Windows.UITests [UITest] Update Xamarin UITest packages Sep 19, 2018
Xamarin.Forms.Core.iOS.UITests [UITest] Update Xamarin UITest packages Sep 19, 2018
Xamarin.Forms.Core.macOS.UITests [UITest] Update Xamarin UITest packages Sep 19, 2018
Xamarin.Forms.Core Merge branch '3.4.0' Nov 13, 2018
Xamarin.Forms.CustomAttributes merge 3.4.0 into master Nov 6, 2018
Xamarin.Forms.Maps.Android [Android] Convert android projects to package reference (#4310) Nov 6, 2018
Xamarin.Forms.Maps.Design [build] Version and strongname the Build.Tasks (#3118) Jun 28, 2018
Xamarin.Forms.Maps.GTK [GTK] Added Maps project (#1349) Dec 9, 2017
Xamarin.Forms.Maps.MacOS [build] Version and strongname the Build.Tasks (#3118) Jun 28, 2018
Xamarin.Forms.Maps.Tizen [build] Version and strongname the Build.Tasks (#3118) Jun 28, 2018
Xamarin.Forms.Maps.UWP [build] Version and strongname the Build.Tasks (#3118) Jun 28, 2018
Xamarin.Forms.Maps.WPF [WPF] Platform and Maps nuget package (#1445) Dec 21, 2017
Xamarin.Forms.Maps.iOS [build] Version and strongname the Build.Tasks (#3118) Jun 28, 2018
Xamarin.Forms.Maps *.swp: remove temporary vim file(s) (#3377) Jul 23, 2018
Xamarin.Forms.Pages.Azure [All] Move to netstandard2.0 **Breaking change** (#1306) Nov 29, 2017
Xamarin.Forms.Pages.UnitTests Move GetNativeSize to PlatformServices, remove IPlatform (#4235) Oct 31, 2018
Xamarin.Forms.Pages [All] Move to netstandard2.0 **Breaking change** (#1306) Nov 29, 2017
Xamarin.Forms.Platform.Android.AppLinks [Android] Convert android projects to package reference (#4310) Nov 6, 2018
Xamarin.Forms.Platform.Android.FormsViewGroup [msbuild] use portable pdb files (#4201) Oct 24, 2018
Xamarin.Forms.Platform.Android [Enhancement] Add CollectionView progress behind feature flag (#4265) Nov 13, 2018
Xamarin.Forms.Platform.GTK [GTK] Fix synchronization context fairness (#4237) Nov 6, 2018
Xamarin.Forms.Platform.MacOS [MacOs] Implemented InsertPageBefore (#4242) Nov 13, 2018
Xamarin.Forms.Platform.Tizen [Tizen] Fix ToolbarItem (#4416) Nov 15, 2018
Xamarin.Forms.Platform.UAP [Enhancement] Add CollectionView progress behind feature flag (#4265) Nov 13, 2018
Xamarin.Forms.Platform.WPF Move GetNativeSize to PlatformServices, remove IPlatform (#4235) Oct 31, 2018
Xamarin.Forms.Platform.iOS [iOS] fix for SearchBar background color (#4229) Nov 13, 2018
Xamarin.Forms.Platform [Enhancement] Add CollectionView progress behind feature flag (#4265) Nov 13, 2018
Xamarin.Forms.Xaml.Design [build] Version and strongname the Build.Tasks (#3118) Jun 28, 2018
Xamarin.Forms.Xaml.UnitTests remove implicitly included files from csproj (#4364) Nov 9, 2018
Xamarin.Forms.Xaml Merge branch '3.4.0' Nov 9, 2018
build [Build] Fix jenkins job id and add triggers Nov 13, 2018
docs fixes #1675 May 9, 2018
tools/mdoc Add missing mdoc tooling Mar 23, 2016
.Xamarin.Forms.Android.nuget.sln remove xamlc xamlg from dot slns (#3274) Jul 10, 2018
.Xamarin.Forms.Android.sln remove xamlc xamlg from dot slns (#3274) Jul 10, 2018
.Xamarin.Forms.UAP.nuget.sln remove xamlc xamlg from dot slns (#3274) Jul 10, 2018
.Xamarin.Forms.UAP.sln remove xamlc xamlg from dot slns (#3274) Jul 10, 2018
.Xamarin.Forms.iOS.nuget.sln remove xamlc xamlg from dot slns (#3274) Jul 10, 2018
.Xamarin.Forms.iOS.sln remove xamlc xamlg from dot slns (#3274) Jul 10, 2018
.Xamarin.forms.nuget.sln remove xamlc xamlg from dot slns (#3274) Jul 10, 2018
.Xamarin.forms.sln remove xamlc xamlg from dot slns (#3274) Jul 10, 2018
.create-nuget.bat add comments to .create-nuget.bat Sep 26, 2018
.editorconfig set csharp_space_after_keywords_in_control_flow_statements to true to… Feb 23, 2018
.gitattributes Force git to checkout docs using unix line endings (#766) Feb 15, 2017
.gitignore *.swp: remove temporary vim file(s) (#3377) Jul 23, 2018
.gitmodules Use relative URL to support recursive checkout in VSTS (#1926) Feb 20, 2018
.xtc-manual-ios.bat Update xtc-manual-ios.bat Nov 8, 2017
GitInfo.txt bump gitinfo Oct 25, 2018
LICENSE Fix license copy Apr 29, 2016
Makefile [docs] use local mdoc (#1321) Dec 5, 2017
README.md GH-4367 Clarify Readme for deps & commandline build (#4368) Nov 13, 2018
Xamarin.Forms.mdpolicy Add Xamarin.Forms code policy file for XamarinStudio Mar 28, 2016
Xamarin.Forms.sln [Tasks] multitarget the build tasks (#3895) Oct 11, 2018
Xamarin.Forms.sln.DotSettings Creating category constants for UI test categories (#487) Nov 15, 2016
Xamarin.Forms.vssettings Update vssettings file to turn on Wrapping_PreserveSingleLine (#115) Apr 24, 2016
azure-pipelines.yml [Build] Fix jenkins job id and add triggers Nov 13, 2018
banner.png [README] Add Xamarin.Forms banner (#757) Feb 9, 2017
debug.keystore Add missing debug.keystore Mar 23, 2016
xamarin.forms.snk [build] Version and strongname the Build.Tasks (#3118) Jun 28, 2018

README.md

Xamarin.Forms banner

Xamarin.Forms

Xamarin.Forms provides a way to quickly build native apps for iOS, Android, Windows and macOS, completely in C#.

Read more about the platform at https://www.xamarin.com/forms.

Build Status

Azure DevOps

Packages

Platform/Feature Package name Stable (3.0.0 branch) Nightly Feed MyGet (master branch)
Core Xamarin.Forms NuGet MyGet
Maps Xamarin.Forms.Maps NuGet MyGet
Pages Xamarin.Forms.Pages NuGet MyGet

If you want to use the latest dev build then you should read this blog post:

  • Add the nightly feed to your NuGet sources or add a NuGet.Config to your app (placing it in the same directory where your solution file is) with the following content:

    <?xml version="1.0" encoding="utf-8"?>
    <configuration>
      <packageSources>
        <clear />
        <add key="xamarin-ci" value="https://www.myget.org/F/xamarinforms-ci/api/v2" />
        <add key="NuGet.org" value="https://api.nuget.org/v3/index.json" />
      </packageSources>
    </configuration>

    NOTE: This NuGet.Config should be with your application unless you want nightly packages to potentially start being restored for other apps on the machine.

  • Change your application's dependencies to have a * to get the latest version.

Getting Started

Install Visual Studio 2017

VS 2017 is required for developing Xamarin.Forms. If you do not already have it installed, you can download it here. VS 2017 Community is completely free. If you are installing VS 2017 for the first time, select the "Custom" installation type and select the following from the features list to install:

  • .NET desktop development - In the Summary > Optional select .NET Framework 4.7 SDK, .NET Framework 4.7 targeting pack.
  • Universal Windows Platform Development - In the Summary > Optional select the Windows 10 Mobile Emulator.
  • Mobile Development with .NET - In the Summary > Optional select Xamarin Remoted Simulator, Xamarin SDK Manager, Intel Hardware Accelerated Execution Manager (HAXM)

The Android 7.1 Nougat API 24 SDK is required for developing Xamarin.Forms. It can be installed by using the Xamarin Android SDK Manager.

We also recommend installing Xamarin Android Device Manager This will use the HAXM tools installed above and allow you to configure Android Virtual Devices (AVDs) that emulate Android devices. If you already have VS 2017 installed, you can verify that these features are installed by modifying the VS 2017 installation via the Visual Studio Installer.

Solution Configuration

Upon opening the Xamarin.Forms solution, you will find that there are a number of errors and warnings under the Error List pane; you can resolve this by changing the filter of Build + IntelliSense to Build Only. At this point, you should be able to successfully build the solution.

By default, the Xamarin.Forms.Controls project does not have a configuration for various API keys to access certain features on each platform (e.g. maps). When building the solution the first time, a controlgallery.config file will be generated inside that project, which looks like this:

UWPMapsAuthKey:

You will have to obtain your own API keys for each of these services, inserted directly after the identifier (e.g. UWPMapsAuthKey:abcdefghijklmnopqrstuvwxyz). You can find out how to obtain each of these as follows:

Due to the way that Android works, the maps API key cannot be injected at runtime. As a result, you will have to add this key to the MapsKey.cs file under Xamarin.Forms.ControlGallery.Android/Properties:

[assembly: Android.App.MetaData("com.google.android.maps.v2.API_KEY", Value = "INSERT_KEY_HERE")]

You can find out how to obtain a Google Maps API key here.

Build from the Command line

Make sure you have nuget.exe 4.0 or above and the latest dotnet core sdk (2.0.3). On macOS you should specify the platform in the msbuild command (/p:Platform=iPhoneSimulator)

msbuild /restore Xamarin.Forms.sln

UI Tests

Run UWP UI Tests

To run the UWP UI Tests:

  1. Install and run the Windows Application Driver.
  2. Launch the Xamarin.Forms.ControlGallery.WindowsUniversal project to install the ControlGallery application onto your system.

You should now be able to run any of the UWP UI Tests.

Coding Style

We follow the style used by the .NET Foundation, with a few exceptions:

  • We do not use the private keyword as it is the default accessibility level in C#.
  • We use hard tabs over spaces. You can change this setting in VS 2015 via Tools > Options and navigating to Text Editor > C# and selecting the "Keep tabs" radio option. In Visual Studio for Mac it's set via preferences in Source Code > Code Formatting > C# source code and disabling the checkbox for Convert tabs to spaces.
  • Lines should be limited to a max of 120 characters (or as close as possible within reason). This may be set in Visual Studio for Mac via preferences in Source Code > Code Formatting > C# source code and changing the Desired file width to 120.

Contributing

Reporting Bugs

We use GitHub Issues to track issues. If at all possible, please submit a reproduction of your bug along with your bug report.