Repository files navigation

Design and prototype customized UI, interaction, navigation, transition and animation for App Store ready Apps in Interface Builder with IBAnimatable.

The app was made in Interface Builder withIBAnimatable without a single line of code. Due to the size ofthe GIF file on Dribbble, it only demonstrates a subset of features. We can also find the full HD version onYouTube orMP4 on Github

• ✅100% compatible withUIKit. AllIBAnimatable APIs are extensions ofUIKit. No pollutions toUIKit's APIs.
• ✅100% compatible with Auto Layout and Size Classes. No custom layout system.
• ✅User interface design and preview in IB: corner radius, border, mask, shadow, gradient colors, tint color, blur effect etc.
• ✅Animation design in IB: slide in/out, fade in/out, zoom in/out, flip, pop, shake, rotate, move etc.
• ✅Transition design in IB: fade, slide, flip, cube, portal, fold, explosion etc.
• ✅Interactive gesture design in IB: pan, screen edge pan, pinch etc.
• ✅Presentation design in IB: flip, cover, zoom, dropdown etc.
• ✅Activity indicator design in IB: ball beat, ball rotate, cube transition, Pacman etc.

Here is the full design in a Storyboard in Interface Builder.

WithIBAnimatable, we can design a UI in Interface Builder like what we can do in Sketch, and prototype animations in a Swift playground like what we can do in Framer. Also, we can use the output of the design directly in the production ready App.

As a designer, we love Sketch, which is a simple but yet super powerful tool to create UI. However, Sketch can't design interaction, navigation, transition and animation, and we may need another tool like Framer to design some of them. Moreover, to make an App Store ready App, we need to use Xcode and Interface Builder to implement the UI and animations. To speed up the process and minimize the waste, we createIBAnimatable to make Interface Builder designable and animatable.

Copy and pasteIBAnimatable folder in your Xcode project.

To integrate using Apple's Swift package manager, add the following as a dependency to yourPackage.swift:

.package(url:"https://github.com/IBAnimatable/IBAnimatable.git",.upToNextMajor(from:"6.1.0"))

Add the following entry in your Podfile:

pod'IBAnimatable'

Add the following entry in your Cartfile:

   github "IBAnimatable/IBAnimatable"

Add the following entry in your Package.swift:

.package(url:"https://github.com/IBAnimatable/IBAnimatable.git",.upToNextMajor(from:"6.1.0")),

Next, addIBAnimatable to your App targets dependencies like so:

.target(    name:"App",    dependencies:["IBAnimatable",]),

Please Notice, there isa limitation of a built framework for@IBDesignable and@IBInspectable, that will impact onIBAnimatable when you use Carthage or Accio. There is a workaround to use Carthage, Accio or Swift package manager withIBAnimatable, please have a look atCarthage – no Animatable UI Classes appearing in Storyboard

As @DanielAsher mentioned

I use carthage update --use-submodules --no-build --no-use-binaries and manually add the both the framework project and the framework as an embedded dependency.This method is robust, and fine-grained, but perhaps not as easy as dragging the built framework into your project.

Add this repo as a submodule, and add the project file to your workspace. You can then link againstIBAnimatable.framework for your application target.

IBAnimatable 6.1 is the latest major release of IBAnimatable. This version supports Swift 5.1. There are no API breaking changes from migrating from version 5.x and 6.

IBAnimatable 6 supports Swift 5. There are no API breaking changes from migrating from version 5.x.

This version supports Swift 4.2. There are no API breaking changes from migrating from version 4.x.

If you migrate from version 3.x. Please check outIBAnimatable 4.0 Migration Guide for more information.

There are no API breaking changes when migrating from Swift 5 to Swift 5.1 using IBAnimatable.

If you are using Xcode 11 with Swift 5, please use the 6.0.0 release.

There are no API breaking changes when migrating from Swift 4.* to Swift 4.2 using IBAnimatable.

If you are using Xcode 10 with Swift 4.2, please use the latest tagged 5.x release.

There are no API breaking changes when migrating from Swift 4 to Swift 4.1 using IBAnimatable.

If you are using Xcode 9.3 with Swift 4.1, please use the latest tagged 5.x release.

There are no API breaking changes when migrating from Swift 3.2 to Swift 4 using IBAnimatable.

If you are using Xcode 9 with Swift 4, please use the latest tagged 5.x release.

There are no API breaking changes when migrating from Swift 3.1 to Swift 3.2 using IBAnimatable.

If you are using Xcode 9 and Swift 3.2, please use the 4.2 release.

If you migrate from Swift 2.x, please check outIBAnimatable 3.0 Migration Guide for more information about how to migrate your project to 3.0. Version 3 follows Swift 3API Design Guidelines and contains a lot of breaking changes from version 2.x.

If you are using Xcode 8 with Swift 3, please use the latest tagged 4.x release.

中文

• From prototype to shippable App Store ready App - What you design in Interface Builder is what the App exactly looks. More details can be found in this talkPrototype and Design App Store ready Apps in Interface Builder (/dev/world/2016)
• Designer-friendly - Sketch style configuration panel on Attributes inspector () to lower the learning curve for using Interface Builder.
• Animation design support in Swift playground - Similar to Framer, we can prototype animations in Swift playground to save time for running on a simulator or actual iOS devices.
• Built-in Auto Layout support - We can use Auto Layout and Size Classes withIBAnimatable to support orientations and multiple iOS devices.
• Navigation and transition support - We can use default navigation pattern in the App.IBAnimatable also has custom transition animators and segues to support transition animations and gesture interactions.
• Protocol-oriented programming -IBAnimatable uses a protocol-oriented programming paradigm. With Swift protocol extension, it is easy to support more designable or animatable features. We can even use these protocol extensions to create other custom UI elements instead of using the default ones fromIBAnimatable. More details can be found in this talkPrototype and Design App Store ready Apps in Interface Builder (/dev/world/2016) - Part 2: Protocol oriented programming

