Swift: How to refresh UICollectionView layout after rotation of the device

Question

I used UICollectionView (flowlayout) to build a simple layout. the width for each cell is set to the width of screen using self.view.frame.width

but when I rotate the device, the cells don't get updated.

I have found a function, which is called upon orientation change :

override func willRotateToInterfaceOrientation(toInterfaceOrientation: 
  UIInterfaceOrientation, duration: NSTimeInterval) {
    //code
}

but I am unable to find a way to update the UICollectionView layout

The main code is here:

class ViewController: UIViewController , UICollectionViewDelegate , UICollectionViewDataSource , UICollectionViewDelegateFlowLayout{

    @IBOutlet weak var myCollection: UICollectionView!

    var numOfItemsInSecOne: Int!
    override func viewDidLoad() {
        super.viewDidLoad()

        numOfItemsInSecOne = 8
        // Do any additional setup after loading the view, typically from a nib.
    }

    override func didReceiveMemoryWarning() {
        super.didReceiveMemoryWarning()
        // Dispose of any resources that can be recreated.
    }

    override func willRotateToInterfaceOrientation(toInterfaceOrientation: UIInterfaceOrientation, duration: NSTimeInterval) {

        //print("orientation Changed")
    }

    func numberOfSectionsInCollectionView(collectionView: UICollectionView) -> Int {
        return 1
    }

    func collectionView(collectionView: UICollectionView, numberOfItemsInSection section: Int) -> Int {
        return numOfItemsInSecOne
    }

    func collectionView(collectionView: UICollectionView, cellForItemAtIndexPath indexPath: NSIndexPath) -> UICollectionViewCell {
        let cell = collectionView.dequeueReusableCellWithReuseIdentifier("cellO", forIndexPath: indexPath)

        return cell
    }

    func collectionView(collectionView: UICollectionView, layout collectionViewLayout: UICollectionViewLayout, sizeForItemAtIndexPath indexPath: NSIndexPath) -> CGSize{
    let itemSize = CGSize(width: self.view.frame.width, height: 100)
    return itemSize
    }}

Twitter khuong291 · Accepted Answer · 2017-11-05T15:33:41.177

101

Add this function:

override func viewDidLayoutSubviews() {
    super.viewDidLayoutSubviews() 
    myCollection.collectionViewLayout.invalidateLayout()
}

When you change the orientation, this function would be called.

edited Nov 05 '17 at 15:33

answered Apr 27 '16 at 08:34

Twitter khuong291

11,328
15
80
116

thanks @khuong291 what if I have no object of my collectionview, and I have UICollectionViewController ? how will I suppose to call reloadData? – Talha Ahmad Khan Apr 27 '16 at 08:48
2

UICollectionViewController already has `collectionView` property, so you just call them as I said. Just edit them into `collectionView.reloadData()`. It will work. – Twitter khuong291 Apr 27 '16 at 08:52
2

So you need to reload the view, you can't just trigger a layout refresh? – Rivera Apr 27 '16 at 13:18
2

check @kelin's answer `.invalidateLayout()` makes a lot lot of sense. – geekay Feb 15 '17 at 11:05
1

`viewDidLayoutSubviews` makes my app crash when going back to portrait because old layout cells are too big. `viewWillLayoutSubviews ` works perfectly – jfgrang Sep 07 '18 at 12:43
@Khuong it's work for me but some time cells are too big while going from landscape view to portrait. why happen like this? – Nikunj Kumbhani Sep 20 '18 at 11:18
@NikunjKumbhani If so, I think you set layout wrong, please check it again. – Twitter khuong291 Sep 22 '18 at 07:37
1

Thanks for your code but it didn't work in my case too but solved it using notification. Here is the way how it work on my case https://stackoverflow.com/questions/18653171/issue-with-pagination-in-uicollectionview-when-orientation-changes – Yuvraj Bashyal Oct 04 '18 at 03:47
I had to useAs @jfgrang proposed, i had to use `viewWillLayoutSubviews` to really get the height and width of the cells re-calculated properly... I'd however did not crash in either case. – Hons Dec 03 '18 at 13:52
4

