NEW: Got a question? Get help on our new forums! >>

How to use view controller containment

Swift version: 5.1

Paul Hudson    @twostraws   

View controller containment allows you to embed one view controller inside another, which can simplify and organize your code. It takes four steps:

  1. Call addChild() on your parent view controller, passing in your child.
  2. Set the child’s frame to whatever you need, if you’re using frames.
  3. Add the child’s view to your main view, along with any Auto Layout constraints.
  4. Call didMove(toParent:) on the child, passing in your main view controller.

In Swift code it looks like this:

addChild(child)
child.view.frame = frame
view.addSubview(child.view)
child.didMove(toParent: self)

When you’re finished with it, the steps are conceptually similar but in reverse:

  1. Call willMove(toParent:), passing in nil.
  2. Remove the child view from its parent.
  3. Call removeFromParent() on the child.

In code, it’s just three lines:

willMove(toParent: nil)
view.removeFromSuperview()
removeFromParent()

Just for convenience you might want to consider adding a small, private extension to UIViewController to do these tasks for you – they do need to be run in a precise order, which is easily done incorrectly.

Something like this ought to do it:

@nonobjc extension UIViewController {
    func add(_ child: UIViewController, frame: CGRect? = nil) {
        addChild(child)

        if let frame = frame {
            child.view.frame = frame
        }

        view.addSubview(child.view)
        child.didMove(toParent: self)
    }

    func remove() {
        willMove(toParent: nil)
        view.removeFromSuperview()
        removeFromParent()
    }
}

That’s marked @nonobjc so it won’t conflict with any of Apple’s own code, now or in the future.

Hacking with Swift is sponsored by Instabug

SPONSORED Catch bugs as soon as they happen and know exactly why a crash occurred by integrating Instabug's SDK in one minute. You will automatically receive device data, network logs, and reproduction steps with every bug and crash report.

Learn more and get started for free

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

Cascable unleashes the power of your camera and unlocks powerful workflows for shooting, managing, and geotagging your photos.

Available from iOS 5.0 – learn more in my book Swift Design Patterns

Similar solutions…

About the Swift Knowledge Base

This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.

BUY OUR BOOKS
Buy Pro Swift Buy Swift Design Patterns Buy Testing Swift Buy Hacking with iOS Buy Swift Coding Challenges Buy Swift on Sundays Volume One Buy Server-Side Swift (Vapor Edition) Buy Advanced iOS Volume One Buy Advanced iOS Volume Two Buy Advanced iOS Volume Three Buy Hacking with watchOS Buy Hacking with tvOS Buy Hacking with macOS Buy Dive Into SpriteKit Buy Swift in Sixty Seconds Buy Objective-C for Swift Developers Buy Server-Side Swift (Kitura Edition) Buy Beyond Code

Was this page useful? Let us know!

Average rating: 4.4/5