Swiftpack.co - Package - malcommac/UIWindowTransitions

This is a small project used to demostrate how to implement UIWindow's rootViewController transitions with a little piece of code. You can found the original article for this article here.

Motivation

Sometimes during the lifecycle of an application you may need to change the rootViewController of your main UIWindow ; a typical case maybe the transition between the initial on-boarding and the home of the app (ie. a UITabBarController ).

In order to handle this edge case you may want to create a top controller (typically an UINavigationController with invisible navigation bar) which enable you to push your new container using a standard push animation.

While basically it works fine, the addition of a container used only to handle this single operation is a bit awful to see.

A way better solution is to apply an animated transition (push/pop or slide) to the rootViewController set so you will get an animate switch from the current view controller to the new one.

In fact, even if not exposed, you can and its really simple to accomplish via CoreAnimation and CATransition .

The following code implements a new function as extension of UIWindow class; it takes two arguments: the destination controller and options.

As you may imagine the destination controller is the controller you want to set as new rootViewController, while options is struct used to group some typical CoreAnimation settings: the animation direction (pop/push/slide from top or bottom), the animation curve (linear, ease in/out), the duration of the animation (by default is 0.25s) and an optional UIView instance used to fade in/out between the old and new view.

Known Issue & Fix

The 1.0.0 fixes and issue with iOS currently opened as radar here. This fix was created by voltbank in his repository ReplaceRootViewController forked from this project.

❤️ Your Support

Hi fellow developer!
You know, maintaing and developing tools consumes resources and time. While I enjoy making them your support is foundamental to allow me continue its development.

If you are using SwiftLocation or any other of my creations please consider the following options:

How to use it

Once implemented you can use the only function exposed to all UIWindow instances called

func set(rootViewController newRootViewController: UIViewController, options: TransitionOptions = TransitionOptions(), _ completion:((Bool) -> Void)? = nil)

where:

  • controller: the destination view controller to set as new rootViewController
  • options: a TransitionOptions with the following properties:
    • duration: duration of the animation (expressed in TimeInterval, seconds, default is 0.25)
    • direction: direction of the transition (toRight,toLeft,toTop,toBottom, default is .toRight)
    • style: animation curve (linear,easeIn,easeOut,easeInOut, default is .linear)
    • background: background view set for fade in-out into the old/new controller (by default is nil).
  • completion: completion callback to receive info when transition did completes.

The following code change the rootViewController using a ease out - slide up animation of 0.4 seconds.

let wnd = UIApplication.shared.keyWindow
var options = UIWindow.TransitionOptions()
options.direction = .toTop
options.duration = 0.4
options.style = .easeOut
wnd?.set(rootViewController(newVC, options: options)

If you just need of a simple push (like UINavigationController's push) you can call it without the options arg:

wnd?.set(rootViewController(newVC)

Demo App

The following demo is available inside the project's demo application.

Installation

You can install UIWindowTransitions using CocoaPods, Carthage and Swift package manager

pod 'UIWindowTransitions'

CocoaPods

use_frameworks!
pod 'UIWindowTransitions'

Swift Package Manager

Add UIWindowTransitions as dependency in your Package.swift

import PackageDescription

let package = Package(name: "YourPackage",
	dependencies: [
		.Package(url: "https://github.com/malcommac/UIWindowTransitions.git", majorVersion: 0),
	]
)

Contributing

  • If you need help or you'd like to ask a general question, open an issue.
  • If you found a bug, open an issue.
  • If you have a feature request, open an issue.
  • If you want to contribute, submit a pull request.

Copyright & Acknowledgements

UIWindowTransitions is currently owned and maintained by Daniele Margutti.
You can follow me on Twitter @danielemargutti.
My web site is https://www.danielemargutti.com

This software is licensed under MIT License.

Follow me on:

Github

link
Stars: 401

Dependencies

Used By

Total: 0

Releases

UIWindowTransitions 1.0.0 - Swift 5.x+ -

Released on 2020-11-15

Changes

  • #10 [NEW] Updated for Swift 5 both SPM and CocoaPods package
  • #13 [NEW] Added completion handler for set(rootViewController:options:completion:)
  • #7 [FIX] Fix issue with iOS memory leak when changing view controller

UIWindowTransitions 0.2.0 - Swift 4.x -

Released: on 2019-01-26

Changes

  • #8 Introduced snapshot option which creates a snapshot of the current root view controller before the transaction.

UIWindowTransitions 0.1.1 - Swift 4.x -

Released on: 2017-11

First stable release

UIWindowTransitions 0.1.2 - Swift 4.x -

Released on: 2018-09-21

Changes

  • #5 Added compatibility to Swift 4.2 (XCode 10)