onScrollGeometryChange
Adds an action to be performed when a value, created from a scroll geometry, changes.
Declaration
compose().onScrollGeometryChange<T>({
of: (arg0: SymbolicValue) => unknown,
action: (oldValue: T, newValue: T) => void,
})nonisolated func onScrollGeometryChange<T>(
for type: T.Type,
of transform: @escaping (ScrollGeometry) -> T,
action: @escaping (T, T) -> Void
) -> some View
where T : EquatableParameters
options.of*(arg0: SymbolicValue) => unknownoptions.action*(oldValue: T, newValue: T) => voidA closure to run when the transformed data changes. - term oldValue: The old value that failed the comparison check. - term newValue: The new value that failed the comparison check.
Discussion
The geometry of a scroll view changes frequently while scrolling. You should avoid updating large parts of your app whenever the scroll geometry changes. To aid in this, you provide two closures to this modifier:
- transform: This converts a value of
ScrollGeometryto a your own data type. - action: This provides the data type you created in
ofand is called whenever the data type changes.
For example, you can use this modifier to know when the user scrolls
a scroll view beyond the top of its content. In the following example,
the data type you convert to is a Bool and the action is called
whenever the Bool changes.
@Binding var isBeyondZero: Bool
ScrollView {
// ...
}
.onScrollGeometryChange(for: Bool.self) { geometry in
geometry.contentOffset.y < geometry.contentInsets.top
} action: { wasBeyondZero, isBeyondZero in
self.isBeyondZero = isBeyondZero
}If multiple scroll views are found within the view hierarchy, only the first one will invoke the closure you provide and a runtime issue will be logged. For example, in the following view, only the vertical scroll view will have its geometry changes invoke the provided closure.
VStack {
ScrollView(.vertical) { ... }
ScrollView(.horizontal) { ... }
}
.onScrollGeometryChange(for: Bool.self) { geometry in
...
} action: { oldValue, newValue in
...
}For responding to non-scroll geometry changes, see the
View.onGeometryChange(for:of:action:) modifier.
See also
More in Events and lifecycle.
- onAppearAdds an action to perform before this view appears.
- onChangeAdds a modifier for this view that fires an action when a specific value changes.
- onContinueUserActivityRegisters a handler to invoke in response to a user activity that your app receives.
- onContinuousHoverAdds an action to perform when the pointer enters, moves within, and exits the view's bounds.
- onDisappearAdds an action to perform after this view disappears.
- onDragActivates this view as the source of a drag and drop operation.
- onDragSessionUpdatedSpecifies an action to perform on each update of an ongoing dragging operation activated by draggable(:) or anther drag modifiers.
- onDropDefines the destination of a drag and drop operation that handles the dropped content with a closure that you specify.
- onDropSessionUpdatedSpecifies an action to perform on each update of an ongoing drop operation activated by dropDestination(:) or other drop modifiers.
- onGeometryChangeAdds an action to be performed when a value, created from a geometry proxy, changes.
- onHingeChangeAdds an action to perform when the hinge context of the view hierarchy changes.
- onHoverAdds an action to perform when the user moves the pointer over or away from the view's frame.