What is PreferenceKey in the context of iOS development?

PreferenceKey is a protocol in the SwiftUI framework that allows child Views to pass data to their parent Views in the view hierarchy.

They are used to define values that propagate upward through the view tree. Parent Views can read these values using the .preference(key:value:) modifier or reactively respond to their changes with .onPreferenceChange(key:_:).

Main components:

• PreferenceKey protocol: Defines the type of the value (Value) being passed and requires the implementation of a static reduce(value:nextValue:) function, which combines multiple values of the same key into one. This is necessary if multiple child Views pass a value for the same key.
• Value: The data type being passed (e.g., CGFloat, Int, String, custom structures).
• reduce(value:nextValue:): A static method called to merge values of the same key coming from different child Views. For example, for CGFloat, you might use max or min, and for [CGFloat], merging arrays.

Example usage: Obtaining the size of a child View.

import SwiftUI

// 1. Define the PreferenceKey
struct ViewSizePreferenceKey: PreferenceKey {
    static var defaultValue: CGSize = .zero // Default value

    // Reduction method: in this case, simply take the next value,
    // since we expect one size value from each child view
    static func reduce(value: inout CGSize, nextValue: () -> CGSize) {
        value = nextValue()
    }
}

struct ParentView: View {
    @State private var childSize: CGSize = .zero

    var body: some View {
        VStack {
            Text("Child View size: \(childSize.width) x \(childSize.height)")
            ChildView()
                .background(GeometryReader { proxy in // Use GeometryReader to get size
                    Color.clear // Transparent color to not affect layout
                        .preference(key: ViewSizePreferenceKey.self, value: proxy.size) // Pass size upward
                })
        }
        .onPreferenceChange(ViewSizePreferenceKey.self) { newSize in // Reactively respond to value change
            self.childSize = newSize // Update parent state
        }
    }
}

struct ChildView: View {
    var body: some View {
        Text("I am a child View")
            .padding()
            .border(Color.blue)
    }
}

PreferenceKey allows for a clean and declarative way to obtain information about child Views, which is not directly accessible through state bindings or View properties. This is especially useful for layout and positioning tasks, where the parent View needs to know the sizes or positions of its child elements.