зеркало из https://github.com/DeGsoft/maui-linux.git
107 строки
7.5 KiB
Markdown
107 строки
7.5 KiB
Markdown
|
|
<img src="banner.png" alt="Xamarin.Forms banner" height="145" >
|
|
|
|
# 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 ##
|
|
|
|
|
|
|
|
## Packages ##
|
|
|
|
Platform/Feature | Package name | Stable (3.0.0 branch) |Nightly Feed [MyGet](https://www.myget.org/F/xamarinforms-ci/api/v2) (master branch)
|
|
-----------------------|-------------------------------------------|-----------------------------|-------------------------
|
|
Core | `Xamarin.Forms` | [](https://www.nuget.org/packages/Xamarin.Forms/)| [](https://myget.org/feed/xamarinforms-ci/package/nuget/Xamarin.Forms)
|
|
Maps | `Xamarin.Forms.Maps` | [](https://www.nuget.org/packages/Xamarin.Forms.Maps/) | [](https://myget.org/feed/xamarinforms-ci/package/nuget/Xamarin.Forms.Maps)
|
|
Pages | `Xamarin.Forms.Pages` | [](https://www.nuget.org/packages/Xamarin.Forms.Pages/) | [](https://myget.org/feed/xamarin.forms-ci/package/nuget/Xamarin.Forms.Pages)
|
|
|
|
If you want to use the latest dev build then you should read [this blog post](https://blog.xamarin.com/try-the-latest-in-xamarin-forms-with-nightly-builds):
|
|
|
|
- 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
|
|
<?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](https://www.visualstudio.com/downloads/download-visual-studio-vs). 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](https://docs.microsoft.com/xamarin/android/get-started/installation/android-sdk).
|
|
|
|
We also recommend installing [Xamarin Android Device Manager](https://developer.xamarin.com/guides/android/getting_started/installation/android-emulator/xamarin-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:
|
|
|
|
- `UWPMapsAuthKey` at https://microsoft.com/maps/create-a-bing-maps-key.aspx
|
|
|
|
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](https://developer.xamarin.com/guides/android/platform_features/maps_and_location/maps/obtaining_a_google_maps_api_key/).
|
|
|
|
##### 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](https://github.com/Microsoft/WinAppDriver#installing-and-running-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](https://github.com/dotnet/corefx/blob/master/Documentation/coding-guidelines/coding-style.md), 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 ##
|
|
|
|
- [How to Contribute](https://github.com/xamarin/Xamarin.Forms/blob/master/.github/CONTRIBUTING.md)
|
|
|
|
### Reporting Bugs ###
|
|
|
|
We use [GitHub Issues](https://github.com/xamarin/Xamarin.Forms/issues) to track issues. If at all possible, please submit a [reproduction of your bug](https://gist.github.com/jassmith/92405c300e54a01dcc6d) along with your bug report.
|
|
|