app hangs on app launch after using this. – rv7284 Jul 18 '19 at 05:29
4

This solution is not efficient as `viewDidLayoutSubviews()` is called many times when user scrolls the cells of the `UICollectionView`. – Imanou Petit Sep 04 '19 at 00:03
This should be viewWillLayout – Dan Rosenstark Nov 07 '19 at 12:56
I agree with @jfgrang: overriding `viewWillLayoutSubviews` is the only way I could get it to work (Xcode 11.4.1 + iOS 13.3). – titusmagnus Apr 30 '20 at 02:33
```viewWillTransitionToSize``` worked, ```viewDidLayoutSubviews``` hanged the app. – Aidy May 16 '20 at 15:29
I currently use `viewWillTransitionToSize`, but, does not seem as bullet proof as `viewDidLayoutSubviews`. viewDidLayoutSubviews kills performance though. – zumzum Mar 26 '21 at 22:15
`viewDidLayoutSubviews` does not work correctly for devices with no safeAreaInset. `viewWillTransitionToSize` worked in my case - with nested collectionView inside of collectionViewCell. – dvp.petrov Feb 14 '23 at 08:09

kelin · Answer 2 · 2017-08-12T09:01:29.097

69

The better option is to call invalidateLayout() instead of reloadData() because it will not force recreation of the cells, so performance will be slightly better:

override func viewWillLayoutSubviews() {
    super.viewWillLayoutSubviews() 
    myCollection.collectionViewLayout.invalidateLayout()
}

edited Aug 12 '17 at 09:01

answered Feb 11 '17 at 09:51

kelin

11,323
6
67
104

This is the correct way. This should be the accepted answer. – geekay Feb 15 '17 at 11:03
this is the correct way to do it.. not the reload data again – Abdul Waheed Apr 18 '17 at 05:23
9

that caused a crush for me. and an infinite loop recognized when i put a print statement in the viewDidLayoutSubviews function. – nyxee Jul 21 '17 at 07:27
2

@nyxee, try `viewWillLayoutSubviews` then. I bet, your Collection View is the view of the View Controller? If so, I recommend to wrap it into another view. – kelin Jul 21 '17 at 08:55
thanks.. I'll get back to that at some point. I've switched to tableViews for now. I was using the UICollectionViewController. – nyxee Jul 23 '17 at 05:06
@kelin May I suggest you change your answer to `viewWillLayoutSubviews`? As it is, the layout doesn't update correctly in current iOS versions. – Alexandre Cassagne Aug 11 '17 at 14:36
This might cause endless loops. @birdy's answer works better – arionik Apr 26 '18 at 21:26
6

The endless loop occurs if you use `UICollectionViewController`, because in this case the `collectionView` is also the view of the controller. So if you change `collectionView` layout `viewWillLayoutSubviews` and related methods will be called. – kelin Apr 26 '18 at 21:58
I tried every other highly voted answer in this thread and this is the only one **that worked**. Btw my collectionView is a subView of the viewController(`view.addSubview(myCollectionView)` -added in viewDidLoad). I put a print statement inside `viewWillLayoutSubviews` and it only printed on rotations. I didn't have any endless loops. – Lance Samaria Apr 07 '21 at 19:42
This answer worked for me last year and now it's not working in a new project. Very strange. – Lance Samaria Jun 13 '22 at 14:30

score 20 · Answer 3 · answered Oct 24 '17 at 07:21

Also you can invalidate it in this way.

- (void)viewWillTransitionToSize:(CGSize)size withTransitionCoordinator:(id<UIViewControllerTransitionCoordinator>)coordinator {
    [super viewWillTransitionToSize:size withTransitionCoordinator:coordinator];

    [self.collectionView.collectionViewLayout invalidateLayout]; 
}

score 18 · Answer 4 · answered Jan 09 '18 at 20:12

18

The viewWillLayoutSubviews() did not work for me. Neither did viewDidLayoutSubviews(). Both made the app go into an infinite loop which I checked using a print command.

