Reloading collectionview does not maintain content offset

[ChengmingLu]

Describe the bug
When reloadData() is called, the collectionView sometimes doesn't preserve the scrolling position, causing the collectionView to jump abruptly

To Reproduce
Steps to reproduce the behavior:

1. Open and run the stock example project (workspacce) under MagazineLayoutExample
2. Please see the attached gif to reproduce this issue
   Note: this doesn't occur every time, you need to adjust scrolling position before reloading the data if you cannot reproduce it at the beginning

Expected behavior
The screen should maintain its position after reloading data

Screenshots

Smartphone (please complete the following information):

• Simulator: iPhone 11 Pro Max
• OS: iOS 13.0
• Version: current

Additional context
Not sure if this could be a bug in UICollectionView rather than MagazineLayout, please advise.

[Sparrow-Iv]

The problem is still relevant, is there any solution?

[eliotwjohnson]

We're experiencing this issue as well. Any time a reload occurs when the collection view is scrolled, its contentSize and contentOffset change, resulting in the jump. @bryankeller are there any known workarounds for this?

[acecilia]

Maybe related:

• https://engineering.shopspring.com/misplaced-views-and-choppy-scrolling-with-dynamically-sized-collection-view-cells-4010c02fbaae
• Self-sizing mode cause scroll jumping #9

[ghost]

I am also experiencing this issue. Whenever a reload happens, when the collection view is scrolled, its contentOffset change, resulting in the jump. @bryankeller is there any known fix/solution for the same?

[ghost]

Seems like once we scroll the view and then on reload of data content size of collection view is not same as before even though data is same. Self sizing return different content size each time. I also looked into the item size returned in method preferredLayoutAttributesFitting which is same for items before and after reload of data.

@bryankeller does any one looking into this issue?

[maxcox]

This issue occurs in UICollectionView usually when implementing self-sizing cells but there are workarounds to get past it. Unfortunately the UICollectionViewDelegateFlowLayout methods we conform to in order to perform the workaround are not accessible when using MagazineLayout. Is there any possibility we can get a fix for this within MagazineLayout?

[Danie1s]

use .static heightMode can solve this problem

[alexookah]

I am also experiencing this problem. Are there any plans to fix it?
Similar issue was happening on rotation and was fixed.
Maybe the same resolution could also be applied here.
@maxcox Could you share your UICollectionViewDelegateFlowLayout methods that get past this problem?

[elliot-vu]

Good news! My PR is merged into the master branch. #113
I have a approach that cache collection view cell height when cell will appear. And input to sizeModeForItemAt delegate method. It look like this:

func collectionView(
    _ collectionView: UICollectionView,
    layout collectionViewLayout: UICollectionViewLayout,
    sizeModeForItemAt indexPath: IndexPath)
    -> MagazineLayoutItemSizeMode {
  if let cachedHeight = cachedHeightStorage[indexPath] {
     return MagazineLayoutItemSizeMode(widthMode: fullWidth(respectsHorizontalInsets: 10), heightMode: .dynamic(estimatedHeight : cachedHeight))
  }

  return MagazineLayoutItemSizeMode(widthMode: fullWidth(respectsHorizontalInsets: 10), heightMode: .dynamic)
}