Skip to content

Latest commit

 

History

History
72 lines (39 loc) · 4.18 KB

README.md

File metadata and controls

72 lines (39 loc) · 4.18 KB
Raw

Xamarin.Essentials

Xamarin.Essentials gives developers essential cross-platform APIs for their mobile applications.

iOS, Android, and UWP offer unique operating system and platform APIs that developers have access to, all in C# leveraging Xamarin. It is great that developers have 100% API access in C# with Xamarin, but these APIs are different per platform. This means developers have to learn three different APIs to access platform-specific features. With Xamarin.Essentials, developers have a single cross-platform API that works with any iOS, Android, or UWP application that can be accessed from shared code no matter how the user interface is created.

Discord

Build Status

Build Server Type Platform Status
VSTS Build Windows Build Status
App Center Sample App Android Build status
App Center Sample App iOS Build status

Sample App

Try out Xamarin.Essentials on your device!

Installation

Xamarin.Essentials is available via NuGet & is included in every template:

  • NuGet Official Releases: NuGet

Please read our Getting Started with Xamarin.Essentials guide for full setup instructions.

Documentation

Browse our full documentation for Xamarin.Essentials, including feature guides, on how to use each feature.

Supported Platforms

Platform support & feature support can be found on our documentation

Contributing

Please read through our Contribution Guide. We are not accepting new PRs for full features, however any issue that is marked as up for grabs are open for community contributions. We encourage creating new issues for bugs found during usage that the team will triage. Additionally, we are open for code refactoring suggestions in PRs.

Building Xamarin.Essentials

Xamarin.Essentials is built with the new SDK-style projects with multi-targeting enabled. This means that all code for iOS, Android, and UWP exist inside of the Xamarin.Essentials project.

Visual Studio

A minimum version of Visual Studio 2019 16.3 or Visual Studio for Mac 2019 8.3 are required to build and compile Xamarin.Essentials.

Workloads need:

  • Xamarin
  • .NET Core
  • UWP

You will need the following SDKs

  • Android 10.0, 9.0, 8.1, 8.0, 7.1, 7.0, & 6.0 SDK Installed
  • UWP 10.0.16299 SDK Installed

Your can run the included android-setup.ps1 script in Administrator Mode and it will automatically setup your Android environment.

FAQ

Here are some frequently asked questions about Xamarin.Essentials, but be sure to read our full FAQ on our Wiki.

License

Please see the License.