Skip to content

Latest commit

 

History

History
125 lines (76 loc) · 4.16 KB

README.md

File metadata and controls

125 lines (76 loc) · 4.16 KB
Raw

AnimationSugar

AnimationSugar

AnimationSugar is a tiny Swift library that can make iOS animation code slightly less ugly.

When iterating on animations, it can be a pain to swap between the many method signatures of UIView.animateWithDuration. Also, multi-step animations that nest inside of completion blocks can quickly become an unreadabe mess.

It was built at Intrepid.

##Examples

animate {
    view.translate(tx: 150)
}

Image of animation to the right

animate {
    view.translate(tx: 150)
}
.withSpring(dampingRatio: 0.5, initialVelocity: 0)

Image of animation with spring

animate {
    view.translate(tx: 150)
}
.thenAnimate {
    view.translate(ty: 150)
}
.thenAnimate {
    view.translate(tx: -150)
}
.thenAnimate {
    view.translate(ty: -150)
}

Image of animation in a square

animate(duration: 0.3) {
    view.translate(tx: 150)
}
.withOption(.CurveEaseOut)
.withCompletion { _ in
    view.backgroundColor = UIColor(white: 0.8, alpha: 1.0)
}

Image of animation with completion

Usage

Cocoapods

pod install 'AnimationSugar'

Reference

Animation helpers

func animate(duration duration: NSTimeInterval = defaultAnimationDuration, animations: () -> ()) -> Animation

  • Starts an animation. Use trailing closure syntax to write your animations, e.g.: animate(duration: 0.3) { ... }. Without the duration argument, a default duration is used (see defaultAnimationDuration).

func withDelay(delay: NSTimeInterval) -> Animation

  • Set a delay to wait before the animation starts.

func withOption(option: UIViewAnimationOptions) -> Animation

  • Set an animation option for the animation. For multiple options, either chain them e.g. .withOption(.Autoreverse).withOption(.Repeat) or use once with an array e.g. .withOption([.Autoreverse, .Repeat]).

func withSpring(dampingRatio dampingRatio: CGFloat, initialVelocity: CGFloat) -> Animation

  • Use a spring animation curve with the given damping ratio and initial velocity.

func withCompletion(completion: (Bool) -> ()) -> Animation

  • Set a completion block for when the animation finishes. Use trailing closure syntax e.g. animate { ... }.withCompletion { ... }

func thenAnimate(duration duration: NSTimeInterval = defaultAnimationDuration, animations: () -> ()) -> Animation

  • Chain a new animation to occur after the previous animation is completed. See the "square" example above. Without the duration argument, a default duration is used (see defaultAnimationDuration)

static var defaultAnimationDuration

  • Change the default animation duration, to use animate() or thenAnimate() without a duration argument. This value is initialized to 0.3 seconds and can be changed at any time, i.e. Animation.defaultAnimationDuration = 0.25.

UIView helpers

func translate(tx tx: CGFloat = 0, ty: CGFloat = 0)

  • Translate a view by altering its transform property

func scale(sx sx: CGFloat, sy: CGFloat)

  • Scale a view by altering its transform property

func rotate(angle angle: CGFloat)

  • Rotate a view by altering its transform property

func translateFrame(tx tx: CGFloat = 0, ty: CGFloat = 0)

  • Translate a view by altering its frame property

func stretchFrame(deltaWidth deltaWidth: CGFloat, deltaHeight: CGFloat)

  • Stretch a view's frame

func resizeFrame(width width: CGFloat, height: CGFloat)

  • Resize a view's frame

func flipHorizontal(perspectiveDistance: CGFloat = 1000.0)

  • Flip a view along the horizontal axis.

func flipVertical(perspectiveDistance: CGFloat = 1000.0)

  • Flip a view along the vertical axis.

func fadeIn(duration duration: NSTimeInterval = Animation.defaultAnimationDuration) -> Animation

  • Fade in a view from invisible to visible over time. Can be chained with other animations.

func fadeOut(duration duration: NSTimeInterval = Animation.defaultAnimationDuration) -> Animation

  • Fade out a view from visible to invisible over time. Can be chained with other animations.