One of the ways that do work is

override func viewWillTransition(to size: CGSize, with coordinator: UIViewControllerTransitionCoordinator) {
// Reload here
}

answered Jan 09 '18 at 20:12

The Doctor

486
1
6
16

21

Don't forget to call `super.viewWillTransition...` – d4Rk May 16 '18 at 12:49

score 17 · Answer 5 · edited May 20 '21 at 11:18

When UICollectionLayout detects a bounds change, it asks if it needs to reroute the Invalidate layout. You can rewrite the method directly.UICollectionLayout can call invalidateLayout method at the right time

class CollectionViewFlowLayout: UICollectionViewFlowLayout{
    
    /// The default implementation of this method returns false.
    /// Subclasses can override it and return an appropriate value
    /// based on whether changes in the bounds of the collection
    /// view require changes to the layout of cells and supplementary views.
    /// If the bounds of the collection view change and this method returns true,
    /// the collection view invalidates the layout by calling the invalidateLayout(with:) method.
    override func shouldInvalidateLayout(forBoundsChange newBounds: CGRect) -> Bool {
        
        return (self.collectionView?.bounds ?? newBounds) != newBounds
    }
}

score 14 · Answer 6 · edited Mar 31 '20 at 13:32

14

To update UICollectionViewLayout, traitCollectionDidChange method might be used as well:

override func traitCollectionDidChange(_ previousTraitCollection: UITraitCollection?) {
    super.traitCollectionDidChange(previousTraitCollection)

    guard previousTraitCollection != nil else { return }
    collectionView?.collectionViewLayout.invalidateLayout()
}

edited Mar 31 '20 at 13:32

fredpi

8,414
5
41
61

answered Dec 06 '17 at 15:18

birdy

943
13
25

2

This worked best for me, the approach required is really dependent of your application of CollectionView, in my instance this was more compatible with the other behaviours of my custom FlowLayout than the other solutions because my items all have the same size that is dependent on the traitCollection – Rocket Garden Aug 19 '18 at 13:27
3

Brilliant - it also works when instantiating the UICollectionView within a custom UITableViewCell. – DrWhat Apr 29 '19 at 14:24
2

This solution doesn't work on iPad, because the horizontal trait and vertical trait are unchanged. – tphduy Aug 24 '21 at 07:44

score 11 · Answer 7 · answered Nov 06 '19 at 12:53

11

Please understand this

traitCollectionDidChange(previousTraitCollection :) won't be called on iPad when it is rotated, because size class is .regular in both portrait and landscape orientations. There's viewWillTransition(to:with:) that will be called whenever collection view size changes.

Also you shouldn't use UIScreen.mainScreen().bounds if your app supports multitasking as it might not occupy the whole screen, better use collectionView.frame.width for that.

answered Nov 06 '19 at 12:53

Mehul

3,033
23
37

1

TanX!!! You saved me hours! I change `UIScreen.main.bounds.width` to `collectionView.frame.width` and boom! Fixed! – Hamed Ghadirian May 17 '21 at 19:54
Your Welcome @HamedGhadirian Enjoy – Mehul May 19 '21 at 05:41

score 8 · Answer 8 · edited Sep 28 '20 at 22:07

8

My Code :

override func viewWillLayoutSubviews() {
   super.viewWillLayoutSubviews()
   self.collectionView.collectionViewLayout.invalidateLayout()
}

Will work correctly!!!

edited Sep 28 '20 at 22:07

Duck

34,902
47
248
470

answered Jan 13 '20 at 12:34

Кирилл Старосельский

99
1
4

1

this is the same answer as @kelin's answer https://stackoverflow.com/a/42174492/4833705 – Lance Samaria Apr 07 '21 at 19:45

Michael · Answer 9 · 2019-01-23T10:12:44.570

Calling viewWillLayoutSubviews is not optimal. Try calling the invalidateLayout() method first.

If you experience the The behaviour of the UICollectionViewFlowLayout is not defined error, you need to verify if all the elements within your view's have changed its sizes, according to a new layout. (see the optional steps within the example code)

