How the relative measurement modifier interacts with stack views – Ole Begemann

I’ve another factor to say on the relative sizing view modifier from my earlier put up, Working with percentages in SwiftUI format. I’m assuming you’ve learn that article. The next is sweet to know if you wish to use the modifier in your individual code, however I hope you’ll additionally study some common tidbits about SwiftUI’s format algorithm for HStacks and VStacks.

Utilizing relative sizing inside a stack view

Let’s apply the relativeProposed modifier to one of many subviews of an HStack:

HStack(spacing: 10) {
    Coloration.blue
        .relativeProposed(width: 0.5)
    Coloration.inexperienced
    Coloration.yellow
}
.border(.main)
.body(peak: 80)

What do you count on to occur right here? Will the blue view take up 50 % of the accessible width? The reply is not any. Actually, the blue rectangle turns into narrower than the others:

It is because the HStack solely proposes a proportion of its accessible width to every of its youngsters. Right here, the stack proposes one third of the accessible area to its first youngster, the relative sizing modifier. The modifier then halves this worth, leading to one sixth of the full width (minus spacing) for the blue shade. The opposite two rectangles then turn out to be wider than one third as a result of the primary youngster view didn’t expend its full proposed width.

Order issues

Now let’s transfer the modifier to the inexperienced shade within the center:

HStack(spacing: 10) {
    Coloration.blue
    Coloration.inexperienced
        .relativeProposed(width: 0.5)
    Coloration.yellow
}

Naively, I’d count on an equal end result: the inexperienced rectangle ought to turn out to be 100 pt vast, and blue and yellow must be 250 pt every. However that’s not what occurs — the yellow view finally ends up being wider than the blue one:

I discovered this unintuitive at first, nevertheless it is smart when you perceive that the HStack processes its youngsters in sequence:

1. The HStack proposes one third of its accessible area to the blue view: (620 – 20) / 3 = 200. The blue view accepts the proposal and turns into 200 pt vast.

2. Subsequent up is the relativeProposed modifier. The HStack divides the remaining area by the variety of remaining subviews and proposes that: 400 / 2 = 200. Our modifier halves this proposal and proposes 100 pt to the inexperienced view, which accepts it. The modifier in flip adopts the dimensions of its youngster and returns 100 pt to the HStack.

3. Because the second subview used much less area than proposed, the HStack now has 300 pt left over to suggest to its closing youngster, the yellow shade.

Necessary: the order during which the stack lays out its subviews occurs to be from left to proper on this instance, however that’s not all the time the case. Typically, HStacks and VStacks first group their subviews by format precedence (extra on that beneath), after which order the views inside every group by flexibility such that the least versatile views are laid out first. For extra on this, see How an HStack Lays out Its Youngsters by Chris Eidhof. The views in our instance are all equally versatile (all of them can turn out to be any width between 0 and infinity), so the stack processes them of their “pure” order.

Leftover area isn’t redistributed

By now it’s possible you’ll give you the chance guess how the format seems after we transfer our view modifier to the final youngster view:

HStack(spacing: 10) {
    Coloration.blue
    Coloration.inexperienced
    Coloration.yellow
        .relativeProposed(width: 0.5)
}

• Blue and inexperienced every obtain one third of the accessible width and turn out to be 200 pt vast. No surprises there.

• When the HStack reaches the relative sizing modifier, it has 200 pt left to distribute. Once more, the modifier and the yellow rectangle solely use half of this quantity.

The tip result’s that the HStack finally ends up with 100 pt left over. The method stops right here — the HStack does not begin over in an try to discover a “higher” answer. The stack makes itself simply large enough to comprise its subviews (= 520 pt incl. spacing) and studies that measurement to its dad or mum.

Structure precedence

We are able to use the layoutPriority view modifier to affect how stacks and different containers lay out their youngsters. Let’s give the subview with the relative sizing modifier a better format precedence (the default precedence is 0):

HStack(spacing: 10) {
    Coloration.blue
    Coloration.inexperienced
    Coloration.yellow
        .relativeProposed(width: 0.5)
        .layoutPriority(1)
}

This ends in a format the place the yellow rectangle truly takes up 50 % of the accessible area:

Clarification:

1. The HStack teams its youngsters by format precedence after which processes every group in sequence, from highest to lowest precedence. Every group is proposed the total remaining area.

2. The primary format group solely accommodates a single view, our relative sizing modifier with the yellow shade. The HStack proposes all the accessible area (minus spacing) = 600 pt. Our modifier halves the proposal, leading to 300 pt for the yellow view.

3. There are 300 pt left over for the second format group. These are distributed equally among the many two youngsters as a result of every subview accepts the proposed measurement.

Conclusion

The code I used to generate the photographs on this article is offered on GitHub. I solely appeared HStacks right here, however VStacks work in precisely the identical approach for the vertical dimension.

SwiftUI’s format algorithm all the time follows this primary sample of proposed sizes and responses. Every of the built-in “primitive” views (e.g. mounted and versatile frames, stacks, Textual content, Picture, Spacer, shapes, padding, background, overlay) has a well-defined (if not all the time well-documented) format conduct that may be expressed as a perform (ProposedViewSize) -> CGSize. You’ll must study the conduct for view to work successfully with SwiftUI.

A concrete lesson I’m taking away from this evaluation: HStack and VStack don’t deal with format as an optimization downside that tries to seek out the optimum answer for a set of constraints (autolayout fashion). Quite, they type their youngsters in a specific approach after which do a single proposal-and-response move over them. If there’s area leftover on the finish, or if the accessible area isn’t sufficient, then so be it.