A collection of SwiftUI tools to help with layout.

• SwiftUI Layouts like HFlowLayout, VFlowLayout, VMasonryLayout, HMasonryLayout, and LayoutThatFits
• AutoRotatingView to set allowable orientations for a view.
• Frame Adjustment tools like WidthReader, HeightReader, onSizeChange(perform:), keyboardHeight, .relativePadding, ScaledView and OverlappingImage.
• unclippedTextRenderer for fixing clipped Text.
• SmartScrollView with optional scrolling, a content-fitable frame, and live edge inset values.
• FlippingView and rotation3DEffect(back:) for making flippable views with a different view on the back side.
• TabMenu, a customizable iOS tab menu with onReselect and onDoubleTap functions.

Some widget-related tools

• AccessoryInlineImage to use any image inside an accessoryInline widget
• WidgetSize - Similar to WidgetFamily but returns widget frame sizes by device and doesn't require WidgetKit
• WidgetDemoFrame creates accurately sized widget frames you can use in an iOS or macOS app.

Additional SwiftUI tools for iOS 14+15, macOS 11+12, watchOS 7+8, and tvOS 14+15

• FULayout for building custom layouts (similar to SwiftUI Layout).
• FULayouts: HFlow, VFlow, HMasonry, VMasonry, FULayoutThatFits, and FUViewThatFits
• AnyFULayout to wrap multiple layouts and switch between with animation.
• Make your own Custom FULayout and add a SwiftUI Layout version using LayoutFromFULayout
• TagView for a simple flow view based on an array of elements.
• WidgetRelativeShape fixes a ContainerRelativeShape bug on iPad.

The Example folder has an app that demonstrates the features of this package.

This package is compatible with iOS 14+, macOS 11+, watchOS 7+, tvOS 14+, and visionOS.

1. In Xcode go to File -> Add Packages
2. Paste in the repo's url: https://github.com/ryanlintott/FrameUp and select by version.
3. Import the package using import FrameUp

Really it's up to you. I currently use this package in my own Old English Wordhord app.

Additionally, if you find a bug or want a new feature add an issue and I will get back to you about it.

FrameUp is open source and free but if you like using it, please consider supporting my work.

*iOS 16+, macOS 13+, watchOS 9+, tvOS 16+

If your target OS is older and doesn't support SwiftUI Layout, use FULayout equivalents.

A Layout that arranges views in horizontal rows flowing from one to the next with adjustable horizontal and vertical spacing and support for horiztonal and vertical alignment including a justified alignment that will space elements in completed rows evenly.

Each row height will be determined by the tallest element. The overall frame size will fit to the size of the laid out content.

HFlowLayout {
    ForEach(["Hello", "World", "More Text"], id: \.self) { item in
        Text(item.value)
    }
}

A Layout that arranges views in vertical columns flowing from one to the next with adjustable horizontal and vertical spacing and support for horiztonal and vertical alignment including a justified alignment that will space elements in completed columns evenly.

Each column width will be determined by the widest element. The overall frame size will fit to the size of the laid out content.

VFlowLayout {
    ForEach(["Hello", "World", "More Text"], id: \.self) { item in
        Text(item.value)
    }
}

A Layout that arranges views into a set number of columns by adding each view to the shortest column.

VMasonryLayout(columns: 3) {
    ForEach(["Hello", "World", "More Text"], id: \.self) { item in
        Text(item.value)
    }
}

A Layout that arranges views into a set number of rows by adding each view to the shortest row.

HMasonryLayout(rows: 3) {
    ForEach(["Hello", "World", "More Text"], id: \.self) { item in
        Text(item.value)
    }
}

Creates a layout using the first layout that fits in the axes provided from the array of layout preferences.

LayoutThatFits(in: .horizontal, [HStackLayout(), VStackLayout()]) {
    Color.green.frame(width: 50, height: 50)
    Color.yellow.frame(width: 50, height: 200)
    Color.blue.frame(width: 50, height: 100)
}

*iOS only

