Git Product home page Git Product logo

razzledazzle's Introduction

Open Source at IFTTT

RazzleDazzle

Carthage compatible CocoaPods Version

RazzleDazzle is a simple AutoLayout-friendly keyframe animation framework for iOS, written in Swift. Perfect for scrolling app intros.

RazzleDazzle

RazzleDazzle grew from JazzHands, an Objective-C scrolling keyframe animations library by IFTTT.

JazzHands is used extensively in IF and DO for iPhone and iPad, most famously in the app intro.

What's RazzleDazzle for?

Scrolling App Intro Animations

RazzleDazzle is the easiest way to add scrollview-powered animations to the app intro of your Swift app. If you're adding a scrolling intro to your Objective-C app, check out JazzHands!

For some examples of how JazzHands and RazzleDazzle can be used in practice, check out the intros of both IF and DO for iPhone and iPad, as well as the scrolling animations of the buttons in the DO apps by IFTTT.

Easy Paging Scrollview Layouts in an AutoLayout World

RazzleDazzle's keep(view: onPage:) function of the AnimatedPagingScrollViewController is a super easy way to lay out a paging scroll view that does what you expect it to when your app is rotated or used in the new split-screen iPad views of iOS9, a notoriously tricky aspect of getting your apps fully AutoLayout-ready. RazzleDazzle sets up an AutoLayout-friendly paging scroll view controller for you, and all you need to do to make your layout respond properly to any view size changes is tell RazzleDazzle which page you'd like things on.

As a bonus, because it's built on top of the animations library, you can even tell RazzleDazzle that you'd like one of your views to show up on multiple pages while other views scroll past, with a single call to keep(view: onPages:).

Installation

Carthage

RazzleDazzle is available through Carthage. To install it, simply add the following line to your Cartfile:

github "IFTTT/RazzleDazzle"

CocoaPods

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

pod "RazzleDazzle"

Because RazzleDazzle is written in Swift, be sure to add use_frameworks! at the top of your Podfile.

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!

pod 'RazzleDazzle'

Demo App

Open Example/RazzleDazzle.xcworkspace and run RazzleDazzleDemo to see a simple demonstration of moving, scaling, fading, and transforming views in a scrolling app intro.

Usage

Animated Paging Scroll Views

First, import RazzleDazzle into your view controller, and subclass AnimatedPagingScrollViewController.

import RazzleDazzle

class ViewController: AnimatedPagingScrollViewController {

Tell the paging scroll view controller how many pages it should have.

override func numberOfPages() -> Int {
	return 4
}

Add any views you want to animate to the scrollview's contentView on viewDidLoad.

override func viewDidLoad() {
	super.viewDidLoad()
	contentView.addSubview(firstLabel)
}

Add your desired vertical position and size constraints to your views.

contentView.addConstraint(NSLayoutConstraint(item: firstLabel, attribute: .CenterY, relatedBy: .Equal, toItem: contentView, attribute: .CenterY, multiplier: 1, constant: 0))

Tell the animated paging scroll view controller to keep the view on the page you want it to stay on.

keepView(firstLabel, onPage: 1)

You can even tell the animated paging scroll view controller to keep the view still on more than one page, while other views scroll past it.

keepView(firstLabel, onPages: [1,2])

Or offset the view's center from the page's center:

keepView(firstLabel, onPage: 1.25)

Just make sure that if you're using any of the keepView functions that you don't set an x-position NSLayoutConstraint on the view, as it will conflict with the animated x-position constraints generated by RazzleDazzle.

RazzleDazzle Animations

Generally, creating animations in RazzleDazzle works similarly to creating animations in JazzHands. First, import RazzleDazzle into your view controller.

import RazzleDazzle

Then, create an Animator to manage all of the animations in this UIViewController.

var animator = Animator()

Create an animation for a view that you want to animate. There are multiple types of animation that can be applied to a view. For this example, we'll use AlphaAnimation, which fades a view in and out.

let alphaAnimation = AlphaAnimation(view: viewThatYouWantToAnimate)

Register the animation with the animator.

animator.addAnimation(alphaAnimation)

Add some keyframes to the animation. Let's fade this view out between times 30 and 60.

alphaAnimation[30] = 1
alphaAnimation[60] = 0

Now, to animate the view, tell the animator what time it is. For example, to tie this animation to a UIScrollView, notify the animator of time in the scroller's delegate method.

func scrollViewDidScroll(_ scrollView: UIScrollView) {
	animator.animate(scrollView.contentOffset.x)
}

This will produce an effect where the view will be fully faded in and visible for scroll positions 0 to 30. Between scroll positions 30 and 60, the view will fade out to be invisible, and it will stay faded out for scroll positions greater than 60.

Animation Types

RazzleDazzle supports several types of animations:

  • AlphaAnimation animates the alpha property (creates fade effects).
  • BackgroundColorAnimation animates the backgroundColor property.
  • RotationAnimation animates a rotation transform (for rotation effects).
  • ScaleAnimation applies a scaling transform (to scale view sizes).
  • TranslationAnimation applies a translation transform (to translate view position).
  • CornerRadiusAnimation animates the layer.cornerRadius property.
  • HideAnimation animates the hidden property (hides and shows views).
  • LayerStrokeStartAnimation animates the strokeStart property of a CAShapeLayer (does not work with LayerStrokeEndAnimation).
  • LayerStrokeEndAnimation animates the strokeEnd property of a CAShapeLayer (does not work with LayerStrokeStartAnimation).
  • LayerFillColorAnimation animates the fillColor property of a CAShapeLayer.
  • LayerStrokeColorAnimation animates the strokeColor property of a CAShapeLayer.
  • PathPositionAnimation animates the layer.position property of a UIView along a path.
  • LabelTextColorAnimation animates the textColor property of a UILabel.
  • ConstraintConstantAnimation animates an AutoLayout constraint constant.
  • ConstraintMultiplierAnimation animates an AutoLayout constraint constant as a multiple of an attribute of another view (to offset or resize views based on another view's size)
  • ScrollViewPageConstraintAnimation animates an AutoLayout constraint constant to place a view on a scroll view page (to position views on a scrollView using AutoLayout). This is the animation doing the heavy lifting for AnimatedPagingScrollViewController's keepView(view: onPage:) function.

Creating Custom Animation Types

RazzleDazzle is easy to extend by creating your own custom animation types!

Custom Animation Types

To create your own custom animation type, your type needs to conform to the Animatable protocol. All this requires is that you implement an animate(time:) function that takes a CGFloat time value and does something with it.

For most custom animations, you'll want to subclass Animation with the specific type of the property you want to interpolate for each keyframe.

public class BorderWidthAnimation : Animation<CGFloat>, Animatable {

Create a property to store whatever view (or other object) you are applying the animations to, and create an initializer that takes a view as input.

private let view : UIView

public init(view: UIView) {
	self.view = view
}

Optionally, you can add a function to validate any input values that will be checked each time a keyframe is added, such as for Alpha values that must range from 0 to 1.

public override func validateValue(_ value: CGFloat) -> Bool {
	return (value >= 0) && (value <= 1)
}

Then, all you need to do is to make the appropriate changes to your view when the animate(time:) function is called.

public func animate(_ time: CGFloat) {
	if !hasKeyframes() {return}
	view.layer.borderWidth = self[time]
}

You can then create an instance of your new Animation in your UIViewController, give it the view you'd like to animate, add it to your Animator and set some keyframes as above, and it will animate your custom property when the Animator is told to animate.

Interpolatable Types

RazzleDazzle can animate any type that conforms to the Interpolatable protocol. It comes pre-cooked to support animating CGFloats, CGPoints, CGSizes, CGRects, and UIColors.

If the property you'd like to animate is of a different type, just extend that type to conform to Interpolatable by adding a static function interpolateFrom(fromValue: toValue: withProgress:) that returns an instance of that type between two other instances of the same type.

extension CGPoint : Interpolatable {
    public static func interpolateFrom(fromValue: CGPoint, to toValue: CGPoint, withProgress progress: CGFloat) -> CGPoint {
        assert((0 <= progress) && (progress <= 1), "Progress must be between 0 and 1")
        let interpolatedX = CGFloat.interpolateFrom(fromValue.x, to: toValue.x, withProgress: progress)
        let interpolatedY = CGFloat.interpolateFrom(fromValue.y, to: toValue.y, withProgress: progress)
        return CGPointMake(interpolatedX, interpolatedY)
    }
}

If your property is a CGFloat or one of the other built-in interpolatable types, you only need to create an animation type that tells RazzleDazzle how to apply the keyframe values to your view, as above.

Notes

An animator can only handle one animation per type per view. If you want multiple animations of the same type on a view, use keyframes of a single animation instead of two separate animations.

RazzleDazzle is written in Swift 3.0, so it will only compile in Xcode 8 and up. If you want to use a library like this that will integrate with an older version of Swift, you can use JazzHands, which is written in Objective-C, and use a bridging header to access the methods from your Swift 1.2 classes.

Looking for libraries to build awesome keyframe animations like RazzleDazzle on Android? Check out SparkleMotion.

Contributors

Contributing

  1. Fork it ( https://github.com/[my-github-username]/RazzleDazzle/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

License

RazzleDazzle is available under the MIT license. See the LICENSE file for more info.

Copyright 2015 IFTTT Inc.

razzledazzle's People

Contributors

deub27 avatar edwardjewson avatar gonzalonunez avatar lauraskelton avatar nettofarah avatar nuudles avatar raphaelcruzeiro avatar zeveisenberg avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

razzledazzle's Issues

not (staying) on multiple pages

I guess it must be me doing something wrong but while I have it setup like this:

        keepView(pageControl, onPages: [0,1,2])

the page control shows only one the first page.

BTW: It would be great to mention in the docs whether the pages are 0 or 1 based.

Add Carfile

This would enable Carthage users to use this amazing library

Not building via Carthage

I think this is because it's seeing the .xcworkspace before the .xcodeproj.

After this is fixed (or even if it's not), could you upload the framework to the latest release?

All you have to do is:

$ carthage build --no-skip-current

$ carthage archive RazzleDazzle

Then upload the .zip in project root.

This will save tons of time on CI servers and will stop problems like this affecting users.

initial position of view?

I'm doing something wrong?

I'm subclassing AnimatedPagingScrollViewController to create a little on boarding controller.
I'm ignoring any x position (setting initial frame origin to zero) of my views as I'm using keepView methods to position them on the horizontal axe, but when my views are display for an instant all messed up before showing up at their correct position.
I'm also using SnapKit to setup my vertical constraints (but without setting any horizontal constraint via SnapKit).

I'm adding my views, setting up my constraints and configuring RazzleDazzle in viewDidLoad

Thanks for any help.

Issue with keeping a view in multiple pages

Hello.
I'm not being able to keep a label in multiple pages. I've also tried with a button and the result is the same.
What happens is that the view is put way to the left in the scrollview even if only 1 page is set, e.g., keepView(label, pages: [2]). That is, when it should be in page 2 it appears in page 4 or 5 and a bit off center.
What could be causing this?

keepView(label3, onPage: 2)
a_keepview_single

keepView(label3, onPages: [2])
b_keepview_pages

Loop animation even when finger not on screen

There is a way to loop animation (up & down) when there is no action by the user? So in the same time in a subview i need to animate position.y. How can I do that? Even when I use CABasicAnimation or UIView.animationWithDuration() inside other view it not take any effect.

Swift 3.0 Support

This also relies on Nimble & Quick to update their codebase to support swift 3.0

Get current page

Hi, is there a delegate method called when I scroll to a new page, or a way of finding out which is my current page?

Cannot `Creating Custom Animation Types` due to Swift 3.0 access modifiers.

The Animation class are defined using a public access modifier.
Because of that it's currently not possible to subclass Animation class to do your own custom animation types.

Xcode generates this:
Cannot inherit from non-open class 'Animation<CGFloat>' outside of its defining module

A potential solution to this might be to update the access modifier to open instead of public

Thanks!

Carthage update in project getting terminated

If you run the command:
usr/bin/xcrun xcodebuild -workspace Example/RazzleDazzle.xcworkspace -scheme RazzleDazzle -configuration Release -derivedDataPath /Users/apple/Library/Caches/org.carthage.CarthageKit/DerivedData/11.0_11A419c/RazzleDazzle/acfa6d2416614b2efc07669754312c8797442a0c -sdk iphoneos ONLY_ACTIVE_ARCH=NO CODE_SIGNING_REQUIRED=NO CODE_SIGN_IDENTITY= CARTHAGE=YES archive -archivePath /var/folders/w3/m8g_14wd4bz1rtsvn4y7yzhr0000gn/T/RazzleDazzle SKIP_INSTALL=YES GCC_INSTRUMENT_PROGRAM_FLOW_ARCS=NO CLANG_ENABLE_CODE_COVERAGE=NO STRIP_INSTALLED_PRODUCT=NO
User defaults from command line:
IDEArchivePathOverride = /var/folders/w3/m8g_14wd4bz1rtsvn4y7yzhr0000gn/T/RazzleDazzle
IDEDerivedDataPathOverride = /Users/apple/Library/Caches/org.carthage.CarthageKit/DerivedData/11.0_11A419c/RazzleDazzle/acfa6d2416614b2efc07669754312c8797442a0c

Build settings from command line:
CARTHAGE = YES
CLANG_ENABLE_CODE_COVERAGE = NO
CODE_SIGN_IDENTITY =
CODE_SIGNING_REQUIRED = NO
GCC_INSTRUMENT_PROGRAM_FLOW_ARCS = NO
ONLY_ACTIVE_ARCH = NO
SDKROOT = iphoneos13.0
SKIP_INSTALL = YES
STRIP_INSTALLED_PRODUCT = NO

note: Using new build system
note: Planning build
note: Constructing build description
error: An empty identity is not valid when signing a binary for the product type 'Application'. (in target 'RazzleDazzleDemo' from project 'RazzleDazzleDemo')

** ARCHIVE FAILED **

Please let me know how to fix this @ZevEisenberg @raphaelcruzeiro @maxmeyers

add note in README - if displayed by pushViewController()

I had a huge issue when the AnimatedPagingScrollViewController was displayed in a navigation controller. The scrollView was behaving strange as if the contentView was too big and vertical scrolling was enabled.

This was due to the ViewController I used to subclass AnimatedPagingScrollViewController had the Adjust Scroll View Insets enabled. When disabled it worked just fine.

Support for Swift 5.0 carthage update

I am getting the following error after i upgrade to Swift 5.0 (XCode 10.2)

SWIFT_VERSION '3.0' is unsupported, supported versions are: 4.0, 4.2, 5.0. (in target 'RazzleDazzle')

Prebuilt binary for Swift 2.1

Xcode 7.1 prevent the using of prebuilt framework from Xcode 7 with this error:

Module file was created by an older version of the compiler; rebuild 'RazzleDazzle' and try again: XXX/Carthage/Build/iOS/RazzleDazzle.framework/Modules/RazzleDazzle.swiftmodule/x86_64.swiftmodule

Would please rebuild it with Xcode 7.1 and archive a new framework for it? Thanks.

Is it possible to have pagination?

Hi i was wondering if you've developed pagination within the framework so that there's circles at the bottom of the screen to show the user the current view which they are on? Like the image attached.

screen shot 2015-12-13 at 20 15 39

Trigger a normal UIView animation - or play a sound or other action - when a certain page is reached

Instead of animations that are always proportional to the scroll view's contentOffset, we sometimes want a normal UIView animation to be triggered at a certain point.

Here's a basic implementation:

public class TriggeredBlockAnimation: Animatable {
    public typealias TriggeredBlock = () -> ()
    private var blocks = [CGFloat:TriggeredBlock]()

    public func animate(time: CGFloat) {
        guard let block = blocks[time] else { return }
        block()
        blocks[time] = nil // ensures block is only run once ever
    }

    public subscript(time: CGFloat) -> TriggeredBlock? {
        get {
            return blocks[time]
        }
        set {
            blocks[time] = newValue
        }
    }

}

This could be used like so:

let animation = TriggeredBlockAnimation()
animation[320] = {
    constraint.constant = 0 // update new value

    self.contentView.setNeedsUpdateConstraints()

    UIView.animateWithDuration(0.8, delay: 0.8 * Double(index), usingSpringWithDamping: 0.7, initialSpringVelocity: 1, options: [], animations: {
        self.contentView.layoutIfNeeded()
        }, completion: nil)
}

animator.addAnimation(animation)

You could also use this approach for triggering other one-time events, like playing a sound, or triggering an analytics event, at a specific offset.

RazzleDazzle Swift 1.2

I cant compile your examples, i can't integrate your Pod. I think you are your library is written is Swift 2.0.
Can you create a version for us?

xcode 7.3 support for Carthage

Can you help to pre-build binaries for Xcode 7.3 and Swift 2.2?

When i use

carthage update RazzleDazzle --no-use-binaries

i always get this error:

The following build commands failed:
CompileSwift normal x86_64 /Users/howie/Git_Repos/Work/Home_iOS/Leo/Carthage/Checkouts/RazzleDazzle/Example/Carthage/Checkouts/Quick/Externals/Nimble/Nimble/Adapters/NimbleXCTestHandler.swift
CompileSwiftSources normal x86_64 com.apple.xcode.tools.swift.compiler
(2 failures)

Frameworks missing

Hello there,
when i downloaded the project, the Nimble and Quick frameworks seem to be missing. As a result, i am not able to run the project.

RazzleDazzleDemo using a local folder /Users/laura_ifttt/...

Hi,
I've just wanted to try the example app in Xcode7b4. So I built RazzleDazzle.framework and then RazzleDazzleDemo. But RazzleDazzleDemo build gives an error since it is looking for the framework in /Users/laura_ifttt/Library/Developer/Xcode/.

So I had to move the built framework into the RazzleDazzleDemo project to run it. Is this expected or is there any way to point to a relative path?

The correct way to create small parallax effect for background image

Hello. Have small question for you, guys.
I just have started to use you amazing library. I almost implement all animations that i need but struggling with the main first animation. I need to implement parallax effect(not actually parallax, bg moving with different speed) for background image when i scroll between views.
What is the correct animation type to implement that?
Thanks

Swift 2.3 or 3 support?

Hi, I love what you've built here!

Do you have any plans to make this work with Swift 2.3 or 3?

Animations prior to the first frame

With the IF by IFTT app you can scroll back on the first page and see the animations "reverse" themselves more than their current position. The page indictor also stays centered and does not scroll. When I try replicating this with the test app I run into two issues. First, I'm unable to give the Star animation a negative keyframe. Second, if center something at the bottom on all the pages, it's centered until I scroll before the first page or after the last, in these cases it moves with the scrollview.

How is this accomplished in the IF by IFTT app?

Can an alternative alternatives set of animations be driven by a Pinch Gesture?

I know that RazzleDazzle basically works with logical time and therefore is inherently linear. This, when tied to the scroll gesture / contentOffset makes for a natural linear animated interaction.

However, as well as scrolling, I'm interested in letting the user 'zoom out' from that animated interaction so that they see, in effect, a 20,000ft view of the content they were just looking at. i.e. we want to tie animations to a change in zoomLevel as well.

I just want to confirm, that it's possible to attach, say, TWO (or any number for that matter!) of animators to a View's various different properties?

e.g.

x-scroll animates alpha — fades between 0 and 1
y-scroll animates size — scales object frame between 0 and 1

Abandoned?

This project seems abandoned, there has been several PRs to address the warnings introduced in Swift 3.1 that has been untouched by the maintainer(s).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.