Preference keys in iOS Swift

Introduction

Preference keys help you share small pieces of information inside your app easily. They let different parts of your app talk to each other without being tightly connected.

When you want to pass simple data like sizes or colors from one view to another.

When you need to communicate layout information up the view tree.

When you want to keep your views independent but still share some settings.

When you want to collect values from multiple child views into a parent view.

When you want to avoid using global variables or complex data passing.

Syntax

iOS Swift

struct MyPreferenceKey: PreferenceKey {
    static var defaultValue: Int = 0
    static func reduce(value: inout Int, nextValue: () -> Int) {
        value += nextValue()
    }
}

The PreferenceKey protocol requires a defaultValue and a reduce function.

The reduce function combines multiple values from child views.

Examples

This key finds the maximum width from child views.

iOS Swift

struct MaxWidthKey: PreferenceKey {
    static var defaultValue: CGFloat = 0
    static func reduce(value: inout CGFloat, nextValue: () -> CGFloat) {
        value = max(value, nextValue())
    }
}

This key passes a color preference from child to parent.

iOS Swift

struct ColorPreferenceKey: PreferenceKey {
    static var defaultValue: Color = .clear
    static func reduce(value: inout Color, nextValue: () -> Color) {
        value = nextValue()
    }
}

Sample App

This example measures the width of two text views and shows the maximum width below them. It uses a preference key to pass width values up the view tree.

iOS Swift

import SwiftUI

struct MaxWidthKey: PreferenceKey {
    static var defaultValue: CGFloat = 0
    static func reduce(value: inout CGFloat, nextValue: () -> CGFloat) {
        value = max(value, nextValue())
    }
}

struct ContentView: View {
    @State private var maxWidth: CGFloat = 0

    var body: some View {
        VStack {
            Text("Short")
                .background(GeometryReader { geo in
                    Color.clear.preference(key: MaxWidthKey.self, value: geo.size.width)
                })
            Text("A much longer text")
                .background(GeometryReader { geo in
                    Color.clear.preference(key: MaxWidthKey.self, value: geo.size.width)
                })
            Text("Max width: \(maxWidth, specifier: "%.1f")")
                .padding()
        }
        .onPreferenceChange(MaxWidthKey.self) { value in
            maxWidth = value
        }
        .padding()
    }
}

Important Notes

Preference keys are great for passing data from child views to parent views.

Use GeometryReader with preference keys to measure view sizes.

The reduce method lets you combine multiple values, like finding a max or sum.

Summary

Preference keys let views share simple data up the view hierarchy.

They require a default value and a reduce function to combine values.

Commonly used with GeometryReader to pass layout info.

Practice

1. What is the main purpose of PreferenceKey in SwiftUI?

easy

A. To store user preferences permanently

B. To share simple data up the view hierarchy

C. To create custom buttons

D. To manage network requests

Solution

1. Step 1: Understand PreferenceKey role

   PreferenceKey is designed to pass data from child views up to parent views in SwiftUI.

2. Step 2: Differentiate from other uses

   It is not for permanent storage or UI elements but for sharing layout or state info upwards.

3. Final Answer:

   To share simple data up the view hierarchy -> Option B

4. Quick Check:

   PreferenceKey = share data up [OK]

Hint: PreferenceKey passes data upward, not stores or creates UI [OK]

Common Mistakes:

• Confusing PreferenceKey with UserDefaults
• Thinking it creates UI components
• Assuming it manages network tasks

2. Which of the following is the correct way to declare a PreferenceKey with a default value of 0 and a reduce function that sums values?

easy

A. struct MyKey: PreferenceKey { static var defaultValue = 0; static func reduce(value: Int, nextValue: () -> Int) { value += nextValue() } }

B. struct MyKey: PreferenceKey { static let defaultValue = 0; static func reduce(value: Int, nextValue: () -> Int) { value += nextValue() } }

C. struct MyKey: PreferenceKey { var defaultValue: Int = 0; func reduce(value: inout Int, nextValue: () -> Int) { value += nextValue() } }

D. struct MyKey: PreferenceKey { static var defaultValue: Int = 0; static func reduce(value: inout Int, nextValue: () -> Int) { value += nextValue() } }

Solution

1. Step 1: Check static defaultValue declaration

   It must be a static property with explicit type: static var defaultValue: Int = 0.

2. Step 2: Verify reduce function signature

   Reduce must be static, take inout value, and add nextValue: static func reduce(value: inout Int, nextValue: () -> Int).

