<commit_before># MPCheckBox<commit_msg>Initial Documentation<commit_after># MPCheckBox

Custom Check Boxes class. 

Extends UIControl class. 

This check box does not come with an associated label, this is because sometime you dont want a label next to it, meybe you need an image. So to compensate for this, theres a way to link an UIView (or son) object to it and extend the functionality.

So far there are only two types of check boxes: 

1.  Square and 
2.  Circular.
 
![Screenshot](https://raw.githubusercontent.com/MikePT28/MPCheckBox/master/Images/image.png)

Installation
=============

##Manual
* Just drag the files in the src folder to your project.
* Import the checkbox class you want to use.

##Cocoapods
* Coming Soon.

How to use
==========

##Storyboard
* Create an UView element,
* Place it where you want it,
* Give it a size,
* Assign it the ```MPCheckBox.h``` class.
* Get a reference in the viewController file and
* Customize the properties you want

NOTE: Each Check Box has an identifier, that property is assignable from the IB.

##Programmatically
```objective-C
    #import "MPCheckBox.h" //Import header

    @class SomeClass() <MPCheckBoxDelegate> // Implement Delegate (OPTIONAL)

    MPCheckBox *checkBox = [[MPCheckBox alloc] initWithFrame:someFrame];
    checkBox.identifier = @"someIdent";
    checkBox setDelegate:self];
    [checkBox setCompanionView:someView]; //Can be anithing that inherits from UIView
    //For circular
    [checkBox setCircular:YES]; //Default is NO
    //Set State
    [checkBox setState:kMPCheckBoxStateChecked animated:NO]; // Default is Unchecked
    //Cutomization
    [checkBox setBackgroundColor:someColor]; //Default Clear
    [checkBox setBorderColor:otherColor]; //Default Black
    [checkBox setCheckColor:oneMoreColor]; //Default Black
    
    //The state can be toggled manually from anywhere just call
    [checkBox toggleState:YES];
    [someOtherView addSubView:checkBox];
```

License
============
MIT but Read de LICENSE file for more info.

Version
===========
v0.1 ~ Method names and properties may change in the feature. The will be specified but concider yourself warned.
{'fraction_non_alphanumeric': 0.09925788497217068, 'fraction_numerical': 0.0027829313543599257, 'mean_word_length': 4.135714285714286, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '155792', 'n_tokens_mistral': 632, 'n_tokens_neox': 612, 'n_words': 250}