unoplatform / uno.xamarin.essentials

Essential cross platform APIs for your Xamarin, Desktop and WebAssembly Apps

Uno.Xamarin.Essentials

Uno.Xamarin.Essentials is a fork of the Xamarin.Essentials library to enable WebAssembly support for Uno Platform based applications, as well as all the official Xamarin.Essential supported platforms.

To use this library, you'll need to replace your Nuget package references from Xamarin.Essentials to Uno.Xamarin.Essentials.

Reporting issues

The implementation of the WebAssembly is provided through the UWP implementation of Xamarin.Essentials. This means that you may find parts that are not implemented, because the WinRT APIs may not yet be implemented in Uno.

If you find such an API, please open an issue in the Uno Platform repository to let us know about it!

Xamarin.Essentials Documentation

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.

Documentation

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

API Documentation

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

• Accelerometer
• App Information
• Battery
• Clipboard
• Compass
• Connectivity
• Device Display Information
• Device Information
• Email
• File System Helpers
• Flashlight
• Geocoding
• Geolocation
• Gyroscope
• Launcher
• Magnetometer
• MainThread
• Maps
• Open Browser
• Orientation Sensor
• Phone Dialer
• Preferences
• Screen Lock
• Secure Storage
• Share
• 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.