A view that rotates any view to match the current device orientation if it's in an array of allowed orientations. This is most useful for allowing fullscreen image views to use landscape orientations while inside a portrait-only app. It can also be used to limit orientations such as landscape-only in an app that allows portrait. Rotations can be animated.

AutoRotatingView([.portrait, .landscapeLeft, .landscapeRight], animation: .default) {
    Image("MyFullscreenImage")
        .resizable()
        .scaledToFit()
}

A view that takes the available width and provides this measurement to its content. Unlike 'GeometryReader' this view will not take up all the available height and will instead fit the height of the content.

Useful inside vertical scroll views where you want to measure the width without specifying a frame height.

ScrollView {
    WidthReader { width in
        HStack(spacing: 0) {
            Text("This text frame is set to 70% of the width.")
                .frame(width: width * 0.7)
                .background(Color.green)

            Circle()
        }
    }
    .foregroundColor(.white)
    .background(Color.blue)

    Text("The WidthReader above does not have a fixed height and will grow to fit the content.")
        .padding()
}

A view that takes the available height and provides this measurement to its content. Unlike 'GeometryReader' this view will not take up all the available width and will instead fit the width of the content.

Useful inside horizontal scroll views where you want to measure the height without specifying a frame width.

ScrollView(.horizontal) {
    HeightReader { height in
        VStack(spacing: 0) {
            Text("This\ntext\nframe\nis\nset\nto\n70%\nof\nthe\nheight.")
                .frame(height: height * 0.7)
                .background(Color.green)

            Circle()
        }
        .foregroundColor(.white)
        .background(Color.blue)

        Text("\nThe\nHeightReader\nto\nthe\nleft\ndoes\nnot\nhave\na\nfixed\nwidth\nand\nwill\ngrow\nto\nfit\nthe\ncontent.")
            .padding()
    }
}

Adds an action to perform when parent view size value changes.

struct OnSizeChangeExample: View {
    @State private var size: CGSize = .zero
    
    var body: some View {
        Text("Hello, World!")
            .padding(100)
            .background(Color.blue)
            .onSizeChange { size in
                self.size = size
            }
            .overlay(Text("size: \(size.width) x \(size.height)"), alignment: .bottom)
    }
}

Views with .equalWidthPreferred() inside a view with .equalWidthContainer() will have widths equal to the largest view. If space is limited views will shrink equally, each to a minimum size that fits the content. It works in HStack, VStack and even custom layouts like HFlow

This works especially well in macOS when you want all buttons on a window to have the same width while still allowing some shrinking.

HStack {
    Button { } label: {
        Text("More Information")
            .equalWidthPreferred()
    }
    Spacer()
    
    Button { } label: {
        Text("Cancel")
            .equalWidthPreferred()
    }
    
    Spacer()
    
    Button { } label: {
        Text("OK")
            .equalWidthPreferred()
    }
}
.equalWidthContainer()
.frame(maxWidth: 400)
.padding()

Views with .equalHeightPreferred() inside a view with .equalHeightContainer() will have heights equal to the largest view. If space is limited views will shrink equally, each to a minimum size that fits the content. It works in HStack, VStack and even custom layouts like VFlow

HStack {
    Group {
        Text("Here's something with some text")
        
        Text("And more")
    }
    .foregroundColor(.white)
    .padding()
    .equalHeightPreferred()
    .background(Color.blue.cornerRadius(10))
}
.equalHeightContainer()
.frame(maxWidth: 200)

An environment variable that will update with animation as the iOS keyboard appears and disappears. It will always be zero for non-iOS platforms.

Animation.keyboard is added as an approximation of the keyboard animation curve and is used by keyboardHeight.

In order to use keyboardHeight you first need to add it somewhere at the top of your view heirachry so it can see the entire frame. It will use a GeometryReader on a background layer to measure the keyboard so ensure the view is using the entire available height.

struct ContentView: View {
    var body: some View {
        MyView()
            .frame(maxHeight: .infinity)
            .keyboardHeightEnvironmentValue()
    }
}

When you want to access the keyboardHeight use an environment variable. If you're using it to adjust the position of a view that should avoid the keyboard use the keyboardHeight directly and make sure the view ignores the keyboard safe area.

