Skip to content

/ Essentials

Essential cross platform APIs for your mobile apps.
xamarin dotnet android ios uwp cross-platform essentials-xamarin
C# Other
  1. C# 99.4%
  2. Other 0.6%
Branch: develop
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Latest commit

@luyajun0205
luyajun0205 Remove MSDN zip xref config from existing .NET repos (#1294)
Latest commit 2333ff9 Jun 9, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Fixed issue with the bug template and invalid label (#828) Jun 28, 2019
Assets New Icons! (#218) Apr 27, 2018
DeviceTests Fix test Apr 17, 2020
Samples Fix Capability Check should be || and added uap xmlns (#1203) Apr 9, 2020
Tests GH-1036 Make GetComplementary an extension (#1039) Dec 21, 2019
Xamarin.Essentials Fix build issues Apr 29, 2020
docs Remove MSDN zip xref config from existing .NET repos (#1294) Jun 9, 2020
.editorconfig No nested classes and no default access modifiers Apr 11, 2018
.gitattributes 1.5.0 Changes (#1124) Feb 26, 2020
.gitignore WebAuthenticator API (#1062) Jan 31, 2020
.openpublishing.build.ps1 Initialize open publishing repository: https://github.com/xamarin/Ess… Apr 10, 2018
.openpublishing.publish.config.json Disable the pesky comments? Dec 19, 2019
CODE_OF_CONDUCT.md Initial attempt at contribution, submission docs, and templates Feb 23, 2018
CONTRIBUTING.md Update CONTRIBUTING.md (#1297) Jun 2, 2020
Directory.Build.props Getting the solution to load without freezing + updates (#977) Nov 15, 2019
LICENSE Rebranding to Xamarin.Essentials (#152) Apr 6, 2018
LICENSE-CODE Initialize open publishing repository: https://github.com/xamarin/Ess… Apr 10, 2018
PRODUCT-FEEDBACK.md Update PRODUCT-FEEDBACK.md Aug 19, 2019
README.md Android setup Script (#1086) Feb 10, 2020
SUBMITTING-ISSUES.md Update links in markdown files Apr 10, 2018
ThirdPartyNotices Initialize open publishing repository: https://github.com/xamarin/Ess… Apr 10, 2018
Xamarin.Essentials.ruleset Rebranding to Xamarin.Essentials (#152) Apr 6, 2018
Xamarin.Essentials.sln WebAuthenticator API (#1062) Jan 31, 2020
android-setup.ps1 Android setup Script (#1086) Feb 10, 2020
appcenter-post-clone.sh Integrate App Center SDK into Sample App (#557) Nov 2, 2018
azure-pipelines.yml Update azure-pipelines.yml Mar 27, 2020
build.ps1 build.ps1: fix build with GithubActionsCI (#950) Oct 29, 2019
generate-docs.cmd Getting the solution to load without freezing + updates (#977) Nov 15, 2019
nuget.config VS for Mac Multi-target support (#953) Oct 28, 2019
nugetreadme.txt grammar fix (#1202) Mar 31, 2020
stylecop.json We want to use spaces and not tabs Feb 28, 2018

README.md

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.

Gitter chat

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.

You can’t perform that action at this time.