One frequent query that arises when utilizing scroll views in SwiftUI is detect the scroll place. Previous to the discharge of iOS 17, builders needed to give you their very own options to seize the scroll positions. Nevertheless, the brand new model of SwiftUI has up to date ScrollView
with a brand new modifier known as scrollPosition
. With this new characteristic, builders can effortlessly establish the merchandise that’s being scrolled to.
On this tutorial, we’ll take a more in-depth have a look at this new modifier and study the way it can help you in detecting scroll positions in scroll views.
Utilizing the ScrollPosition Modifier to Detect Scroll Positions
Let’s start with a easy scroll view that shows a listing of fifty objects.
var physique: some View {
ScrollView {
LazyVStack(spacing: 10) {
ForEach(0…50, id: .self) { index in
bgColors[index % 5]
.body(top: 100)
.overlay {
Textual content(“(index)”)
.foregroundStyle(.white)
.font(.system(.title, weight: .daring))
}
}
}
}
.contentMargins(.horizontal, 10.0, for: .scrollContent)
}
}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
struct ColorListView: View { let bgColors: [Color] = [ .yellow, .blue, .orange, .indigo, .green ]
var physique: some View { ScrollView { LazyVStack(spacing: 10) { ForEach(0...50, id: .self) { index in
bgColors[index % 5] .body(top: 100) .overlay { Textual content(“(index)“) .foregroundStyle(.white) .font(.system(.title, weight: .daring)) } } } } .contentMargins(.horizontal, 10.0, for: .scrollContent)
} } |
The code is kind of simple if you’re acquainted with implementing a scroll view in SwiftUI. We make the most of a ForEach
loop to current 50 shade objects, that are then embedded inside a vertical scroll view. For those who add this code to a SwiftUI undertaking, you need to have the ability to preview it and see one thing much like the determine beneath.
To maintain monitor of the present scroll place or merchandise, you need to first declare a state variable to carry the place:
@State personal var scrollID: Int? |
Subsequent, connect the scrollPosition
modifier to the scroll view. This modifier takes a binding to scrollID
, which shops the scroll place:
…
}
.scrollPosition(id: $scrollID)
ScrollView {
...
} .scrollPosition(id: $scrollID) |
Because the scroll view scrolls, the binding might be up to date with the index of the colour view.
Lastly, connect the scrollTargetLayout
modifier to the LazyVStack
view as follows:
…
}
.scrollTargetLayout()
LazyVStack(spacing: 10) {
...
} .scrollTargetLayout() |
With out the scrollTargetLayout()
modifier, the scrollPosition
modifier won’t work accurately. The scrollPosition
modifier depends on the scrollTargetLayout()
modifier to configure which the format that incorporates your scroll targets.
To look at the adjustments of the scroll place, you’ll be able to connect a onChange
modifier to the scroll view and print the scroll ID to the console:
.onChange(of: scrollID) { oldValue, newValue in print(newValue ?? “”) } |
As you scroll via the checklist, the present scroll place needs to be displayed within the console.
Scroll to the High
Let’s implement yet one more characteristic utilizing the scrollPosition
modifier. When a person faucets any of the colour views, the checklist ought to mechanically scroll again to the highest.
This may be achieved by including a onTapGesture
modifier to every shade view, and passing a closure that units the scrollID
to 0
inside it. When the person faucets on any of the colour views, the scrollID
might be up to date to 0
, which can trigger the checklist to scroll again to the highest.
bgColors[index % 5] .body(top: 100) .overlay { Textual content(“(index)“) .foregroundStyle(.white) .font(.system(.title, weight: .daring)) } .onTapGesture { withAnimation { scrollID = 0 } } |
Adjusting Content material Margins of Scroll Views
Now that you know the way to detect the scroll place, let’s talk about yet one more new characteristic of scroll views in iOS 17. First, it’s the contentMargins
modifier. It is a new characteristic in SwiftUI that permits builders to customise the margins of scrollable views. With contentMargins
, you’ll be able to simply modify the quantity of house between the content material and the perimeters of the scroll view, supplying you with extra management over the format of your app.
Now we have already used this modifier within the pattern code that units the horizontal margin to 10 factors.
.contentMargins(.horizontal, 10.0, for: .scrollContent) |
The .scrollContent
parameter worth signifies that the content material margin ought to solely be utilized to the scroll content material, moderately than your entire scroll view. If you don’t specify the perimeters and placement parameters, the contentMargins
modifier will apply the margins to all edges of the scroll view. For instance, within the code beneath, it insets your entire scroll view by 50 factors, together with the scroll bar.
In case if you wish to preserve the scroll bar at its authentic place, you’ll be able to set the placement
parameter to .scrollContent
.
Abstract
The brand new scrollPosition
modifier is likely one of the most anticipated options of scroll views. In iOS 17, SwiftUI lastly introduces this characteristic permitting builders to detect scroll positions. On this tutorial, now we have demonstrated the utilization of this new modifier and launched one other new modifier known as contentMargins
, which permits builders to customise the margins of scrollable views.
With these new options in SwiftUI, builders can now effortlessly create extra personalized and visually interesting layouts for his or her apps.
For those who’re serious about studying extra about SwiftUI, don’t overlook to take a look at our Mastering SwiftUI e-book.