struct MyView: View {
    @Environment(\.keyboardHeight) var keyboardHeight
    @State private var text = ""
    
    var body: some View {
        TextField("Moves with keyboard", text: $text)
            .keyboardHeightEnvironmentValue()
            .padding(.bottom, keyboardHeight == 0 ? 100 : keyboardHeight)
            .ignoresSafeArea(.keyboard)
    }
}

Adds a padding amount to specified edges of a view relative to the size of the view. Width is used for .leading/.trailing and height is used for .top/.bottom

Negative values can be used to overlap content.

Text("This text will have padding based on the width and height of its frame.")
    .relativePadding([.leading, .top], 0.2)

A view modifier that scales a view using scaleEffect to match a frame size.

View must have an intrinsic content size or be provided a specific frame size. Final frame size may be different depending on modes chosen.

Uses ScaleMode to limit the view so it can only grow/shrink or both.

• scaledToFrame(size:,contentMode:,scaleMode:)
• scaledToFrame(width:,height:,contentMode:,scaleMode:)
• scaledToFit(size:,scaleMode:)
• scaledToFit(width:,height:,scaleMode:)
• scaledToFit(width:,scaleMode:)
• scaledToFit(height:,scaleMode:)
• scaledToFill(size:,scaleMode:)
• scaledToFill(width:,height:,scaleMode:)

An image view that can overlap content on the edges of its frame.

Image can overlap either on the vertical or horizontal axis but not both.

Be sure to consider spacing and use zIndex to place the image in front or behind content.

VStack(spacing: 0) {
    Text("Overlapping Image")
        .font(.system(size: 50))

    OverlappingImage(Image(systemName: "star.square"), aspectRatio: 1.0, top: 0.1, bottom: 0.25)
        .padding(.horizontal, 50)
        .zIndex(1)

    Text("The image above will overlap content above and below.")
        .padding(20)
}

*iOS 18+, macOS 15+, watchOS 11+, tvOS 18+, visionOS 2+

SwiftUI Text has a clipping frame that cannot be adjusted and will occasionally clip the rendered text. This modifier applies an UnclippedTextRenderer that removes this clipping frame.

This modifier is unnecessary if another text renderer is used as all text renderers will remove the clipping frame.

Text("f")
    .font(.custom("zapfino", size: 30))
    .unclippedTextRenderer()

*iOS only

A ScrollView with extra features.

• Optional Scrolling - When active, the view will only be scrollable if the content is too large to fit in the parent frame. Enabled by default.
• Shrink to Fit - When active, the view will only take as much vertical and horizontal space as is required to fit the content. Enabled by default.
• Edge Insets - An onScroll function runs when the edge insets update. This occurs on scroll, on first load and on any size change to the scroll view or the content. Insets are negative when content edges are beyond the scroll view edges. Values may not be exactly 0 but will be less than 1 when content edges match scroll view edges.

SmartScrollView(.vertical, showsIndicators: true, optionalScrolling: true, shrinkToFit: true) {
    // Content here
} onScroll: { edgeInsets in
    // Runs when edge insets change
}

Limitations:

• If placed directly inside a NavigationView with a resizing header, this view may behave strangely when scrolling. To avoid this add 1 point of padding just inside the NavigationView.
• If the available space for this view grows for any reason other than screen rotation, this view might not grow to fill the space.

A two-sided view that can be flipped by tapping or swiping.

The axis, anchor, perspective, drag distance to flip, animation for tap to flip and more can all be customized.

For visionOS a slightly different initializer might be needed and the flips will occur in 3d space. If instead you want a perspective effect on a flat view you can use PerspectiveFlippingView

FlippingView(flips: $flips) {
    Color.blue.overlay(Text("Up"))
} back: {
    Color.red.overlay(Text("Back"))
}

*deprecated in visionOS Renders a view’s content as if it’s rotated in three dimensions around the specified axis with a closure containing a different view to show on the back.

The example below is a view with two sides. One blue side that says "Front" and a red side on the back that says "Back". Changing the angle will show each side as it becomes visible.

