Skip to content

Instantly share code, notes, and snippets.

@chriseidhof
Last active January 31, 2024 19:00
Show Gist options
  • Save chriseidhof/3c6ea3fb2102052d1898d8ea27fbee07 to your computer and use it in GitHub Desktop.
Save chriseidhof/3c6ea3fb2102052d1898d8ea27fbee07 to your computer and use it in GitHub Desktop.
SwiftUI Flow Layout
//
// ContentView.swift
// DeleteMe
//
// Created by Chris Eidhof on 02.02.21.
//
import SwiftUI
/*
To calculate a flow layout, we need the sizes of the collection's elements. The "easiest" way to do this seems to be using preference keys: these are values that a child view can set and that get propagated up in the view hierarchy.
A preference key consists of two parts: a type for the data (this needs to be equatable) and a type for the key itself.
*/
struct MyPreferenceKeyData: Equatable {
var size: CGSize
var id: AnyHashable
}
struct MyPreferenceKey: PreferenceKey {
typealias Value = [MyPreferenceKeyData]
static var defaultValue: [MyPreferenceKeyData] = []
static func reduce(value: inout [MyPreferenceKeyData], nextValue: () -> [MyPreferenceKeyData]) {
value.append(contentsOf: nextValue())
}
}
// Next up, we create a wrapper view which renders it's content view, but also propagates its size up the view hierarchy using the preference key.
struct PropagatesSize<ID: Hashable, V: View>: View {
var id: ID
var content: V
var body: some View {
content.fixedSize().background(GeometryReader { proxy in
Color.clear.preference(key: MyPreferenceKey.self, value: [MyPreferenceKeyData(size: proxy.size, id: AnyHashable(self.id))])
})
}
}
// This is a flow layout directly taken from the Swift Talk episode on flow layouts (even though it's written for UIKit, we can reuse it without modification).
struct FlowLayout {
let spacing: UIOffset
let containerSize: CGSize
init(containerSize: CGSize, spacing: UIOffset = UIOffset(horizontal: 10, vertical: 10)) {
self.spacing = spacing
self.containerSize = containerSize
self.width = containerSize.width
}
var currentX = 0 as CGFloat
var currentY = 0 as CGFloat
var lineHeight = 0 as CGFloat
var width: CGFloat
mutating func add(element size: CGSize) -> CGRect {
if currentX + size.width > containerSize.width {
currentX = 0
width = max(width, size.width)
currentY += lineHeight + spacing.vertical
lineHeight = 0
}
defer {
lineHeight = max(lineHeight, size.height)
currentX += size.width + spacing.horizontal
}
return CGRect(origin: CGPoint(x: currentX, y: currentY), size: size)
}
var size: CGSize {
return CGSize(width: width, height: currentY + lineHeight)
}
}
/*
Finally, here's the collection view. It works as following:
It contains a collection of `Data` and a way to construct `Content` from an element of `Data`.
For each value of `Data`, it wraps the element in a `PropagatesSize` container, and then collects all those sizes to construct the layout.
*/
struct OverallHeightPreference: PreferenceKey {
static var defaultValue: CGFloat = 10
static func reduce(value: inout CGFloat, nextValue: () -> CGFloat) {
value = nextValue()
}
}
struct CollectionView<Data, Content>: View where Data: RandomAccessCollection, Data.Element: Identifiable, Content: View {
var data: Data
@State private var sizes: [MyPreferenceKeyData] = []
var content: (Data.Element) -> Content
@State private var height: CGFloat = 10
func layout(size: CGSize) -> (items: [AnyHashable:CGSize], size: CGSize) {
var f = FlowLayout(containerSize: size)
var result: [AnyHashable:CGSize] = [:]
for s in sizes {
let rect = f.add(element: s.size)
result[s.id] = CGSize(width: rect.origin.x, height: rect.origin.y)
}
return (result, f.size)
}
func withLayout(_ laidout: (items: [AnyHashable:CGSize], size: CGSize)) -> some View {
return ZStack(alignment: .topLeading) {
ForEach(self.data) { el in
PropagatesSize(id: el.id, content: self.content(el))
.offset(laidout.items[AnyHashable(el.id)] ?? .zero)
}
.preference(key: OverallHeightPreference.self, value: laidout.size.height)
}
.onPreferenceChange(MyPreferenceKey.self, perform: {
self.sizes = $0
})
.onPreferenceChange(OverallHeightPreference.self, perform: { value in
self.height = value
})
}
var body: some View {
return GeometryReader { proxy in
self.withLayout(self.layout(size: proxy.size))
}.frame(height: height)
}
}
// Just a temporary hack to make things work
extension Int: Identifiable {
public var id: Int {
return self
}
}
struct ContentView: View {
let items: [String] = (1..<10).map { num in
"Element \(num)" + String(repeating: "x", count: Int.random(in: 0..<5))
}
@State var width: CGFloat = 100
var pill: some View { RoundedRectangle(cornerRadius: 5).fill(Color.gray) }
var scrollViewExample: some View {
ScrollView(.vertical) {
VStack {
sample.background(Color.red)
sample.background(Color.green)
}
}
}
var sample: some View {
return CollectionView(data: Array(0..<self.items.count), content: { el in
Text(self.items[el])
.padding(10)
.background(pill)
}).padding(10)
}
var simpleExample: some View {
GeometryReader { proxy in
VStack {
HStack {
Rectangle().fill(Color.red).frame(width: self.width)
Spacer().frame(width: 20)
sample
}
Slider(value: self.$width.animation(), in: 0...proxy.size.width)
}
}
}
var body: some View {
// simpleExample
scrollViewExample
}
}
struct ContentView_Previews: PreviewProvider {
static var previews: some View {
ContentView()
}
}
@vanwagonet
Copy link

The actual flow layout can be accomplished much more simply. See an alternative approach.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment