Boing is a simple and powerful animation API for views written in Swift. Inspired by many other animation libraries out there, it tries to aggregate and simplify many options into a single and seamless integration that can be reused in any project.

Installation

Swift Package Manager

From Xcode, go to the menu item File -> Swift Packages and select Add Package Dependency. Paste in this github location into the text field and proceed to add the target into your project.

Cocoapods

Update your Podfile and run pod install:

pod 'Boing'

Carthage

Update your Cartfile and run carthage update:

github "pokanop/boing"

Animations

The basic API pattern adds extensions to any UIView allowing you to execute simple commands to animate your views.

For example, using a preset animation you can do:

view.boing()

Animation Options

You can customize any of the animations and provide a completion handler simply by:

view.boing(options: [.duration(0.3)]) {
  // add your completion code
}

The available options include:

delay(TimeInterval)
duration(TimeInterval)
curve(AnimatingCurve)
damping(CGFloat)
velocity(CGFloat)
repeatCount(Float)
autoreverse(Bool)
removeOnCompletion(Bool)
noAnimate(Bool)

Note that by default animations persist, or removeOnCompletion is false.

Animation Types

Boing provides several basic and preset animations including:

translate(CGFloat, CGFloat)
scale(CGFloat, CGFloat)
rotate(CGFloat)
anchorPoint(CGPoint)
backgroundColor(UIColor)
cornerRadius(CGFloat)
alpha(CGFloat)
frame(CGRect)
bounds(CGRect)
center(CGPoint)
size(CGSize)
borderColor(UIColor)
borderWidth(CGFloat)
shadowColor(UIColor)
shadowOffset(CGSize)
shadowOpacity(CGFloat)
shadowRadius(CGFloat)
transform(CGAffineTransform)
layerTransform(CATransform3D)
fadeIn(AnimatingDirection)
fadeOut(AnimatingDirection)
slide(AnimatingDirection)
squeeze(AnimatingDirection)
flip(AnimatingDirection)
zoomIn
zoomOut
fall
shake
pop
morph
flash
wobble
swing
boing

Boing also provides utility methods and animations including:

delay(time)
identity(time)
now

Coalesced Animations

For a single animation context, the library coalesces or combines several animations together. It runs them using the same animation options like duration and delay.

You can run combined animations using the animate() method as follows:

view.animate(
  animations: [.boing, .backgroundColor(.blue)],
  options: [.duration(0.5), .curve(.easeInOut)]
)

Chainable Animations

In addition to being able to combine or coalesce animations, Boing allows you to also chain in a simple builder style API call.

You can chain several animations to execute sequentially with:

view
  .boing()
  .scale(x: 0.5, y: 0.5)
  .alpha(0.5)
  .wobble()

Immediate Transforms

Boing also provides the noAnimate option that can be provided with any animation. This skips the animation and applies any transforms immediately.

view
  .cornerRadius(20.0, options: [.noAnimate(true)])
  .animate(animations: [.borderWidth(4.0), .borderColor(.red)])

Along with that, another utility can be used to apply changes without animation with now():

view
  .scale(x: 0.5, y: 0.5)
  .rotate(45.0)
  .backgroundColor(.green)
  .now()

These tools allow you to use Boing not only for animation, but also for standard view and layer transforms!

Demo

Check out the Demo app to see the various animations available in the library.

Under the Demo folder, run:

pod install

And then open the workspace at Demo/Demo.xcworkpace to run the application.

Credits

This project was heavily inspired and lifted learnings by these wonderful projects:

• Spring
• Fluent
• Cheetah
• Wobbly

Contibuting

Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License.