Color.blue.overlay(Text("Front"))
    .rotation3DEffect(angle) {
        Color.red.overlay(Text("Back"))
    }

*visionOS Rotates this view’s rendered output in three dimensions around the given axis of rotation with a closure containing a different view on the back. A minimum thickness that offsets the two views is required to ensure the side facing the user renders on top.

Color.blue.overlay(Text("Front"))
    .rotation3DEffect(angle) {
        Color.red.overlay(Text("Back"))
    }

*visionOS Renders a view’s content as if it’s rotated in three dimensions around the specified axis with a closure containing a different view to show on the back. The view is not actually rotated in 3d space.

Color.blue.overlay(Text("Front"))
    .rotation3DEffect(angle) {
        Color.red.overlay(Text("Back"))
    }

*iOS only

Customizable tab menu bar view designed to mimic the style of the default tab menu bar on iPhone. Images or views and name provided are used to mask another provided view which is often a color.

Features:

• Use any image or AnyView as a mask for the menu item.
• Use any view as the 'color' including gradients.
• onReselect closure that returns a NamedAction that triggers when the active tab is selected.
• onDoubleTap closure that returns a NamedAction that triggers when the active tab is double-tapped.
• accessibility actions are automatically added for onReselect and onDoubleTap if they are added.

let items = [
    TabMenuItem(icon: AnyView(Circle().stroke().overlay(Text("i"))), name: "Info", tab: 0),
    TabMenuItem(image: Image(systemName: "star"), name: "Favourites", tab: 1),
    TabMenuItem(image: Image(systemName: "bookmark"), name: "Categories", tab: 2),
    TabMenuItem(image: Image(systemName: "books.vertical"), name: "About", tab: 3)
]

TabMenuView(selection: $selection, items: items) { isSelected in
    Group {
        if isSelected {
            Color.accentColor
        } else {
            Color(.secondaryLabel)
        }
    }
} onReselect: {
    NamedAction("Reselect") {
        print("TabMenu item \(selection) reselected")
    }
} onDoubleTap: {
    NamedAction("Double Tap") {
        print("TabMenu item \(selection) doubletapped")
    }
}

An image that will be scaled and have the rendering mode adjusted to work inside an accessoryInline widget. The image will scale to fit the frame and have the template rendering mode applied.

Use inside a Label's icon property.

Label {
    Text("Label Text")
} icon: {
    AccessoryInlineImage("myImage")
}

An enum similar to WidgetFamily but returns widget frame sizes by device and doesn't require WidgetKit so it can be used inside your main iOS or macOS app.

Returns the size of the widget based on the screen size provided.

Returns either the design canvas or the home screen size (depending on the supplied target) of the widget based on the screen size provided. On iPads widget content is put on the design canvas then scaled to fit the home screen size. (The WidgetDemoFrame will do this scaling for you)

Returns an array of supported widget sizes based on device type and iOS version.

Returns the size of the widget based on the current device.

All widget size information was sourced from: Apple - Human Interface Guidelines

Creates widget frames sized for a supplied screen size or the current device (iOS only). Used for showing example widgets from inside the app.

Corner radius size defaults to 20 and may not be the same as the actual widget corner radius.

For iPad, widget views use a design size and are scaled to a smaller Home Screen size using ScaledView. This demo frame uses the same scaling to properly preview the widget. All sizes will work on all devices and all versions of iOS (even extraLarge on iPhone with iOS 14.0).

WidgetDemoFrame(.medium, cornerRadius: 20) { size, cornerRadius in
    Text("Demo Widget")
}

A protocol that adds helpful parameters like aspectFormat, aspectRatio, minDimension, maxDimension, init(width:,aspectRatio:), init(height:,aspectRatio:), square(:), scaledToFit(:), and scaledToFill(:).

Used on types that have width and height properties like CGSize.

How to add conformance in your app:

extension CGSize: Proportionable { }

Alternative to the frame(width:,height:,alignment:) View modifier that takes a CGSize parameter instead.

If you like the SwiftUI Layout protocol but you need to target an older OS that doesn't support it then the FULayout protocol might be your answer!

