Essential cross platform APIs for your Xamarin, Desktop and WebAssembly Apps
Перейти к файлу
Matthew Leibowitz 9e83454b92
Merge pull request #460 from Mrnikbobjeff/feature/GH-458
GH-458: Optimize all structs
2018-08-15 20:24:09 +02:00
.github Update ISSUE_TEMPLATE.md 2018-08-08 23:29:43 +01:00
Assets New Icons! (#218) 2018-04-27 08:03:43 -07:00
DeviceTests Refactor code and update with sensor speed. 2018-08-09 11:48:55 +01:00
Samples Merge branch 'master' into feature/issue-348 2018-08-14 19:02:32 -07:00
Tests Merge branch 'master' into feature/GH-458 2018-08-15 10:00:17 -07:00
Xamarin.Essentials Merge branch 'master' into feature/GH-458 2018-08-15 10:00:17 -07:00
docs Merge branch 'master' into feature/GH-458 2018-08-15 10:00:17 -07:00
.editorconfig No nested classes and no default access modifiers 2018-04-11 19:45:59 +02:00
.gitattributes Fixing line endings and added .gitattributes to make sure it stays fixed 2018-02-28 23:44:18 +02:00
.gitignore Using the new mdoc frameworks (#161) 2018-04-10 10:28:45 -04: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 .openpublishing.publish.config.json 2018-04-10 12:31:25 -07:00
CODE_OF_CONDUCT.md Initial attempt at contribution, submission docs, and templates 2018-02-23 22:35:58 +00:00
CONTRIBUTING.md dotnet foundation CLA broken link (#349) 2018-07-04 10:18:14 -07:00
CodeStyles.targets Rebranding to Xamarin.Essentials (#152) 2018-04-05 20:46:34 -04: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 Create Product Feedback page for Docs (#369) 2018-07-16 11:31:59 -04:00
README.md Update API Documentation 2018-08-02 09:33:31 -07:00
SUBMITTING-ISSUES.md Update links in markdown files 2018-04-10 11:05:46 +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 No More Shared Projects (#410) 2018-07-25 14:47:14 -04:00
build.ps1 Fix restore / build issue 2018-04-25 21:13:57 -04:00
nugetreadme.txt Update version 2018-07-30 16:46:44 -04: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.

Gitter chat

Build Status

Build Server Type Platform Status
Jenkins Build Windows Jenkins Build Status
VSTS Build Windows VSTS Build Status
Jenkins Device Tests macOS Build Status
App Center Sample App Android Build status
App Center Sample App iOS Build status

Installation

Xamarin.Essentials is available via:

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

Xamarin.Essentials is focused on the following platforms:

  • iOS (10+)
  • Android (4.4+)
  • UWP (Fall Creators Update+)

API Documentation:

The following cross-platform APIs are available in Xamarin.Essentials:

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.

If building on Visual Studio 2017 you will need the following SDKs and workloads installed:

Workloads need:

  • Xamarin
  • .NET Core
  • UWP

You will need the following SDKs

  • Android 8.1 SDK Installed
  • UWP 10.0.16299 SDK Installed

If using Visual Studio for Mac the project can be built at the command line with MSBuild. To change the project type that you are working with simply edit Xamarin.Essentials.csproj and modify the TargetFrameworks for only the project type you want to use.

To build through the command line, navigate to where Xamarin.Essentials.csproj exists then run:

dotnet restore
msbuild Xamarin.Essentials.csproj

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.