Here is the code, to get you started. Depending on the way your UI is created, you may have to experiment to find the right view to call the recalculate method, yet that should guide you towards your first steps.

override func viewWillTransition(to size: CGSize, with coordinator: UIViewControllerTransitionCoordinator) {

    super.viewWillTransition(to: size, with: coordinator)

    /// (Optional) Additional step 1. Depending on your layout, you may have to manually indicate that the content size of a visible cells has changed
    /// Use that step if you experience the `the behavior of the UICollectionViewFlowLayout is not defined` errors.

    collectionView.visibleCells.forEach { cell in
        guard let cell = cell as? CustomCell else {
            print("`viewWillTransition` failed. Wrong cell type")
            return
        }

        cell.recalculateFrame(newSize: size)

    }

    /// (Optional) Additional step 2. Recalculate layout if you've explicitly set the estimatedCellSize and you'll notice that layout changes aren't automatically visible after the #3

    (collectionView.collectionViewLayout as? CustomLayout)?.recalculateLayout(size: size)


    /// Step 3 (or 1 if none of the above is applicable)

    coordinator.animate(alongsideTransition: { context in
        self.collectionView.collectionViewLayout.invalidateLayout()
    }) { _ in
        // code to execute when the transition's finished.
    }

}

/// Example implementations of the `recalculateFrame` and `recalculateLayout` methods:

    /// Within the `CustomCell` class:
    func recalculateFrame(newSize: CGSize) {
        self.frame = CGRect(x: self.bounds.origin.x,
                            y: self.bounds.origin.y,
                            width: newSize.width - 14.0,
                            height: self.frame.size.height)
    }

    /// Within the `CustomLayout` class:
    func recalculateLayout(size: CGSize? = nil) {
        estimatedItemSize = CGSize(width: size.width - 14.0, height: 100)
    }

    /// IMPORTANT: Within the `CustomLayout` class.
    override func shouldInvalidateLayout(forBoundsChange newBounds: CGRect) -> Bool {

        guard let collectionView = collectionView else {
            return super.shouldInvalidateLayout(forBoundsChange: newBounds)
        }

        if collectionView.bounds.width != newBounds.width || collectionView.bounds.height != newBounds.height {
            return true
        } else {
            return false
        }
    }

score 3 · Answer 10 · answered Apr 27 '16 at 08:57

you can update your UICollectionView Layout by using

func collectionView(collectionView: UICollectionView, layout collectionViewLayout: UICollectionViewLayout, sizeForItemAtIndexPath indexPath: NSIndexPath) -> CGSize {
    if isLandscape {
        return CGSizeMake(yourLandscapeWidth, yourLandscapeHeight)
    }
    else {
        return CGSizeMake(yourNonLandscapeWidth, yourNonLandscapeHeight)
    }
}

score 3 · Answer 11 · answered Apr 20 '19 at 14:56

3

It works for me. And this is code in Objective-C:

- (void)viewDidLayoutSubviews {
  [super viewDidLayoutSubviews];
  [collectionView.collectionViewLayout invalidateLayout];
}

answered Apr 20 '19 at 14:56

congpc87

198
1
9

score 2 · Answer 12 · answered Sep 11 '18 at 18:00

I was also having some problem but then it got solved using :

override func viewWillTransition(to size: CGSize, with coordinator: UIViewControllerTransitionCoordinator) {
        collectionViewFlowLayoutSetup(with: view.bounds.size.width)
        collectionView?.collectionViewLayout.invalidateLayout()
        collectionViewFlowLayoutSetup(with: size.width)
    }

    fileprivate func collectionViewFlowLayoutSetup(with Width: CGFloat){

        if let flowLayout = collectionViewLayout as? UICollectionViewFlowLayout {
            flowLayout.estimatedItemSize = CGSize(width: Width, height: 300)
        }

    }

score 2 · Answer 13 · answered Oct 04 '18 at 03:41

I solve this by setting notification when screen orientation changes and reloading cell which set itemsize according to screen orientation and setting indexpath to previous cell. This does work with flowlayout too. Here is the code i wrote:

