Xamarin.Forms Official Home
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.
|Package name||Stable||Prerelease||Nightly Feed Azure (main branch)|
If you want to use the latest dev build then you should read this blog post:
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.
*to get the latest version.
VS 2019+ is required for developing Xamarin.Forms. If you do not already have it installed, you can download it here. VS 2019+ Community is completely free. If you are installing VS 2019+ for the first time, select the "Custom" installation type and select the following from the features list to install:
Individual Components > .NET > .NET Framework 4.6.1 SDK, .NET Framework 4.6.1 targeting pack, .NET Framework 4.7.2 SDK, .NET Framework 4.7.2 targeting pack.
Individual Components > SDKs, libraries, and frameworks > Windows 10 SDK (10.0.19041.0), Windows 10 SDK (10.0.18362.0), Windows 10 SDK (10.0.16299.0).
Individual Components > Development Activities > Xamarin Remoted Simulator
Individual Components > Emulators > Hyper-V Intel Hardware Accelerated Execution Manager (HAXM)
The Android 10.0 API 29 SDK and Android 9.0 API 28 SDK are required for developing Xamarin.Forms. They 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 2019+ installed, you can verify that these features are installed by modifying the VS 2019+ installation via the Visual Studio Installer.
If you are getting errors about missing SDks you can run our provisioning script in PowerShell or CMD
If you do not already have it installed, instructions to download and setup can be found here.
Because of current Multi-Targeting limitations with Visual Studio for Mac you will need to manually build/restore some projects before you are able to work on the Xamarin Forms solution.
Here are a few different options we've put together to help make this process easier - Branches 3.5+ come with a Cake script target that you can use to build and open VSMac
sh ./build.sh --target vsmac- When working on an earlier branch that does not have the cake scripts then you can use the following [build.sh] script(https://gist.github.com/PureWeen/92c1e1aff0c257c3decf0bcb8d6e9296)
If you are on Visual Studio for Mac 2017 you will need to turn off automatic package restore (Visual Studio => Preferences => Nuget => General => uncheck the Package Restore box) before working on the Xamarin.Forms solution. This step is no longer needed with Visual Studio for Mac 2019
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 + IntelliSenseto
Build Only. At this point, you should be able to successfully build the solution.
By default, the
Xamarin.Forms.Controlsproject 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.configfile will be generated inside that project, which looks like this:
If you aren't working with maps, you can ignore this. If you want to work with maps, 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
[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.
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 (
msbuild /restore Xamarin.Forms.sln
Depending on your environment setup, you might need to configure a few things before being able to debug / run UI tests, especially on Windows.
After these steps are taken care of, you should be good to go. You can see all UI tests in Test Explorer, search them for your own convenience, and quickly run individual tests.
To run the UWP UI Tests:
Xamarin.Forms.ControlGallery.WindowsUniversalproject to install the ControlGallery application onto your system.
You should now be able to run any of the UWP UI Tests.
We follow the style used by the .NET Foundation, with a few exceptions:
privatekeyword as it is the default accessibility level in C#.
Tools > Optionsand 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 codeand disabling the checkbox for
Convert tabs to spaces.
Source Code > Code Formatting > C# source codeand changing the
Desired file widthto