A view controller that specializes in managing a collection view.


class UICollectionViewController : UIViewController


A view controller implements the following behavior:

  • If the collection view controller has an assigned nib file or was loaded from a storyboard, it loads its view from the corresponding nib file or storyboard. If you create the collection view controller programmatically, it automatically creates a new unconfigured collection view object, which you can access using the collectionView property.

  • When loading a collection view from a storyboard or nib file, the data source and delegate objects for the collection view are obtained from the nib file. If a data source or delegate is not specified, the collection view controller assigns itself to the unspecified role.

  • When the collection view is about to appear for the first time, the collection view controller reloads the collection view data. It also clears the current selection every time the view is displayed. You can change this behavior by setting the value of the clearsSelectionOnViewWillAppear property to false.

You create a custom subclass of UICollectionViewController for each collection view that you want to manage. When you initialize the controller, using the init(collectionViewLayout:) method, you specify the layout the collection view should have. Because the initially created collection view is without dimensions or content, the collection view’s data source and delegate—typically the collection view controller itself—must provide this information.

You may override the loadView() method or any other superclass method, but if you do, be sure to call super in the implementation of your method. If you do not, the collection view controller may not be able to perform all of the tasks needed to maintain the integrity of the collection view.


Initializing the UICollectionViewController Object

init(collectionViewLayout: UICollectionViewLayout)

Initializes a collection view controller and configures the collection view with the provided layout.

init(nibName: String?, bundle: Bundle?)

Returns a newly initialized view controller with the nib file in the specified bundle

Getting the Collection View

var collectionView: UICollectionView!

The collection view object managed by this view controller.

var collectionViewLayout: UICollectionViewLayout

The layout object used to initialize the collection view controller.

Configuring the Collection View Behavior

var clearsSelectionOnViewWillAppear: Bool

A Boolean value indicating if the controller clears the selection when the collection view appears.

var installsStandardGestureForInteractiveMovement: Bool

A Boolean value indicating whether the collection view controller installs a standard gesture recognizer to drive the reordering process.

Integrating with a Navigation Controller

var useLayoutToLayoutNavigationTransitions: Bool

A Boolean that indicates whether the collection view controller coordinates with a navigation controller for transitions.

See Also

Content View Controllers

Displaying and Managing Views with a View Controller

Build a view controller in storyboards, configure it with custom views, and fill those views with your app’s data.

Showing and Hiding View Controllers

Display view controllers using different techniques, and pass data between them during transitions.

class UIViewController

An object that manages a view hierarchy for your UIKit app.

class UITableViewController

A view controller that specializes in managing a table view.

protocol UIContentContainer

A set of methods for adapting the contents of your view controllers to size and trait changes.