Hero README

The project's README from github.com/HeroTransitions/Hero. As one markdown file: README.md.

Hero is a library for building iOS view controller transitions. It provides a declarative layer on top of the UIKit's cumbersome transition APIs—making custom transitions an easy task for developers.

Carthage compatible Accio supported codecov Version License Xcode 10.0+ iOS 10.0+ Swift 4.0+ 中文 README Donate

Unit Test Swift PM

      

Hero is similar to Keynote's Magic Move. It checks the heroID property on all source and destination views. Every matched view pair is then automatically transitioned from its old state to its new state.

Hero can also construct animations for unmatched views. It is easy to define these animations via the heroModifiers property. Hero will run these animations alongside the Magic Move animations. All of these animations can be interactively controlled by user gestures.

At view controller level, Hero provides several template transitions that you can set through heroModalAnimationType, heroNavigationAnimationType, and heroTabBarAnimationType. These can be used as the foundation of your custom transitions. Combine with heroID & heroModifiers to make your own unique transitions.

      

By default, Hero provides dynamic duration based on the Material Design Motion Guide. Duration is automatically determined by changes to distance and size—saving you the hassle, while providing consistent and delightful animations.

Hero doesn't make any assumptions about how the view is built or structured. It won't modify any of your views' states other than hiding them during the animation. This makes it work with Auto Layout, programmatic layout, UICollectionView (without modifying its layout object), UITableView, UINavigationController, UITabBarController, etc...

Usage Example 1

View Controller 1

redView.hero.id = "ironMan"
blackView.hero.id = "batMan"

View Controller 2

self.hero.isEnabled = true
redView.hero.id = "ironMan"
blackView.hero.id = "batMan"
whiteView.hero.modifiers = [.translate(y:100)]

Usage Example 2

View Controller 1

greyView.hero.id = "skyWalker"

View Controller 2

self.hero.isEnabled = true
greyView.hero.id = "skyWalker"

// collectionView is the parent view of all red cells
collectionView.hero.modifiers = [.cascade]
for cell in redCells {
    cell.hero.modifiers = [.fade, .scale(0.5)]
}

You can do these in the storyboard too!

Installation

CocoaPods

Add the following entry to your Podfile:

pod 'Hero'

Then run pod install.

Don't forget to import Hero in every file you'd like to use Hero.

Carthage

Add the following entry to your Cartfile:

github "HeroTransitions/Hero"

Then run carthage update.

If this is your first time using Carthage in the project, you'll need to go through some additional steps as explained over at Carthage.

Accio

Add the following to your Package.swift:

.package(url: "https://github.com/HeroTransitions/Hero.git", .upToNextMajor(from: "1.4.0")),

Next, add Hero to your App targets dependencies like so:

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

Then run accio update.

Swift Package Manager

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

.package(url: "https://github.com/HeroTransitions/Hero.git", .upToNextMajor(from: "1.3.0"))

and then specify "Hero" as a dependency of the Target in which you wish to use Hero. Here's an example PackageDescription:

// swift-tools-version:4.0
import PackageDescription

let package = Package(
    name: "MyPackage",
    products: [
        .library(
            name: "MyPackage",
            targets: ["MyPackage"]),
    ],
    dependencies: [
        .package(url: "https://github.com/HeroTransitions/Hero.git", .upToNextMajor(from: "1.6.3"))
    ],
    targets: [
        .target(
            name: "MyPackage",
            dependencies: ["Hero"])
    ]
)

Manually

Documentations

Checkout the WIKI PAGES (Usage Guide) for documentations.

For more up-to-date ones, please see the header-doc. (use alt+click in Xcode)

Dash compatible API docs: https://HeroTransitions.github.io/Hero/

Interactive Transition Tutorials

Interactive transitions with Hero (Part 1)

FAQ

Not able to use Hero transition even when self.hero.isEnabled is set to true

Make sure that you have also enabled self.hero.isEnabled on the navigation controller if you are doing a push/pop inside the navigation controller.

Views being covered by another matched view during the transition

Matched views use global coordinate space while unmatched views use local coordinate space by default. Local coordinate spaced views might be covered by other global coordinate spaced views. To solve this, use the useGlobalCoordinateSpace modifier on the views being covered. Checkout Coordinate Space Wiki page for details.

Push animation is shown along side my custom animation

This is the default animation for navigation controller provided by Hero. To disable the push animation, set self.hero.navigationAnimationType to .fade or .none on the navigation controller.

How do I use a different default animation when dismissing

You can use the animation type .selectBy(presenting:dismissing) to specify a different default animation for dismiss.

For example:

    self.hero.modalAnimationType = .selectBy(presenting:.zoom, dismissing:.zoomOut)

Contribute

We welcome any contributions. Please read the Contribution Guide.

Hero (HeroTransitions/Hero)

Searching Database…

22.5K ·GitHub
Hero
What is this?Hero is a Swift library for building iOS view controller transitions — a declarative layer on top of UIKit's cumbersome transition APIs that makes custom transitions easy.
So it's not an app — how does it fit into my project?It's a library: you add it as a dependency to your Xcode project, then import Hero in every file where you want to declare or use transitions.
How do I add it to my project?Five ways: CocoaPods (add Hero to your Podfile, then pod install), Carthage (Cartfile, then carthage update), Accio, Swift Package Manager, or manually drag the Sources folder into your project.
Is it self-contained, or does it pull in other dependencies?It's self-contained: no third-party dependencies are listed — just a layer over UIKit, so all you need is an iOS or tvOS Xcode project.
Are there any gotchas I should know about?For push/pop inside a navigation controller you must also enable hero.isEnabled on that navigation controller, and Hero's default push animation can play alongside yours — set navigationAnimationType to .fade or .none to disable it.
Do I have to write all of this in code, or can I set transitions up in storyboards?You can do it in the storyboard too — the README's usage examples work in both code and storyboard form.
Does it work outside iOS — macOS, Android, the web?No — it targets iOS and tvOS. Since it wraps UIKit's transition APIs, it's for Apple's mobile and TV platforms only.
How do matched views work when a transition runs between two screens?Views you want to carry over are matched between the two view controllers. Matched views animate in the global coordinate space by default, so unmatched local-space views can end up covered — apply the useGlobalCoordinateSpace modifier to the covered views to fix that.
Can the dismiss animation differ from the present animation?Yes — use the .selectBy(presenting:dismissing) animation type to specify a different default animation for dismissing than for presenting.
Is Hero still maintained?It looks healthy: the repository isn't archived, runs CI workflows for build, test and lint, has been developed since 2016 and has 22k+ GitHub stars.
What are similar projects?lottie-ios, NVActivityIndicatorView, SVProgressHUD, SkeletonView, SwiftyJSON, FSCalendar, SnapKit, Alamofire
Which topics is it in?ios-swift, ios-animation, animations, carthage, layout, tvos, cocoapods, material-design, xcode, apple, swift, animation
Creator
HeroTransitions
Size
30.8 MB
Stars
22.5K
Updated
CommitJan 23Release1.6.4Jan 23
Age
9y
Commits · 90 Days