An FULayout will work in the same way as a SwiftUI Layout. The main difference is it will require a maxWidth or maxHeight parameter when initializing in order to know the available space. This can be provided by GeometryReader or with WidthReader or HeightReader from this package.

*Deprecated iOS 16, macOS 13, watchOS 7, tvOS 14, visionOS 1 An FULayout uses callAsFunction() with a view builder so you can use it just like a SwiftUI Layout.

VFlow(maxWidth: 200) {
    Text("Hello")
    Text("World")
}

Caution: This method uses Apple's private protocol _VariadicView under the hood. There is a small risk Apple could change the implementation so if this concerns you, use method 2 below.

*Deprecated iOS 16, macOS 13, watchOS 7, tvOS 14, visionOS 1 This method works in a very similar way to ForEach().

MyFULayout().forEach(["Hello", "World"], id: \.self) { item in
        Text(item.value)
    }
}

*Deprecated iOS 16, macOS 13, watchOS 7, tvOS 14, visionOS 1 The FULayout equivalent of HFlowLayout.

A FrameUp FULayout that arranges views in horizontal rows flowing from one to the next with adjustable horizontal and vertical spacing and support for horiztonal and vertical alignment including a justified alignment that will space elements in completed rows evenly.

Each row height will be determined by the tallest view in that row.

WidthReader { width in
    HFlow(maxWidth: width) {
        ForEach(["Hello", "World", "More Text"], id: \.self) { item in
            Text(item.value)
        }
    }
}

*Deprecated iOS 16, macOS 13, watchOS 7, tvOS 14, visionOS 1 The FULayout equivalent of VFlowLayout.

A FrameUp FULayout that arranges views in vertical columns flowing from one to the next with adjustable horizontal and vertical spacing and support for horiztonal and vertical alignment including a justified alignment that will space elements in completed columns evenly.

Each column width will be determined by the widest element.

WidthReader { width in
    VFlow(maxWidth: width) {
        ForEach(["Hello", "World", "More Text"], id: \.self) { item in
            Text(item.value)
        }
    }
}

*Deprecated iOS 16, macOS 13, watchOS 7, tvOS 14, visionOS 1 The FULayout equivalent of HMasonryLayout.

A FrameUp FULayout that arranges views into a set number of rows by adding each view to the shortest row.

HeightReader { height in
    HMasonry(columns: 3, maxHeight: height) {
        ForEach(["Hello", "World", "More Text"], id: \.self) { item in
            Text(item.value)
                .frame(maxHeight: .infinity, alignment: .center)
        }
    }
}

*Deprecated iOS 16, macOS 13, watchOS 7, tvOS 14, visionOS 1 The FULayout equivalent of VMasonryLayout.

A FrameUp FULayout that arranges views into a set number of rows by adding each view to the shortest row.

WidthReader { width in
    VMasonry(columns: 3, maxWidth: width) {
        ForEach(["Hello", "World", "More Text"], id: \.self) { item in
            Text(item.value)
                .frame(maxWidth: .infinity, alignment: .center)
        }
    }
}

*Deprecated iOS 16, macOS 13, watchOS 7, tvOS 14, visionOS 1 The FULayout equivalent of LayoutThatFits.

An FULayout that picks the first provided layout that will fit the content in the provided maxWidth, maxHeight, or both. This is most helpful when switching between HStackFULayout and VStackFULayout as the content only needs to be provided once and will even animate when the stack changes.

FULayoutThatFits(
    maxWidth: maxWidth,
    layouts: [
        HStackFULayout(maxHeight: 1000),
        VStackFULayout(maxWidth: maxWidth)
    ]
) {
    Color.green.frame(width: 50, height: 50)
    Color.yellow.frame(width: 50, height: 200)
    Color.blue.frame(width: 50, height: 100)
}

*Deprecated iOS 16, macOS 13, watchOS 7, tvOS 14, visionOS 1 The FULayout equivalent of SwiftUI ViewThatFits.

An FULayout that presents the first view that fits the provided maxWidth, maxHeight, or both depending on which parameters are used.

