Class

UIPresentationController

A UIPresentationController object provides advanced view and transition management for presented view controllers. From the time a view controller is presented until the time it is dismissed, UIKit uses a presentation controller to manage various aspects of the presentation process for that view controller. The presentation controller can add its own animations on top of those provided by animator objects, it can respond to size changes, and it can manage other aspects of how the view controller is presented onscreen.

Overview

When you present a view controller using the present(_:animated:completion:) method, UIKit always manages the presentation process. Part of that process involves creating the presentation controller that is appropriate for the given presentation style. For the built-in styles (such as the pageSheet style), UIKit defines and creates the needed presentation controller object. The only time your app can provide a custom presentation controller is when you set the modalPresentationStyle property of your view controller custom. You might provide a custom presentation controller when you want to add a shadow view or decoration views underneath the view controller being presented or when you want to modify the presentation behavior in other ways.

You vend your custom presentation controller object through your view controller’s transitioning delegate. UIKit maintains a reference to your presentation controller object while the presented view controller is onscreen. For information about the transitioning delegate and the objects it provides, see UIViewControllerTransitioningDelegate.

The Presentation Process

The presentation process managed by a presentation controller is divided into three phases:

  • The presentation phase involves moving the new view controller onscreen through a series of transition animations.

  • The management phase involves responding to environment changes (such as device rotations) while the new view controller is onscreen.

  • The dismissal phase involves moving the new view controller off screen through a series of transition animations

The presentation controller’s role during all of these phases is to manage its own custom views and state information. During the presentation and dismissal phases, the presentation controller adds its custom views (if any) to the view hierarchy and creates any appropriate transition animations for those views. The animation of the view controller’s view onto the screen is still managed by an animator object—that is, an object that adopts the UIViewControllerAnimatedTransitioning protocol. UIKit calls separate presentation controller methods at the beginning and end of the presentation and dismissal phases so that the presentation controller can perform any needed cleanup.

Adding Custom Views to a Presentation

The UIPresentationController class defines specific entry points for manipulating the view hierarchy when presenting a view controller. When a view controller is about to be presented, UIKit calls the presentation controller’s presentationTransitionWillBegin() method. You can use that method to add views to the view hierarchy and set up any animations related to those views. At the end of the presentation phase, UIKit calls the presentationTransitionDidEnd(_:) method to let you know that the transition finished.

Listing 1 shows a sample implementation of the presentationTransitionWillBegin() and presentationTransitionDidEnd(_:) methods for a custom presentation controller. In this example, the view controller adds a dimming view as a backdrop to the presented view controller. (The _dimmingView variable refers to a custom UIView object that you would provide.) When presenting the view controller, the presentationTransitionWillBegin() method adds the dimming view first and embeds the view controller content inside that dimming view. It then configures a fade-in animation to run alongside the other transition animations. If the user aborts the presentation process, perhaps through an interactive gesture, the presentationTransitionDidEnd(_:) removes the dimming view. If the presentation succeeds, both the dimming view and the presented view controller remain onscreen until they are dismissed.

Listing 1

Adding a custom view during a presentation

- (void)presentationTransitionWillBegin {
   // Add a custom dimming view behind the presented view controller's view
   [[self containerView] addSubview:_dimmingView];
   [_dimmingView addSubview:[[self presentedViewController] view]];
 
   // Use the transition coordinator to set up the animations.
    id <UIViewControllerTransitionCoordinator> transitionCoordinator =
          [[self presentingViewController] transitionCoordinator];
 
   // Fade in the dimming view during the transition.
    [_dimmingView setAlpha:0.0];
    [transitionCoordinator animateAlongsideTransition:
       ^(id<UIViewControllerTransitionCoordinatorContext> context) {
          [_dimmingView setAlpha:1.0];
       } completion:nil];
}
 
- (void)presentationTransitionDidEnd:(BOOL)completed {
   // Remove the dimming view if the presentation was aborted.
   if (!completed) {
      [_dimmingView removeFromSuperview];
   }
}

When dismissing the view controller, use the dismissalTransitionWillBegin() method to configure any animations and use the dismissalTransitionDidEnd(_:) method to remove any custom views from the view hierarchy.

Adapting to Size Class Changes

Size class changes signal large-scale changes to how your app should present its content. Presentation controllers manage size class changes by adjusting the presentation style (as needed) for their presented view controller. Adjustments are made only when the current presentation style does not make sense in the new environment. For example, a popover becomes a full-screen presentation when the size class changes from horizontally regular to horizontally compact. For presentation styles that already make sense in the new environment, such as a full-screen presentation style, no adaptive change is made.

