Essential cross platform APIs for your mobile apps.
Перейти к файлу
Gerald Versluis 37b474743b Update azure-pipelines.yml 2021-12-02 10:49:20 +01:00
.github Update PULL_REQUEST_TEMPLATE.md 2021-01-19 17:41:49 +02:00
Assets New Icons! (#218) 2018-04-27 08:03:43 -07:00
DeviceTests Update Xamarin.Forms (#1847) 2021-07-13 04:39:34 +02:00
Samples Update web sample to net5 2021-09-28 11:10:32 -04:00
Tests Update some libraries in the samples (#1610) 2020-12-29 01:12:05 +02:00
Xamarin.Essentials Bump that version as well 2021-07-12 19:05:54 +02:00
docs update FileBase docs 2021-04-14 20:28:07 +03:00
.editorconfig No nested classes and no default access modifiers 2018-04-11 19:45:59 +02:00
.gitattributes .gitattributes: get better diff context for C# code (#1115) 2020-02-23 14:45:11 -05:00
.gitignore WebAuthenticator API (#1062) 2020-01-30 18:54:06 -08:00
.openpublishing.build.ps1 Initialize open publishing repository: https://github.com/xamarin/Essentials of branch master 2018-04-10 19:29:18 +00:00
.openpublishing.publish.config.json Update config to enable docfx v3 2020-08-28 15:43:03 +08:00
CODE_OF_CONDUCT.md Initial attempt at contribution, submission docs, and templates 2018-02-23 22:35:58 +00:00
CONTRIBUTING.md Merge branch 'origin/main' into develop 2020-09-15 16:53:30 +02:00
Directory.Build.props Getting the solution to load without freezing + updates (#977) 2019-11-15 03:35:29 +02:00
LICENSE Rebranding to Xamarin.Essentials (#152) 2018-04-05 20:46:34 -04:00
LICENSE-CODE Initialize open publishing repository: https://github.com/xamarin/Essentials of branch master 2018-04-10 19:29:18 +00:00
PRODUCT-FEEDBACK.md Update PRODUCT-FEEDBACK.md 2019-08-19 12:08:25 -07:00
README.md Update README.md 2020-11-24 08:56:58 -08:00
SUBMITTING-ISSUES.md Update links in markdown files 2018-04-10 11:05:46 +02:00
SignList.xml Add v2 Signing (#1478) 2020-10-27 21:58:02 +02:00
ThirdPartyNotices Initialize open publishing repository: https://github.com/xamarin/Essentials of branch master 2018-04-10 19:29:18 +00:00
Xamarin.Essentials.ruleset Rebranding to Xamarin.Essentials (#152) 2018-04-05 20:46:34 -04:00
Xamarin.Essentials.sln Merge branch 'develop' into 1.6.0 2020-07-20 10:11:35 -04:00
android-setup.ps1 Android setup Script (#1086) 2020-02-10 09:01:30 -08:00
appcenter-post-clone.sh Update Samples.iOS app to be compatible with App Store (#1508) 2020-11-11 15:49:05 +02:00
azure-pipelines.yml Update azure-pipelines.yml 2021-12-02 10:49:20 +01:00
build.cake Only use known feeds (#1692) 2021-02-17 16:13:17 +02:00
devopsnuget.config Only use known feeds (#1692) 2021-02-17 16:13:17 +02:00
nugetreadme.txt grammar fix (#1202) 2020-03-31 13:57:14 -07:00
stylecop.json We want to use spaces and not tabs 2018-02-28 23:07:46 +02:00

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.

Questions

Get your technical questions answered by experts on Microsoft Q&A.

Contribution Discussion

Contributing to Xamarin.Essentials? Join our Discord server and chat with the team

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:

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 needed:

  • 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.