michaelstonis / essentials

Essential cross platform APIs for your mobile apps.

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.

Build Status

Build Server	Type	Platform	Status
Jenkins	Build	Windows
VSTS	Build	Windows
Jenkins	Device Tests	macOS

Installation

Xamarin.Essentials is available via:

• NuGet Official Releases:
• MyGet Development Feed: https://www.myget.org/F/xamarin-essentials/api/v3/index.json

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+)

Current APIs:

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

• Accelerometer
• App Information
• Battery
• Clipboard
• Compass
• Connectivity
• Data Transfer (Share)
• Device Display Information
• Device Information
• Email
• File System Helpers
• Flashlight
• Geocoding
• Geolocation
• Gyroscope
• Magnetometer
• Open Browser
• Orientation Sensor
• Phone Dialer
• Preferences
• Screen Lock
• Secure Storage
• SMS
• Text-to-Speech
• Version Tracking
• Vibrate

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 simply open the solution and build the project.

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.

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.