README.md

XPlugins.iOS.BEMCheckBox

This plugin lets you use the BEMCheckBox in your .NET iOS applications. This README outlines how to get started with BEMCheckBox in .NET and some common uses. For a list of all the features of the please see the BEMCheckBox GitHub page.

Installing

XPlugins is a NuGet Package and can be installed using the dotnet command line:

dotnet add package SaturdayMP.XPlugins.iOS.BEMCheckBox

You can find other ways to install the latest stable version of the BEMCheckBox XPlugin via NuGet. You can find work in progress (WIP) and alpha builds on MyGet. If you have any trouble installing please let me know by opening an issue.

Quickstart

To create a BEMCheckBox call the constructor with a frame as shown below.

var checkbox = new SaturdayMP.XPlugins.iOS.BEMCheckBox(new CoreGraphics.CGRect(140, 40, 25, 25));

You can modify things such as making the checkbox square:

checkbox.BoxType = BEMBoxType.Square;

You can also change the animation type:

checkbox.OnAnimationType = BEMAnimationType.Fill;
checkbox.OffAnimationType = BEMAnimationType.Fill;

Yes you can set the on and off animation types to be different. You can set the color:

checkbox.OnFillColor = UIColor.Red;

To change if the checkbox is checked or not:

// Check to the checkbox.
checkbox.On = true;

// Uncheck the checkbox.
checkbox.On = false;

Finally to handle checkbox clicks setup an event:

private void CheckBoxClickedEvent(object sender, EventArgs eventArgs)
{
  var checkbox = sender as BEMCheckBox;
  if (checkbox == null)
    return;
    
  // Do what you need to do with the checkbox.
}

Then subscribe to it:

checkbox.AnimationDidStopFor += CheckBoxClickedEvent;

For a full list of settings such as animation type, colours, etc see the BEMCheckBox page.

You can also play with the BEMCheckBox settings in the Example Client. To run the Example Client open the source in Visual Studio 2017 and set the Example Client as the startup project. If the Example Client does not run please let me know.

Version Mapping

Below is the mapping of the BEMCheckBox version used in the XPlugin wrapper version along with the Xamain/.NET version.

The .NET version lists the minimum .NET and iOS versions required. For example, `net6.0-ios12`` means the XPlugin will work with .NET 6.0 and iOS 12 or higher (e.g. it will work with .NET 7 and iOS 16).

Please let me know if this XPlugin does not work work with a future version of .NET or iOS by opening an issue.

XPlugin	BEMCheckBox	Frameworks/Minimum Version
1.4.1	1.4.1	Xamarin.iOS/xamarinios10
1.4.2	1.4.1	Xamarin.iOS/xamarinios10
1.4.3	1.4.1	Xamarin.iOS/xamarinios10
2.0.0	2.0.0	Xamarin.iOS/xamarinios10
3.0.0	2.0.0	.NET/net6.0-ios16.1
3.0.1	2.0.0	.NET/net6.0-ios12.0

Acknowledgements

Thanks to Boris Emorine for creating the BEMCheckBox.

Further Reading

Microsoft Learning

Walkthrough: Bind an iOS Swift library

Noise from the Basement

Today I Learned How to Create a Xamarin iOS Binding for Objective-C Libraries:

• Part 1
• Part 2
• Part 3
• Part 4

Today I Learned How to Automate Objective-c Builds in TeamCity

The above is bit outdated as the BEMCheckBox is now a Swift project but the overall steps are the same.