fengweijp / xamarin.plugins

Cross platform xamarin and windows plugins for PCLs

Plugins for Xamarin and Windows Projects

See a full list of community built plugins at: https://github.com/xamarin/plugins

Follow Me

• Twitter: @JamesMontemagno
• Blog: MotzCod.es

What is this?

This is my main repo for all all Xamarin Plugins that I have or will be publishing. It is also example and documentation on how to create your very own PCL Plugin. These PCL plugins will allow you to add rich cross platform functionality to Xamarin, Xamarin.Forms and Windows Projects that use a PCLs or Shared Project.

Read more on my blog: http://motzcod.es/post/104507063997/what-exactly-is-a-plugin-for-xamarin

Sample App

Download the sample app today:

• Google Play: https://play.google.com/store/apps/details?id=com.refractored.testappforms
• iOS: Coming Soon
• Windows: Coming Soon
• A sample is located in the TestProject folder

My Current Plugins for Xamarin

Each plugin has a README with more information on what they contain.

• Battery Status: Get battery level, how it is getting charge, and events.
• Compass: Easily access compass heading
• Connectivity: See if device is connected to the internet and through what connection type.
• Contacts: Currently in Alpha to gather and query contacts
• Device Information: Base information about each device such as OS and version.
• Extended Maps: Launch navigation directions in default map app on each OS
• Geolocator: Easy way of querying GPS location
• Local Notifications: Easily show and schedule local notifications.
• Media: Take or pick photos/videos
• Permissions: Check and request runtime permissions.
• Settings: Fully cross platform settings for your application.
• Share: Easily share text or open a browser
• Text To Speech: Turn your text into a vocal symphony on mobile devices.
• Vibrate: Make that device rumble!

Controls:

• Circle Image for Xamarin.Forms

Other:

• Messages_Sample: This is a simple test PCL NuGet to show anyone how easy it is to get a NuGet up and running. It uses an example of a stubbed out class and also a linked file class with #if's throughout it.

How PCL's Work!

PCL's consist of 2 concepts:

• Reference Assembly (API Contract)
• Implementation

Usually these 2 concepts exist together in one single assembly, however PCL's are special and allow you to separate your Reference Assembly from your implementation. This makes it extremely valuable to have platform specific implementations but develop against the same API on all platforms.

Compile vs Deploy

When we are creating a PCL library our PCL project will contain the API Contract with either an Interface that must be implemented on each platform or a stubbed our class that will be implemented on each platform. When we create our NuGet this reference assembly will be installed into our PCL that we can code against.

We will then create a separate project for each platform that we wish to support and implement the interface or stub class on each of them. The key here is that our reference assembly and each platform project have the SAME namespaces & assembly name. When we install into a specific platform via NuGet the platform specific DLL will be referenced.

The magic here is that while we are compiling against our reference assembly in the PCL when we go to deploy our application the reference assembly will be replaced with our platform specific implementation for the specific platform.

This is extremely powerful as long as you as a library creator ensure that your namespaces, assembly names, and all methods are implemented correctly on each platform.

Packaging up your your PCL

You will want to create a nuspec for your DLLs. I have examples in each of my projects for this. Once you have them done simply follow the guidelines: http://docs.nuget.org/docs/creating-packages/creating-and-publishing-a-package

You will want to ensure that you follow the naming guidelines for each platform:

Platform specific:

• MonoTouch10
• MonoAndroid10
• Xamarin.iOS10
• win8
• wpa81
• wp8
• wp81
• net45
• MonoMac10
• Xamarin.Mac20
• UAP10

PCL:

• portable-net45+win8+wp8+MonoTouch10+MonoAndroid10+wpa81+Xamarin.iOS10+UAP10

Important

• Ensure namespaces are the same
• Ensure that Assembly Names are the same. You will see all of mine are called Refractored.Xam.Messages.dll in all projects!

Contributors

• jamesmontemagno

Thanks!

License

Licensed under MIT see License file. Each plugin licensed under parent license unless stated in it's readme file.