• Prototyping - Create interactive prototypes to validate ideas quickly.
• Redesigning in Interface Builder - Redesign the UI from Sketch and animations from Framer without writing any code.
• Making custom UI elements - UseIBAnimatable protocols to make custom UI elements. e.g. Buttons with a default color palette.

• Fully Mostly documented API Reference
• How to design and prototype custom transition animation and gesture interaction in Interface Builder with IBAnimatable
• Youtube video:Prototype and Design App Store ready Apps in Interface Builder (/dev/world/2016) - Part 2: Protocol oriented programming

The easy way to learn and understand how powerful ofIBAnimatableis to run the example App and play around the settings in Interface Builder. Just a few steps we can run the App as below, to see more features, we can tap on "Forget Password" button to unlock them. 😉

1. Clone the repository

$ git clone https://github.com/IBAnimatable/IBAnimatable.git

2. Open the workspace in Xcode

$cd IBAnimatable$ open IBAnimatable.xcworkspace

3. Compile and run the app on your simulator or iOS device

To useIBAnimatable to design the UI and animations in Interface Builder, just follow a few steps as below:

1. Open a Storyboard or Xib file.
2. Drag and drop a UIKit element e.g.UIView to aUIViewController.
3. In Identity inspector (), configure the UI element toAnimatable custom UI class e.g.AnimatableView, you can find allAnimatable classes inAPIs.md.
4. Configure the UI and animations in Attribute Inspector.

We can configure the animation settings in Attribute inspector. However, Interface Builder doesn't support previewing Animations, but we can still prototype animations in Swift playground. There are three sample pages to demonstrate how to design animation in Swift playground. You can find them inIBAnimatable.playground.

1. Open IBAnimatable.xcworkspace
2. Select IBAnimatable Framework scheme and build it withCommand + b
3. Select IBAnimatable.playground, choose one page in Swift playground, then click on "Assistant editor" button to split the playground. After that, select "Timeline" on the top of right-hand side to preview the animation. We can use Xcode menu "Editor" -> "Execute" to re-run the playground.

As you saw above, we can prototype an App fully in Interface Builder without a single line of code, butIBAnimatable also provides APIs to let us fully control the UI and animations.IBAnimatable provides simple promise-like APIs. We can easily call them in one line.

view.animate(.pop(repeatCount:1)) // pop animation for the viewview.animate(.squeezeFade(way:.in, direction:.left)) // squeeze and fade in from left animation

You can play around with all these predefined animations in theSwift playground Page - Predefined Animations

There are some properties we can change to customize the animation. What we need to do is to pass the parameters toanimate() method to start the animation.

view.animate(.squeeze(way:.in, direction:.left), duration:1, damping:1, velocity:2, force:1)

You can play around with all animations with different parameters in theSwift playground Page - Animation Properties

Sometimes, we need to run more animation after the previous one. WithIBAnimatable, we can easily use promise-like API to chain all animations together to provide a sleek user experience.

// We can chain the animations together, it is the source code of animated GIF in "Animate in Swift playground" sectionview.animate(.squeezeFade(way:.in, direction:.down)).then(.pop(repeatCount:1)).then(.shake(repeatCount:1)).then(.squeeze(way:.in, direction:.down)).then(.wobble(repeatCount:1)).then(.flip(along:.x)).then(.flip(along:.y)).then(.slideFade(way:.out, direction:.down))

We can usedelay method to delay the next animation.

view.animate(.squeeze(way:.in, direction:.left)).delay(0.5).then(.shake(repeatCount:3))

We can also delay the first animation.

view.delay(2).then(.squeeze(way:.in, direction:.left))

We can add a completion handler/closure to execute when all animations are completed.

view.animate(.squeeze(way:.in, direction:.left)).completion{print("Animations finished!")}

All of us can contribute to this project. Fewer overheads mean less time to build quality Apps and more time to enjoy coffee ☕️.

• If you are a designer, you can design in Interface Builder withIBAnimatable without a design tool like Sketch, or implement your existing design from Sketch or Photoshop in Interface Builder rapidly. WithIBAnimatable, you should be able to doall most of the design work in Interface Builder. If you have any feature request, pleasecreate a GitHub Issue and we will put it in the backlog. If you have done any design withIBAnimatable, please let us know via creating Pull Request or GitHub Issue. We will add it to README file.

• If you are a developer, you can work on features or fix bugs, please check outVision, Technical Considerations and Roadmap andGitHub Issues to find out the backlogs. If you have usedIBAnimatable in your App, please let us know via creating Pull Request or GitHub Issue. We will add it to README file.

• If you are good at English, please correct my English 😁. If you are good at other languages, please create a README file in those languages.

• If you like the project, please share it with the other designers and developers, and star 🌟 the project. 🤗

Many thanks toall contributors 🤗 especially to@tbaranes who develops a lot of features and maintains the project.

Vision, Technical Considerations and Roadmap

• IBDesignable andIBInspectable - The entire project is based on that.
• Sketch - Interface Builder should be as easy as Sketch to use.
• Framer Studio - Design and preview animations in one place.
• Spring by Meng To - steal a lot of animation parameters from this project.
• VCTransitionsLibrary by Colin Eberhardt - port all transition animations from this project, and add parameters support and fix bugs.
• NVActivityIndicatorView by Vinh Nguyen - port all activity indicator animations from this project, and migrate to Swift 3.
• Invision ToDo App UI Kit, The demo App's original design is from this UI Kit and redone in Interface Builder. We also added interaction, navigation and animations.

Please seeCHANGELOG.md

IBAnimatable is released under the MIT license. SeeLICENSE for details.