var cellWidthInLandscape: CGFloat = 0 {
    didSet {
        self.collectionView.reloadData()
    }
}

var lastIndex: Int = 0

override func viewDidLoad() {
    super.viewDidLoad()

    collectionView.dataSource = self
    collectionView.delegate = self
    NotificationCenter.default.addObserver(self, selector: #selector(rotated), name: NSNotification.Name.UIDeviceOrientationDidChange, object: nil)
    cellWidthInLandscape = UIScreen.main.bounds.size.width

}
deinit {
    NotificationCenter.default.removeObserver(self)
}
@objc func rotated() {

        // Setting new width on screen orientation change
        cellWidthInLandscape = UIScreen.main.bounds.size.width

       // Setting collectionView to previous indexpath
        collectionView.scrollToItem(at: IndexPath(item: lastIndex, section: 0), at: .right, animated: false)
}
    override func viewWillTransition(to size: CGSize, with coordinator: UIViewControllerTransitionCoordinator) {
        NotificationCenter.default.addObserver(self, selector: #selector(rotated), name: NSNotification.Name.UIDeviceOrientationDidChange, object: nil)

}

func scrollViewDidEndDecelerating(_ scrollView: UIScrollView) {

   // Getting last contentOffset to calculate last index of collectionViewCell
    lastIndex = Int(scrollView.contentOffset.x / collectionView.bounds.width)
}

func collectionView(_ collectionView: UICollectionView, layout collectionViewLayout: UICollectionViewLayout, sizeForItemAt indexPath: IndexPath) -> CGSize {
        // Setting new width of collectionView Cell
        return CGSize(width: cellWidthInLandscape, height: collectionView.bounds.size.height)

}

score 2 · Answer 14 · answered Sep 05 '22 at 10:36

Same times the selected cell is not centered after landscape to portrait orientation change. I solve this problem like this:

override func viewWillTransition(to size: CGSize, with coordinator: UIViewControllerTransitionCoordinator) {
    super.viewWillTransition(to: size, with: coordinator)

    //Scroll to current Item after the orientation change. Sometimes the current item is not centered.
    coordinator.animate(alongsideTransition: { context in
        self.housesCollectionView.collectionViewLayout.invalidateLayout()
        self.housesCollectionView.scrollToItem(at: self.selectedHouseIndexPath, at: .left, animated: true)
    })
}

score 1 · Answer 15 · edited Mar 26 '19 at 15:25

1

I solved the issue using below method

override func viewDidLayoutSubviews() {
        if let flowLayout = collectionView.collectionViewLayout as? UICollectionViewFlowLayout {
            collectionView.collectionViewLayout.invalidateLayout()
            collectionView.collectionViewLayout = flowLayout
        }
    }

edited Mar 26 '19 at 15:25

Community

1
1

answered Feb 14 '19 at 11:34

CrazyPro007

1,006
9
15

score 1 · Answer 16 · answered Nov 14 '21 at 04:24

In addition to what everybody else already mentioned, if you are creating the collection view yourself instead of subclassing UICollectionViewController, don't forget to set:

collectionView.translatesAutoresizingMaskIntoConstraints = false

When setting up the constraints.

score -1 · Answer 17 · answered Aug 06 '21 at 04:57

Try this:

class CollectionViewFlowLayout: UICollectionViewFlowLayout {

override func invalidationContext(forBoundsChange newBounds: CGRect) -> UICollectionViewLayoutInvalidationContext {
    let context = super.invalidationContext(forBoundsChange: newBounds) as! UICollectionViewFlowLayoutInvalidationContext
    if let collectionView = collectionView {
        context.invalidateFlowLayoutDelegateMetrics = collectionView.bounds.size != newBounds.size
    }
    return context
  }

}

Documentation :

The default value of this property is false. Set this property to true if you are invalidating the layout because of changes to the size of any items. When this property is set to true, the flow layout object recomputes the size of its items and views, querying the delegate object as needed for that information.

Swift: How to refresh UICollectionView layout after rotation of the device

17 Answers17

Linked