When the size class of the presented view controller changes from horizontally regular to horizontally compact, the presentation controller calls its adaptivePresentationStyle method to determine which new style (if any) to apply. When a new style is needed, the presentation controller initiates a transition to the new style, which may also involve replacing the current presentation controller object with a new object. Because the presentation controller object may change, always retrieve the presentation controller from presentationController property of the presented view controller.

When the presentation style changes, the presentation controller also gives you the opportunity to specify a new presented view controller. Before initiating the transition, the presentation controller calls the presentationController(_:viewControllerForAdaptivePresentationStyle:) method of its delegate object. If you implement that method, you can use it to make major or minor adjustments to the presented content. A major adjustment would be to replace the current view controller with an entirely new view controller that was designed specifically for the given size class. A minor adjustment would be to install the current view controller inside a navigation controller to facilitate navigation in the new size class.

Responding to Size Changes

Size changes represent small changes to the width or height of a view controller’s view. Typically, these changes happen when the device rotates between portrait and landscape orientations. When a size change occurs, UIKit calls the presentation controller’s viewWillTransition(to:with:) method. In a custom presentation, use that method to modify your presentation controller’s custom views or make changes to the view hierarchy. For example, you might swap out custom decoration views with ones that fit the new size better.

After notifying your presentation controller of an impending size change, UIKit begins the normal view layout process. Apps that use auto layout should not need to do anything because the auto layout mechanism resizes views as needed. But if a custom presentation controller needs to make layout-specific changes, it can do so in its containerViewWillLayoutSubviews() and containerViewDidLayoutSubviews() methods. These methods are equivalent to the viewWillLayoutSubviews() and viewDidLayoutSubviews() methods of the UIViewController class and used in the same way. UIKit calls them before and after it calls the layoutSubviews() methods of the views in the view hierarchy.

Subclassing Notes

For custom presentation styles, you should subclass UIPresentationController and override at least some of its methods to implement your custom presentation behaviors. Use your custom presentation controller to customize the presentation process.

For custom presentation controllers, you must call the init(presentedViewController:presenting:) method during initialization. That method is the designated initializer of the class. UIKit uses it to perform required initialization for all presentation controller objects.

Methods to Override

If your UIPresentationController subclasses manages one or more custom views, you should consider overriding the following methods:

Subclasses may override other methods of this class as needed to provide custom behavior. For example, you might override the shouldPresentInFullscreen or frameOfPresentedViewInContainerView methods and return different values than those provided by the default implementations.

Symbols

Initializing a Presentation Controller

init(presentedViewController: UIViewController, presenting: UIViewController?)

Initializes and returns a presentation controller for transitioning between the specified view controllers

Getting the Presentation Objects

var presentingViewController: UIViewController

The view controller that is the starting point for the presentation.

var presentedViewController: UIViewController

The view controller being presented.

var containerView: UIView?

The view in which the presentation occurs.

var presentedView: UIView?

The view to be animated by the animator objects during a transition.

Adjusting the Size and Layout of the Presentation

var frameOfPresentedViewInContainerView: CGRect

The frame rectangle to assign to the presented view at the end of the animations.

var overrideTraitCollection: UITraitCollection?

Interface traits for the presented view controller, to use in place of traits from the iOS environment.

func containerViewWillLayoutSubviews()

Notifies the presentation controller that layout is about to begin on the views of the container view.

func containerViewDidLayoutSubviews()

Called to notify the presentation controller that layout ended on the views of the container view.

Tracking the Transition’s Start and End

func presentationTransitionWillBegin()

Notifies the presentation controller that the presentation animations are about to start.

func presentationTransitionDidEnd(Bool)

Notifies the presentation controller that the presentation animations finished.

func dismissalTransitionWillBegin()

Notifies the presentation controller that the dismissal animations are about to start.

func dismissalTransitionDidEnd(Bool)

Notifies the presentation controller that the dismissal animations finished.

Getting the Presentation Attributes

var presentationStyle: UIModalPresentationStyle

The presentation style of the presented view controller.

func adaptivePresentationStyle(for: UITraitCollection)

Returns the presentation style to use for the specified set of traits.

var adaptivePresentationStyle: UIModalPresentationStyle

Returns the presentation style to use when the presented view controller becomes horizontally compact.

var shouldPresentInFullscreen: Bool

A Boolean value indicating whether the presentation covers the entire screen.

var shouldRemovePresentersView: Bool

A Boolean value indicating whether the presenting view controller’s view should be removed when the presentation animations finish.

Accessing the Delegate

var delegate: UIAdaptivePresentationControllerDelegate?

The delegate object for managing adaptive presentations.