How to create a custom transition

Paul Hudson @twostraws October 30th 2019

Updated for Xcode 12.0

Although SwiftUI comes with a selection of transitions built in, it’s also possible to write entirely custom transitions if we want to.

The process takes three steps:

Create a ViewModifier that represents your transition at any of its states.
Create an AnyTransition extension that uses your view modifier for active and identity states.
Apply that transition to your views using the transition() modifier.

For example, we could write a shape and view modifier combination that lets us mimic the Iris animation in Keynote – it causes a new slide to appear in a circle that grows upwards, a bit like the old Looney Tunes intro sequence.

To make this work we need to define a ScaledCircle shape that creates a circle inside a rectangle that is scaled according to some animatable data:

struct ScaledCircle: Shape {
    var animatableData: CGFloat

    func path(in rect: CGRect) -> Path {
        let maximumCircleRadius = sqrt(rect.width * rect.width + rect.height * rect.height)
        let circleRadius = maximumCircleRadius * animatableData

        let x = rect.midX - circleRadius / 2
        let y = rect.midY - circleRadius / 2

        let circleRect = CGRect(x: x, y: y, width: circleRadius, height: circleRadius)

        return Circle().path(in: circleRect)
    }
}

As you can see, that exposes a single animatableData property that controls the size of the circle inside the drawing rectangle. So, when animatableData is 0 the circle is invisible, and when it’s 1 the circle fills the rectangle.

We can now create a custom ViewModifier struct to apply any shape (in our case, the scaled circle) as a clip shape for another view:

struct ClipShapeModifier<T: Shape>: ViewModifier {
    let shape: T

    func body(content: Content) -> some View {
        content.clipShape(shape)
    }
}

Next, we can make an AnyTransition extension to wrap that modifier in a transition for easier access:

extension AnyTransition {
    static var iris: AnyTransition {
        .modifier(
            active: ClipShapeModifier(shape: ScaledCircle(animatableData: 0)),
            identity: ClipShapeModifier(shape: ScaledCircle(animatableData: 1))
        )
    }
}

Finally, we can use that transition with .transition(.iris). As an example, this creates a ZStack with a blue rectangle, over which we slide in a red rectangle when the “Switch” button is tapped:

struct ContentView: View {
    @State private var isShowingRed = false

    var body: some View {
        NavigationView {
            ZStack {
                Rectangle()
                    .fill(Color.blue)
                    .frame(width: 300, height: 300)

                if isShowingRed {
                    Rectangle()
                        .fill(Color.red)
                        .frame(width: 300, height: 300)
                        .transition(.iris)
                        .zIndex(1)
                }
            }
            .navigationBarItems(trailing: Button("Switch") {
                withAnimation(.easeInOut) {
                    self.isShowingRed.toggle()
                }
            })
        }
    }
}

Sponsor Hacking with Swift and reach the world's largest Swift community!

How to create a custom transition

Similar solutions…