As this view cannot measure the available space the maxWidth and/or maxHeight parameters need to be passed in using a GeometryReader, WidthReader, or HeightReader.

WidthReader { width in
    FUViewThatFits(maxWidth: width) {
        Group {
            Text("This layout will pick the first view that fits the available width.")
            Text("Maybe this?")
            Text("OK!")
        }
        .fixedSize(horizontal: true, vertical: false)
    }
}

(.fixedSize needs to be used in this example or the first view will automatically fit by truncating the text)

Alternative stack layouts that can be wrapped in AnyFULayout and then toggled between with animation. Useful when you want to toggle between VStack and HStack based on available space.

*Deprecated iOS 16, macOS 13, watchOS 7, tvOS 14, visionOS 1 Similar to HStack but Spacer() cannot be used and content will always use a fixed size on the horizontal axis.

*Deprecated iOS 16, macOS 13, watchOS 7, tvOS 14, visionOS 1 Similar to VStack but Spacer() cannot be used and content will always use a fixed size on the vertical axis.

*Deprecated iOS 16, macOS 13, watchOS 7, tvOS 14, visionOS 1 Similar to ZStack but content will always use a fixed size on both the vertical and horizontal axes.

*Deprecated iOS 16, macOS 13, watchOS 7, tvOS 14, visionOS 1 The FULayout equivalent of SwiftUI AnyLayout.

A type-erased FrameUp layout can be used to wrap multiple layouts and switch between them with animation.

struct AnyFULayoutSimple: View {
    let isVStack: Bool
    let maxSize: CGSize
    
    var layout: any FULayout {
        isVStack ? VStackFULayout(maxWidth: maxSize.width) : HStackFULayout(maxHeight: maxSize.height)
    }
    
    var body: some View {
        AnyFULayout(layout) {
            Text("First")
            Text("Second")
            Text("Third")
        }
        .animation(.spring(), value: isVStack)
    }
}

The FrameUp FULayout protocol requires you to define which axes are fixed, the maximum item size, and a function that takes view sizes and outputs view offsets.

Below is an example layout that arranges views on left and right sides of a central line.

struct CustomFULayout: FULayout {
    /// Add parameters here to adjust layout
    
    /// Define these required parameters
    var fixedSize: Axis.Set = .horizontal
    var maxItemWidth: CGFloat? { maxWidth }
    var maxItemHeight: CGFloat? = nil
    
    func contentOffsets(sizes: [Int : CGSize]) -> [Int : CGPoint] {
        /// Write code that uses the dictionary of sizes and your parameters to output a dictionary of offsets from the top left corner.
    }
}

If you've created an FULayout you can use it to easily create a SwiftUI Layout.

struct CustomLayout: LayoutFromtFULayout {
    /// Add parameters here to adjust layout
    
    /// Add this function that will create the associated FULayout
    func fuLayout(maxSize: CGSize) -> CustomFULayout {
        CustomFULayout(
            /// Pass parameters through to FULayout using maxSize to help define the maximum item size.
        )
    }
}

An older and much simpler version of HFlow not based on FULayout.

A view that creates views based on an array of elements from left to right, adding rows when needed. Each row height will be determined by the tallest element.

Warning: Does not work in ScrollView.

TagView(elements: ["One", "Two", "Three"]) { element in
    Text(element)
}

A view that creates views based on an array of elements from left to right, adding rows when needed. Each row height will be determined by the tallest element.

A maximum width must be provided but WidthReader can be used to get the value.

WidthReader { width in
    TagView(maxWidth: width, elements: ["One", "Two", "Three"]) { element in
        Text(element)
    }
}

*iOS only

A re-scaled version of ContainerRelativeShape used to fix a bug with the corner radius on iPads running iOS 15 and earlier. It acts exactly the same as ContainerRelativeShape for iOS 16 and up.

This example has a blue background with a 1 point inset. On an iPad running iOS 15 or earlier, the red background will show on the corners as the corner radius does not match.

Text("Example widget")
    .background(.blue)
    .clipShape(WidgetRelativeShape(.systemSmall))
    .background(
        ContainerRelativeShape()
            .fill(.red)
    )
    .padding(1)