davdroman/swiftui-navigation-transitions

Overview

Instead of reinventing the entire navigation stack just to control its transitions, this library ships with a simple modifier that can be applied directly to SwiftUI's very own first-party navigation components.

The Basics

iOS 13+

NavigationView {
  // ...
}
.navigationViewStyle(.stack)
.navigationTransition(.slide)

iOS 16+

NavigationStack {
  // ...
}
.navigationTransition(.slide)

The API is designed to resemble that of built-in SwiftUI Transitions for maximum familiarity and ease of use.

You can apply custom animations just like with standard SwiftUI transitions:

.navigationTransition(
    .fade(.in).animation(.easeInOut(duration: 0.3))
)

You can combine them:

.navigationTransition(
    .slide.combined(with: .fade(.in))
)

And you can dynamically choose between transitions based on logic:

.navigationTransition(
    reduceMotion ? .fade(.in).animation(.linear) : .slide(.vertical)
)

Transitions

The library ships with some standard transitions out of the box:

• default
• fade(_:)
• slide(axis:)

In addition to these, you can create fully custom transitions in just a few lines of SwiftUI-like code!

struct Swing: NavigationTransitionProtocol {
    var body: some NavigationTransitionProtocol {
        Slide(axis: .horizontal)
        MirrorPush {
            let angle = 70.0
            let offset = 150.0
            OnInsertion {
                ZPosition(1)
                Rotate(.degrees(-angle))
                Offset(x: offset)
                Opacity()
                Scale(0.5)
            }
            OnRemoval {
                Rotate(.degrees(angle))
                Offset(x: -offset)
            }
        }
    }
}

The Demo app showcases some of these transitions in action.

Interactivity

A sweet additional feature is the ability to override the behavior of the pop gesture on the navigation view:

.navigationTransition(.slide, interactivity: .pan) // full-pan screen gestures!

This even works to override its behavior while maintaining the default system transition in iOS:

.navigationTransition(.default, interactivity: .pan) // ✨

Installation

Add the package via Swift Package Manager:

dependencies: [
    .package(url: "https://github.com/davdroman/swiftui-navigation-transitions", from: "0.16.0"),
]

.product(name: "SwiftUINavigationTransitions", package: "swiftui-navigation-transitions"),

Documentation

The documentation for releases and main are available here:

• main
• 0.16.0

<details> <summary> Other versions </summary>

• 0.15.1
• 0.9.3
• 0.9.2
• 0.9.1
• 0.9.0
• 0.8.1
• 0.8.0
• 0.7.4
• 0.7.3
• 0.7.2
• 0.7.1
• 0.7.0
• 0.6.0
• 0.5.1

</details>

Package Metadata

Repository: davdroman/swiftui-navigation-transitions

Stars: 1068

Forks: 49

Open issues: 6

Default branch: main

Primary language: swift

License: MIT

Topics: animation, native, navigation, navigationstack, navigationview, pure, swiftui, transition, uiviewcontrollertransitioningdelegate

README: README.md