How to resize an image view to fit a container view in SwiftUI

By default, SwiftUI's Image views automatically size themselves to their image contents. This usually larger than the device screen or their parent view.

struct ContentView: View {
    var body: some View {
        Image("donuts")
    }
}

We learn in How to resize a SwiftUI Image and keep its aspect ratio a different way to fitting images into available space. But that doesn't apply well if you want an image to be a background that fits itself to a container view with other view content.

Problem

An image view changes its parent frame instead of resizing itself to fit the parent frame. The problem might be hard to understand using words. Let's see what I mean by example.

1. You have a parent view (ZStack) with a text view as content. In this case, the parent view will size itself equals to the text view and padding. This is the size we want.

struct ContentView: View {
    var body: some View {
        ZStack {
            Text("Hello, SwiftUI!")
                .font(.system(size: 34, weight: .black))
                .padding(100)
                .border(Color.blue)
        }
        .background(Color.pink)
    }
}

2. Then, you add a background image using aspect fit content mode. I expected the image view to resize itself to fit the container size.

struct ContentView: View {
    var body: some View {
        ZStack {
            Image("donuts")
                .resizable()
                .scaledToFit()
                .border(Color.blue)
            Text("Hello, SwiftUI!")
                .font(.system(size: 34, weight: .black))
                .padding(100)
                .border(Color.blue)
        }
        .background(Color.pink)

    }
}

I expected something like this:

3. Run the app, and the result is not what we expected. The image view does not resize itself to the container view but takes the biggest available device (device frame). The result is the container view expands beyond the original size (As you can see from the pink background).

You can easily support sarunw.com by checking out this sponsor.

AI Grammar: Correct grammar, spell check, check punctuation, and parphrase.

Try it for Free

Solution

The change for this problem is very minimal. The only thing you need to make it work is .layoutPriority. Just make sure the layout priority of the background view is the lowest in your container view.

You can set text view's layout priority higher.

struct ContentView: View {
    var body: some View {
        ZStack {
            Image("donuts")
                .resizable()
                .scaledToFit()
                .border(Color.blue)
            Text("Hello, SwiftUI!")
                .font(.system(size: 34, weight: .black))
                .padding(100)
                .border(Color.blue)
                .layoutPriority(1)
        }
        .background(Color.pink)

    }
}

Or make the image view's layout priority lower.

struct ContentView: View {
    var body: some View {
        ZStack {
            Image("donuts")
                .resizable()
                .scaledToFit()
                .border(Color.blue)
                .layoutPriority(-1)
            Text("Hello, SwiftUI!")
                .font(.system(size: 34, weight: .black))
                .padding(100)
                .border(Color.blue)
        }
        .background(Color.pink)

    }
}

Setting .layoutPriority of the image view to be the lowest would yield the result we expected.