3. Final Answer:

   struct MyKey: PreferenceKey { static var defaultValue: Int = 0; static func reduce(value: inout Int, nextValue: () -> Int) { value += nextValue() } } -> Option D

4. Quick Check:

   Static defaultValue and reduce with inout = struct MyKey: PreferenceKey { static var defaultValue: Int = 0; static func reduce(value: inout Int, nextValue: () -> Int) { value += nextValue() } } [OK]

Hint: defaultValue and reduce must be static with correct signatures [OK]

Common Mistakes:

• Missing static keyword on defaultValue or reduce
• Using var instead of static var for defaultValue
• Incorrect reduce function parameters

3. Given this code snippet, what will be printed?

struct CountKey: PreferenceKey {
  static var defaultValue = 0
  static func reduce(value: inout Int, nextValue: () -> Int) {
    value += nextValue()
  }
}

struct ContentView: View {
  var body: some View {
    VStack {
      Text("Hello").preference(key: CountKey.self, value: 1)
      Text("World").preference(key: CountKey.self, value: 2)
    }
    .onPreferenceChange(CountKey.self) { print($0) }
  }
}

medium

A. 3

B. 2

C. 1

D. 0

Solution

1. Step 1: Understand preference values set

   Two Text views set preferences with values 1 and 2 respectively.

2. Step 2: Apply reduce function logic

   Reduce sums values: 0 (default) + 1 + 2 = 3.

3. Final Answer:

   3 -> Option A

4. Quick Check:

   Sum of preferences = 3 [OK]

Hint: Reduce sums all values, so 1 + 2 = 3 [OK]

Common Mistakes:

• Assuming only last value is used
• Ignoring reduce function behavior
• Confusing defaultValue with output

4. Identify the error in this PreferenceKey implementation:

struct SizeKey: PreferenceKey {
  static var defaultValue: CGSize = .zero
  static func reduce(value: CGSize, nextValue: () -> CGSize) {
    value = nextValue()
  }
}

medium

A. reduce function must have inout parameter for value

B. defaultValue must be non-static

C. nextValue must return Int, not CGSize

D. PreferenceKey cannot use CGSize type

Solution

1. Step 1: Check defaultValue declaration

   defaultValue is correctly static with CGSize type.

2. Step 2: Inspect reduce function signature

   Reduce must take inout for value to modify it, but here it is a value parameter.

3. Final Answer:

   reduce function must have inout parameter for value -> Option A

4. Quick Check:

   Reduce needs inout value parameter [OK]

Hint: Reduce must use inout for value to update it [OK]

Common Mistakes:

• Forgetting inout keyword in reduce
• Changing defaultValue to non-static
• Wrong return type for nextValue

5. You want to pass the maximum width of child views up to a parent using PreferenceKey. Which implementation correctly combines widths to find the maximum?

hard

A. struct MaxWidthKey: PreferenceKey {
static var defaultValue: CGFloat = 0
static func reduce(value: CGFloat, nextValue: () -> CGFloat) {
value = max(value, nextValue())
}
}

B. struct MaxWidthKey: PreferenceKey {
static var defaultValue: CGFloat = 0
static func reduce(value: inout CGFloat, nextValue: () -> CGFloat) {
value += nextValue()
}
}

C. struct MaxWidthKey: PreferenceKey {
static var defaultValue: CGFloat = 0
static func reduce(value: inout CGFloat, nextValue: () -> CGFloat) {
value = max(value, nextValue())
}
}

D. struct MaxWidthKey: PreferenceKey {
static var defaultValue: CGFloat = 0
static func reduce(value: inout CGFloat, nextValue: () -> CGFloat) {
value = min(value, nextValue())
}
}

Solution

1. Step 1: Identify correct reduce logic for max

   To find maximum width, reduce must assign the max of current and next values.

2. Step 2: Verify function signature and logic

   Reduce must be static, take inout value, and use value = max(value, nextValue()).

3. Final Answer:

   struct MaxWidthKey: PreferenceKey { static var defaultValue: CGFloat = 0; static func reduce(value: inout CGFloat, nextValue: () -> CGFloat) { value = max(value, nextValue()) } } -> Option C

4. Quick Check:

   Use max in reduce with inout value [OK]

Hint: Use max function and inout value in reduce [OK]

Common Mistakes:

• Using sum (+) instead of max
• Missing inout in reduce parameter
• Using min instead of max