How to install Kaeru using Carthage?

Kaeru supports Carthage installation. Add 'github "bannzai/Kaeru"' to your Cartfile, run 'carthage update', and integrate the framework into your Xcode project as per Carthage's standard procedures.

Can Kaeru be used in SwiftUI-based iOS apps?

Kaeru is built on UIKit and UINavigationController, so it's not directly compatible with SwiftUI's navigation patterns. You would need to wrap it in a UIViewControllerRepresentable or use it in mixed UIKit-SwiftUI projects.

Kaeru vs implementing a custom history navigation: which should I choose?

Kaeru is best for quick implementation with a native iOS feel, saving development time. However, if you need full control over customization or delegate callbacks, a custom solution might be better despite the higher effort.

How to change the snapshot size or layout in Kaeru?

The README does not provide options for customizing snapshot size or grid layout. Kaeru uses a fixed design mimicking iOS task manager, so modifications would require forking the library and altering the source code.

Does Kaeru support iOS 13 dark mode or later versions?

Kaeru likely inherits system appearance settings since it uses standard UIKit components. However, specific dark mode support isn't documented, so you may need to test or adjust the background view for compatibility.

How to handle memory when Kaeru displays many view controller snapshots?

Kaeru generates snapshots of view controllers, which can consume memory. For apps with deep navigation stacks, consider implementing snapshot caching or limiting the history depth, though Kaeru doesn't provide built-in options for this.

Open-Awesome

Kaeru

MITSwift

A UINavigationController subclass that enables iOS task manager-style view controller switching with snapshots.

GitHub

514 stars28 forks0 contributors

What is Kaeru?

Kaeru is an iOS library that extends UINavigationController to provide a visual task manager-style interface for switching between view controllers. It displays snapshots of the navigation stack in a scrollable grid, allowing users to tap and navigate back to any previous view controller with smooth animations. This solves the problem of deep navigation stacks becoming cumbersome to traverse using standard back buttons.

Target Audience

iOS developers building apps with complex navigation flows or those wanting to enhance user experience with intuitive navigation patterns. It's particularly useful for applications where users frequently need to jump back multiple steps in the view hierarchy.

Value Proposition

Developers choose Kaeru because it provides a native iOS task manager UI without requiring extensive custom implementation. It's a lightweight, drop-in solution that integrates seamlessly with existing UINavigationController-based apps while offering familiar iOS interaction patterns.

Overview

Switch viewcontroller like ios task manager

Use Cases

Best For

Adding visual navigation history to iOS apps
Implementing task manager-style interfaces in Swift
Enhancing user experience in apps with deep navigation hierarchies
Creating intuitive back navigation beyond standard back buttons
Building iOS apps that mimic system navigation patterns
Quickly prototyping advanced navigation interfaces

Not Ideal For

Apps targeting iOS versions before iOS 9, as the UI design mimics post-iOS 9 task manager features.
Projects requiring detailed navigation delegate callbacks for events like view controller presentation or dismissal, since Kaeru's TODO list indicates this feature is missing.
Teams needing highly customizable navigation interfaces with adjustable grid layouts or animation timings, as Kaeru only allows background view customization.

Pros & Cons

Pros

Native iOS Integration

Seamlessly replaces UINavigationController with minimal code changes, supporting both storyboard and programmatic setup as shown in the README examples.

Familiar User Experience

Mimics the iOS task manager UI, providing an intuitive way for users to navigate back through view controller history without additional instructions.

Easy Customization Start

Offers the ability to set a custom background view when presenting the history, allowing for basic visual tailoring without complex modifications.

Smooth Visual Feedback

Includes scale animations when users tap snapshots, enhancing the perception of navigation and making transitions feel natural.

Cons

Missing Delegate Support

The library currently lacks delegate methods for navigation events, which limits advanced control and integration with existing app logic, as noted in the TODO list.

Limited Design Flexibility

Beyond changing the background, developers cannot modify the grid layout, snapshot appearance, or animation styles, restricting creative design options.

Untested Stability

With testing listed as a pending item in the TODO, the code may have undiscovered bugs or performance issues, making it risky for critical production apps.

Frequently Asked Questions

Related Projects

Hero

Elegant transition library for iOS & tvOS

Stars22,482

Forks1,733

Last commit1 year ago

BubbleTransition

A custom modal transition that presents and dismiss a controller with an expanding bubble effect.

Stars3,303

Forks247

Last commit5 years ago

SPStorkController

Now playing controller from Apple Music, Mail & Podcasts Apple's apps.

Stars2,733

Forks201

Last commit3 years ago

Transition

Easy interactive interruptible custom ViewController transitions

Stars2,627

Forks127