Skip to content

Easy, closure-based Swift methods for working with interactive UIKit elements.

License

Notifications You must be signed in to change notification settings

AndreiVidrasco/ActionKit

 
 

Repository files navigation

ActionKit

ActionKit is a experimental, light-weight, easy to use framework that wraps the target-action design paradigm into a less verbose, cleaner format. It shortens target-action method calls by removing the target and replacing the selector with a closure.

Licensed under the terms of the MIT license

Target-action example without ActionKit

button.addTarget(self, action: Selector("buttonWasTapped:"), forControlEvents: .TouchUpInside)
func buttonWasTapped(sender: UIButton!) {

    self.button.setTitle("Button was tapped!", forState: .Normal)
    
}

Target-action example with ActionKit

button.addControlEvent(.TouchUpInside) { self.button.setTitle("Button was tapped!", forState: .Normal) }

Methods

UIControl

Adding an action closure for a control event

- addControlEvent(controlEvents: UIControlEvents, closure: () -> ())
Example
button.addControlEvent(.TouchUpInside) { self.button.setTitle("Button was tapped!", forState: .Normal) }

Removing an action closure for a control event

- removeControlEvent(controlEvents: UIControlEvents)
Example
button.removeControlEvent(.TouchUpInside)

UIGestureRecognizer

Initializing a gesture recognizer with an action closure

- init(actionClosure: () -> ())
Example
var singleTapGestureRecognizer = UITapGestureRecognizer() { self.view.backgroundColor = UIColor.redColor() }

Adding an action closure to a gesture recognizer

- addActionClosure(actionClosure: () -> ())
Example
singleTapGestureRecognizer.addActionClosure() { self.view.backgroundColor = UIColor.blueColor() }

Removing an action closure for a control event

- removeActionClosure()
Example
singleTapGestureRecognizer.removeActionClosure()

How it works

ActionKit extends target-action functionality by providing easy to use methods that take closures instead of a selector. ActionKit uses a singleton which stores the closures and acts as the target. Closures capture and store references to any constants and variables from their context, so the user is free to use variables from the context in which the closure was defined in.

Supported

  • Adding and removing an action to concrete gesture-recognizer objects, eg. UITapGestureRecognizer, UISwipeGestureRecognizer
  • Adding and removing an action for UIControl objects, eg. UIButton, UIView

In the pipeline

  • Adding and removing multiple actions for a single UIGestureRecognizer
  • Adding and removing multiple actions for a single UIControl
  • Better manage stored closures

Installation

Cocoapods

ActionKit is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'ActionKit', '~> 1.0'

Carthage

  1. Add the following to your Cartfile:
    github "ActionKit/ActionKit"
  2. Run carthage update
  3. Add the framework as described in Carthage Readme

About

Easy, closure-based Swift methods for working with interactive UIKit elements.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Swift 92.7%
  • Ruby 7.3%