A customizeable checkbox for iOS
Clone or download
Latest commit 01250a6 Jun 9, 2018

Readme.md


Banner


Create beautiful, customizable, extendable, animated checkboxes on iOS. Completely configurable through interface builder. It has several built in animations, custom value support, a mixed state, checkmark and radio styles, circular and rounded rectangle box shapes, as well as full color customization. See the demo app to play with all the features.

Table of Contents

Documentation

Check out the demo app to change the properties of the checkbox and see the changes in real time.

Animations

  • Animation enum: The possible animations for switching to and from the unchecked state.

    • Stroke:

      Stroke Sample

    • Fill:

      Fill Sample

    • Bounce (Stroke):

      Bounce Stroke Sample

    • Bounce (Fill):

      Bounce Fill Sample

    • Expand (Stroke):

      Expand Stroke Sample

    • Expand (Fill):

      Expand Fill Sample

    • Flat (Stroke):

      Flat Stroke Sample

    • Flat (Fill):

      Flat Fill Sample

    • Spiral:

      Spiral Sample

    • Fade (Stroke):

      Fade Stroke Sample

    • Fade (Fill):

      Fade Fill Sample

    • Dot (Stroke):

      Dot Stroke Sample

    • Dot (Fill):

      Dot Fill Sample

  • stateChangeAnimation Animation: The type of animation to preform when changing from the unchecked state to any other state.

  • animationDuration NSTimeInterval: The duration of the animation that occurs when the checkbox switches states. The default is 0.3 seconds.

Values

  • value (Any): Returns either the checkedValue, uncheckedValue, or mixedValue depending on the checkbox's state.
  • checkedValue Any: The object to return from value when the checkbox is checked.
  • uncheckedValue Any: The object to return from value when the checkbox is unchecked.
  • mixedValue Any: The object to return from value when the checkbox is mixed.

State

  • CheckState enum: The possible states the check can be in.
    • unchecked — No check is shown.
    • checked — A checkmark is shown.
    • mixed — A dash is shown.
  • checkState CheckState: The current state of the checkbox.
  • setCheckState(newState: CheckState, animated: Bool): Change the check state with the option of animating the change.
  • toggleCheckState(animated: Bool = false): Toggle the check state between Unchecked and Checked states.

Appearance

  • MarkType: The possible shapes of the mark.
    • checkmark — The mark is a standard checkmark.
    • radio — The mark is a radio style fill.
  • BoxType: The possible shapes of the box.
    • circle — The box is a circle.
    • square — The box is square with optional rounded corners.
  • tintColor: The main color of the Selected and Mixed states for certain animations.
  • secondaryTintColor UIColor: The color of the box in the unselected state.
  • secondaryCheckmarkTintColor UIColor: The color of the checkmark or radio for certain animations. (Mostly animations with a fill style.)
  • checkmarkLineWidth CGFloat: The line width of the checkmark.
  • markType MarkType: The type of mark to display.
  • boxLineWidth CGFloat: The line width of the box.
  • cornerRadius CGFloat: The corner radius of the box if the box type is Square.
  • boxType BoxType: The shape of the checkbox.
  • hideBox Bool: Wether or not to hide the box.

Getting Started

Demo

Playground

To see a working playground in action, run the workspace located at path M13Checkbox Demo Playground/LaunchMe.xcworkspace. You may need to run the framework scheme and wait for Xcode to process the files, before the playground begins. Open the assistant editor for a live preview of the UI.

This is a great way to work on customizing the checkbox in code to suit your needs.

App

To see the checkbox working on a device, run the demo app included in M13Checkbox.xcodeproj. The demo app walks through all the available features. You will need to run a pod install in order to build the demo app.

Installation

Cocoapods

The easiest way to install M13Checkbox is through CocoaPods. Simplify add the following to your podfile.

pod 'M13Checkbox'

Carthage

To install via Carthage, add the following to your cartfile:

github "Marxon13/M13Checkbox"

Swift Package Manager

To install via Swift Package Manager, add the following as a dependency to your Package.swift file:

.Package(url: "git@github.com:Marxon13/M13Checkbox.git", versions: Version(2,2,0)..<Version(2,2,3)),

Manual

Another option is to copy the files in the "Sources" folder to your project.

Use

Storyboard

Add a custom view to the storyboard and set its class to "M13Checkbox". Customize the available parameters in the attributes inspector as needed.

Note: A shim was added to add support for setting enum properties through interface builder. Just retrieve the integer value corresponding to the enum value needed, and enter that into the property in the attributes inspector.

Programmatically

Just initialize the checkbox like one would initialize a UIView, and add it as a subview to your view hierarchy.

let checkbox = M13Checkbox(frame: CGRect(x: 0.0, y: 0.0, width: 40.0, height: 40.0))
view.addSubview(checkbox)

Project Structure

M13Checkbox The main interface for M13Checkbox is the M13Checkbox class. It is a subclass of UIControl and handles the configurable properties, as well as touch events.

M13CheckboxController Each M13Checkbox references an instance of M13CheckboxController, which controls the appearance and animations of its layers. The controller passes a set of layers to the M13Checkbox, which adds the layers to its layer hierarchy. The checkbox then asks the controller to perform the necessary animations on the layers to animate between states. Each animation type has its own subclass of M13CheckboxController. To add an animation, subclass M13CheckboxController, and add the animation type to the Animation enum, supporting AnimationStyle if applicable. Take a look at the existing controllers to see what variables and functions to override.

M13CheckboxAnimationGenerator Each M13CheckboxController references an instance of M13CheckboxAnimationGenerator, which generates the animations that will be applied to layers during state transitions. The base class contains animations that are shared between multiple animation styles. An animation can subclass M13CheckboxAnimationGenerator to generate new animations specific to the animation type.

M13CheckboxPathGenerator Each M13CheckboxManager references an instance of M13CheckboxPathGenerator, which generates the paths that will be displayed by the layers. The base class contains paths that are shared between multiple animation styles, as well as some boilerplate code to determine which path to use. Some animations have a subclass of M13CheckboxPathGenerator to add new paths specific to the animation type, or override existing paths to customize the look.

M13CheckboxPathGenerator calculates the positions of the points of the checkmark with more than just a basic scaled offset. This allows the checkmark to always look the same, not matter what size the checkbox is. The math contained in the checkmarkLongArmBoxIntersectionPoint and checkmarkLongArmEndPoint are a simplified version of a human readable solution. To see the math that went into creating these equations, check out the "Math.nb" or the "Math.pdf" in the "Other" folder.

M13Checkbox+IB A shim that gives the ability to set the enum values of M13Checkbox in Interface Builder.


Project Details

Requirements

  • iOS 8+
  • Xcode 9.0+
  • Swift 4.0

To try the Swift 4.2 version, use the branch swift_4_2

Todo

  • Fix the animations between the checked and mixed states when the mark is a radio. When the circle is close to being flat, the left and right edges are not rounded, as well as render some artifacts.
  • Add visual feedback for UIControl's selected state. So that when the checkbox is touched, it animates slightly towards the new state.
  • Add support for interrupting animations mid-animation. So that if the checkbox is tapped multiple times in quick succession, it animates from the current values, instead of resetting the checkbox and restarting the animations. This might involve replacing CAAnimations with manually done animations using a CADisplayLink. Or the new UIViewPropertyAnimator.
  • tvOS support.
  • watchOS support.
  • macOS support.
  • Checkbox cells (Re-add label support)
  • Checkbox groups (single / multiple selection)

License

M13Checkbox is avaiable under MIT Licence.