Why isn't onPreferenceChange being called if it's inside a ScrollView in SwiftUI?

Question

I\'ve been seeing some strange behavior for preference keys with ScrollView. If I put the onPreferenceChange inside the ScrollView it won\'t be cal

Answer 1

You may only read it in superView, but you can change it with transformPreference after you set it .

struct ContentView: View {
var body: some View {
    ScrollView {
        VStack{
        Text("Hello")
            .preference(key: WidthPreferenceKey.self, value: 20)
        }.transformPreference(WidthPreferenceKey.self, {
        $0 = 30})
    }.onPreferenceChange(WidthPreferenceKey.self) {
        print($0)
    }
}
}

The last value is 30 now. Hope it is what you want.

You can read from other layer:

  ScrollView {

        Text("Hello").preference(key: WidthPreferenceKey.self, value: CGFloat(40.0))
            .backgroundPreferenceValue(WidthPreferenceKey.self) { x -> Color in
               print(x)
                return Color.clear
        }

    }

Answer 2

I think onPreferenceChange in your example is not called because it’s function is profoundly different from preference(key…)

preference(key:..) sets a preference value for the view it is used on. whereas onPreferenceChange is a function called on a parent view – a view on a higher position in the view tree hierarchy. Its function is to go through all its children and sub-children and collect their preference(key:) values. When it found one it will use the reduce function from the PreferenceKey on this new value and all the already collected values. Once it has all the values collected and reduced them it will execute the onPreference closure on the result.

In your first example this closure is never called because the Text(“Hello”) view has no children which set the preference key value (in fact the view has no children at all). In your second example the Scroll view has a child which sets its preference value (the Text view).

All this does not explain the multiple times per frame error – which is most likely unrelated.

Recent update (24.4.2020): In a similar case I could induce the call of onPreferenceChange by changing the Equatable condition for the PreferenceData. PreferenceData needs to be Equatable (probably to detect a change in them). However, the Anchor type by itself is not equatable any longer. To extract the values enclosed in an Anchor type a GeometryProxy is required. You get a GeometryProxy via a GeometryReader. For not disturbing the design of views by enclosing some of them into a GeometryReader I generated one in the equatable function of the PreferenceData struct:

struct ParagraphSizeData: Equatable {
  let paragraphRect: Anchor<CGRect>?

  static func == (value1: ParagraphSizeData, value2: ParagraphSizeData) -> Bool {

    var theResult : Bool = false
    let _ = GeometryReader { geometry in
       generateView(geometry:geometry, equality:&theResult)
    }

    func generateView(geometry: GeometryProxy, equality: inout Bool) -> Rectangle {
       let paragraphSize1, paragraphSize2: NSSize

      if let anAnchor = value1.paragraphRect { paragraphSize1 = geometry[anAnchor].size }
       else {paragraphSize1 = NSZeroSize }
       if let anAnchor = value2.paragraphRect { paragraphSize2 = geometry[anAnchor].size }
       else {paragraphSize2 = NSZeroSize }

       equality = (paragraphSize1 == paragraphSize2)
       return Rectangle()
    }

   return theResult     
  }

}

With kind regards

Answer 3

The problem here is actually not in ScrollView but in usage - this mechanism allow to transfer data up in viewTree:

A view with multiple children automatically combines its values for a given preference into a single value visible to its ancestors.

source

The keywords here - with multiple children. This mean that u can pass it in viewTree from child to parent.

Let's review u'r code:

struct ContentView: View {
    var body: some View {
        ScrollView {
            Text("Hello")
                .preference(key: WidthPreferenceKey.self, value: 20)
                .onPreferenceChange(WidthPreferenceKey.self) {
                    print($0) // Not being called, we're in a scroll view.
                }
        }
    }
}

As u can see now - child pass value to itself, and not to parent - so this don't want to work, as per design.

And working case:

struct ContentView: View {
    var body: some View {
        ScrollView {
            Text("Hello")
                .preference(key: WidthPreferenceKey.self, value: 20)
        }
        .onPreferenceChange(WidthPreferenceKey.self) {
            print($0)
        }
    }
}

Here, ScrollView is parent and Text is child, and child talk to parent - everything works as expected.

So, as I sad in the beginning the problem here not in ScrollView but in usage and in Apple documentation (u need to read it few times as always).

---

And regarding this:

Bound preference WidthPreferenceKey tried to update multiple times per frame.

This is because u may change multiply values in same time and View can't be rendered, try to .receive(on:) or DispatchQueue.main.async as workaround (I guess this may be a bug)

Answer 4

I had been trying to figure out this issue for a long time and have found how to deal with it although the way I used was just the one of workarounds.

Use onAppear to ScrollView with a flag to make its children show up.

...
@State var isShowingContent = false
...

ScrollView {
    if isShowingContent {
        ContentView()
    }
}
.onAppear {
     self.isShowingContent = true
}

Or,

Use List instead of it.
It has the scroll feature and you can customize it with its own functionality and UITableView appearance in terms of UI. the most important is that it works as we expected.

[If you have time to read more]
Let me say my thought about that issue.

I have confirmed that onPreferenceChange isn't called at the bootstrap time of a view which is put inside a ScrollView. I'm not sure if it is right behavior or not. But, I assume that it's wrong because ScrollView have to be capable to contain any views even if some of those use PreferenceKey to pass any data among views inside it. If it's right behavior, it would be quite easy of us to get in trouble when we try to create our custom views.

Let's get into more detail.
I suppose that ScrollView would work slightly different from the other container views such as List, (H/V)Stack when it comes to setup its child view at the bootstrap time. In other words, ScrollView would try to draw(or lay out) children in its own way. Unfortunately, that way would affect the children's layout mechanism working incorrectly as what we've been seeing. We could guess what happened with the following message on debug view.

TestHPreferenceKey tried to update multiple times per frame.

It might be an evidence to tell us that the update of children has occurred while ScrollView is doing something for its setup. At that moment, it could be guessed that the update to PreferenceKey has been ignored.

That's why I tried to put the placing child views off to onAppear.

I hope that will be useful for someone who's struggling with various issue on SwiftUI.

Answer 5

It seems like the issue is not necessarily with ScrollView, but with your usage of PreferenceKey. For instance, here is a sample struct in which a PreferenceKey is set according to the width of a Rectangle, and then printed using .onPreferenceChange(), all inside of a ScrollView. As you drag the Slider to change the width, the key is updated and the print closure is executed.

struct ContentView: View {
    @State private var width: CGFloat = 100

    var body: some View {
        VStack {
            Slider(value: $width, in: 100...200)

            ScrollView(.vertical) {
                Rectangle()
                    .background(WidthPreferenceKeyReader())
                    .onPreferenceChange(WidthPreferenceKey.self) {
                        print($0)
                }
            }
            .frame(width: self.width)
        }
    }
}

struct WidthPreferenceKeyReader: View {
    var body: some View {
        GeometryReader { geometry in
            Rectangle()
                .fill(Color.clear)
                .preference(key: WidthPreferenceKey.self, value: geometry.size.width)
        }
    }
}

As you noted, the first time the key tries to set, the console prints "Bound preference WidthPreferenceKey tried to update multiple times per frame," but a real value is immediately set afterward, and it continues to update dynamically.

What value are you actually trying to set, and what are you trying to do in .onPreferenceChange()?