xamarin/Xamarin.Forms

Name: Xamarin.Forms

Owner: Xamarin

Description: Xamarin.Forms official home

Created: 2016-03-18 15:52:03.0

Updated: 2018-01-17 12:16:04.0

Pushed: 2018-01-17 17:41:18.0

Homepage: https://xamarin.com/forms

Size: 38493

Language: C#

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

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

Visual Studio Team Services

Packages

Platform/Feature | Package name | Stable (2.5.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 :

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:

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 OSX you should specify the platform in the msbuild command (/p:Platform=iPhoneSimulator)

 nuget restore Xamarin.Forms.sln
 msbuild Xamarin.Forms.sln
API documentation changes

If you change or add a public API on Xamarin.Forms the associated documentation should be updated and pushed as part of the pull request. This will also be needed to create a local nuget if you want. We rely on mdoc that is shipped in the repo on the tools folder. After building the .sln on Windows run:

 ./update-docs-windows.bat

on OSX execute:

 make docs
Coding Style

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

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.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.