C# PowerShell Java Batchfile Makefile HTML
Switch branches/tags
Permalink
Failed to load latest commit information.
.nuget VSTS support (#803) Mar 8, 2017
.nuspec [Xaml] use [Before|After]Targets to avoid being overriden (#1277) Nov 17, 2017
AndroidNative [A] add building instructions May 5, 2017
EmbeddingTestBeds Fix Android version Oct 19, 2017
PagesGallery Fix Android version Oct 19, 2017
Stubs Fix Android version Oct 19, 2017
Xamarin.Forms.Build @ e1869d9 [Build] Update submodule to XCode9.1 Nov 9, 2017
Xamarin.Forms.Build.Tasks [XamlC] update cecil to 0.10-b7 (#1301) Nov 22, 2017
Xamarin.Forms.ControlGallery.Android Add missing image for 40161 test on UWP; update test image Nov 17, 2017
Xamarin.Forms.ControlGallery.MacOS [Core,MacOS]Desktop support (#1126) Oct 2, 2017
Xamarin.Forms.ControlGallery.WP8 [All] Basic Right-To-Left Support (#1222) Nov 9, 2017
Xamarin.Forms.ControlGallery.Windows Better error handling for image loading errors on iOS/Android (#849) Apr 25, 2017
Xamarin.Forms.ControlGallery.WindowsPhone Fix out-of-memory crashes on iOS when creating maps (#467) Jan 12, 2017
Xamarin.Forms.ControlGallery.WindowsUniversal Add success label for UWP BorderEffect for test 45874 Nov 17, 2017
Xamarin.Forms.ControlGallery.iOS [UITest] Update TestCloud agent 0.21.3 (#1298) Nov 21, 2017
Xamarin.Forms.Controls.Issues/Xamarin.Forms.Controls.Issues.Shared Disable Issue2981 test for UWP Nov 17, 2017
Xamarin.Forms.Controls [iOS] Fix issue when enabling SafeArea and scrolling (#1274) Nov 15, 2017
Xamarin.Forms.Core.Android.UITests [UITest] Update UITest package to 2.2.1.1670-dev (#1273) Nov 15, 2017
Xamarin.Forms.Core.Design Remove InternalsVisibleTo from Core to XF.Platforms.* (#782) Mar 7, 2017
Xamarin.Forms.Core.UITests.Shared Attempt at an ActivateContextMenu implementation which will work more… Nov 21, 2017
Xamarin.Forms.Core.UnitTests Lazy creation of ResourceDictionaries (#1295) Nov 22, 2017
Xamarin.Forms.Core.Windows.UITests [UITest] Update UITest package to 2.2.1.1670-dev (#1273) Nov 15, 2017
Xamarin.Forms.Core.iOS.UITests [UITest] Update UITest package to 2.2.1.1670-dev (#1273) Nov 15, 2017
Xamarin.Forms.Core.macOS.UITests [UITest] Update UITest package to 2.2.1.1670-dev (#1273) Nov 15, 2017
Xamarin.Forms.Core Auto merged ResourceDictionaries (#1297) Nov 22, 2017
Xamarin.Forms.CustomAttributes [Test] Make sure we always test with different Cultures (#1219) Oct 24, 2017
Xamarin.Forms.Maps.Android Update obsolete messages for 2.5 Oct 27, 2017
Xamarin.Forms.Maps.Design Warnings as Errors in product projects Apr 6, 2016
Xamarin.Forms.Maps.MacOS [MacOS]Remove extra lib that's not needed for Maps (#1100) Aug 15, 2017
Xamarin.Forms.Maps.UWP Remove InternalsVisibleTo from Maps (#1019) Jul 24, 2017
Xamarin.Forms.Maps.WP8 [Test] Make sure we always test with different Cultures (#1219) Oct 24, 2017
Xamarin.Forms.Maps.WinRT.Phone Mop up enabling warnings as errors (#78) Apr 12, 2016
Xamarin.Forms.Maps.WinRT.Tablet Remove InternalsVisibleTo from Maps (#1019) Jul 24, 2017
Xamarin.Forms.Maps.iOS [Test] Make sure we always test with different Cultures (#1219) Oct 24, 2017
Xamarin.Forms.Maps [Test] Make sure we always test with different Cultures (#1219) Oct 24, 2017
Xamarin.Forms.Pages.Azure Azure support (#143) Apr 27, 2016
Xamarin.Forms.Pages.UnitTests [Tests] Add nunit test adapter (#1038) Jul 6, 2017
Xamarin.Forms.Pages [C] do not reapply a Binding with a Source when the Context changes (#… Nov 21, 2017
Xamarin.Forms.Platform.Android.AppLinks Fix Android version Oct 19, 2017
Xamarin.Forms.Platform.Android.FormsViewGroup [Test] Make sure we always test with different Cultures (#1219) Oct 24, 2017
Xamarin.Forms.Platform.Android Restore a couple of internal methods for previewer compatibility (#1299) Nov 22, 2017
Xamarin.Forms.Platform.GTK Updated branch. Oct 19, 2017
Xamarin.Forms.Platform.MacOS [All] Basic Right-To-Left Support (#1222) Nov 9, 2017
Xamarin.Forms.Platform.UAP [All] Basic Right-To-Left Support (#1222) Nov 9, 2017
Xamarin.Forms.Platform.WP8 [Test] Make sure we always test with different Cultures (#1219) Oct 24, 2017
Xamarin.Forms.Platform.WinRT.Phone Add more UWP automated testing capabilities (#1252) Nov 10, 2017
Xamarin.Forms.Platform.WinRT.Tablet [All] Basic Right-To-Left Support (#1222) Nov 9, 2017
Xamarin.Forms.Platform.WinRT Add more UWP automated testing capabilities (#1252) Nov 10, 2017
Xamarin.Forms.Platform.iOS [iOS] Fix issue when enabling SafeArea and scrolling (#1274) Nov 15, 2017
Xamarin.Forms.Platform Remove ToolBar from Core; Remove ToolBar renderers and unit tests (#124) Apr 25, 2016
Xamarin.Forms.Xaml.Design Enable warnings as errors in XAML Apr 7, 2016
Xamarin.Forms.Xaml.UnitTests [XamlC] update cecil to 0.10-b7 (#1301) Nov 22, 2017
Xamarin.Forms.Xaml.Xamlc [XamlC] update cecil to 0.10-b7 (#1301) Nov 22, 2017
Xamarin.Forms.Xaml.Xamlg [XamlC] Compile RDs without codebehind (#1241) Nov 8, 2017
Xamarin.Forms.Xaml Auto merged ResourceDictionaries (#1297) Nov 22, 2017
docs Auto merged ResourceDictionaries (#1297) Nov 22, 2017
tools/mdoc Add missing mdoc tooling Mar 23, 2016
.Xamarin.Forms.Android.sln Append dot to non-authoritative solutions Oct 24, 2017
.Xamarin.Forms.iOS.sln Append dot to non-authoritative solutions Oct 24, 2017
.editorconfig Added .editorconfig (#192) May 26, 2016
.gitattributes Force git to checkout docs using unix line endings (#766) Feb 15, 2017
.gitignore Add more UWP automated testing capabilities (#1252) Nov 10, 2017
.gitmodules Use Xamarin.Forms.Build (#1092) Aug 10, 2017
.xtc-manual-ios.bat Update xtc-manual-ios.bat Nov 8, 2017
LICENSE Fix license copy Apr 29, 2016
Makefile [docs] build Pages doc in make docs Feb 28, 2017
PULL_REQUEST_TEMPLATE.md Update PULL_REQUEST_TEMPLATE.md Mar 23, 2016
README.md Fix link to How To Contribute Oct 27, 2017
Xamarin.Forms.mdpolicy Add Xamarin.Forms code policy file for XamarinStudio Mar 28, 2016
Xamarin.Forms.sln Fix merge Nov 8, 2017
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
banner.png [README] Add Xamarin.Forms banner (#757) Feb 9, 2017
create-nuget.bat Update create-nuget.bat Mar 14, 2017
debug.keystore Add missing debug.keystore Mar 23, 2016
global.json Use Xamarin.Forms.Build (#1092) Aug 10, 2017
update-docs-windows.bat Robust doc change detection (#772) Feb 16, 2017
update-docs.ps1 Normalize docs (#159) May 11, 2016

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

OSX Debug Teamcity

Windows Debug Teamcity

Android UI Tests Teamcity

iOS8 UI Tests Teamcity

iOS9 UI Tests Teamcity

iOS10 UI Tests Teamcity

Visual Studio Team Services Windows Debug

Visual Studio Team Services OSX Debug

Getting Started

Install Visual Studio 2015

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

  • C#/.NET (Xamarin v4.0.3)
  • Universal Windows App Development Tools
  • Windows 8.1 and Windows Phone 8.0/8.1 Tools

We also recommend installing Microsoft Visual Studio Emulator for Android as well as Emulators for Windows Phone 8.1. If you already have VS 2015 installed, you can verify that these features are installed by modifying the VS 2015 installation via the Control Panel.

Install Additional Features

After installing VS 2015, you will also need to install the following:

  • Bing Maps SDK for Windows 8.1 Store apps -- you can find this in Tools > Extensions and Updates and searching for "bing" in the Online pane.
  • Android SDKs -- you can install these via Tools > Android > Android SDK Manager.
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:

Win8MapsAuthKey:
WinPhoneMapsAuthKey:
UWPMapsAuthKey:
InsightsApiKey:
WP8AppId:
WP8AuthToken:

You will have to obtain your own API keys for each of these services, inserted directly after the identifier (e.g. Win8MapsAuthKey: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.

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

Xamarin.Forms Evolution

To discuss this project and participate in the design, we use the Xamarin.Forms Evolution discussion board.

Reporting Bugs

We use Bugzilla to track issues.