Scaling Header Scroll View

A scroll view with a sticky header which shrinks as you scroll. Written with SwiftUI.

Usage

Put your header and content bodies code into a ScalingHeaderScrollView constructor.
Set the necessary modifiers, see below.

struct ContentView: View {

    var body: some View {
       ScalingHeaderScrollView {
            ZStack {
                Rectangle()
                    .fill(.gray.opacity(0.15))
                Image("header")
            }
        } content: {
            Text("↓ Pull to refresh ↓")
                .multilineTextAlignment(.center)
                .padding()
        }
    }
}

Required parameters

header - @ViewBuilder for your header
content - @ViewBuilder for your content

Available modifiers, optional

passes current collapse progress value into progress binding: 0 for not collapsed at all, 1 - for fully collapsed

.collapseProgress(_ progress: Binding<CGFloat>)

allows to set up callback for ScrollView reaching the bottom

.scrollViewDidReachBottom(perform: @escaping () -> Void)

allows to set up callback and isLoading state for pull-to-refresh action

.pullToRefresh(isLoading: Binding<Bool>, perform: @escaping () -> Void)

allows to set up callback and isLoading state for pull-to-load-more action

.pullToLoadMore(isLoading: Binding<Bool>, perform: @escaping () -> Void)

allows content scroll reset, need to change Binding to true

.scrollToTop(resetScroll: Binding<Bool>)

allows to change current header height, need to change state, possible values are .collapsed, .expanded or .custom(CFGloat)

.snapHeaderToState(state: Binding<SnapHeaderState?>, animated: Bool)

changes min and max heights of Header, default min = 150.0 and max = 350.0

.height(min: CGFloat = 150.0, max: CGFloat = 350.0)

when scrolling up - switch between actual header collapse and simply moving it up (by default moving up)

.allowsHeaderCollapse()

when scrolling down - enable (disabled by default) header scale

.allowsHeaderGrowth()

Enable/disable (disabled by default) header snap. Available modes:

.disabled - Disable header snap.
.immediately - Once you lift your finger header snaps either to min or max height automatically.
.afterFinishAccelerating - At the end of scroll view deceleration the header snaps either to min or max height automatically.

.setHeaderSnapMode(.immediately)

Set custom positions for header snap (explained previous point). Specify any amount of values in 0...1 to set snapping points, 0 - fully collapsed header, 1 - fully expanded

.headerSnappingPositions(snapPositions: [CGFloat])

Set custom initial position to which scroll view will be automatically snapped to. Specify a value in 0...1, 0 - fully collapsed header, 1 - fully expanded

.initialSnapPosition(initialSnapPosition: CGFloat)

hide scroll indicators (false by default)

.hideScrollIndicators()

Examples

To try ScalingHeaderScrollView examples:

Clone the repo https://github.com/exyte/ScalingHeaderScrollView.git
Open terminal and run cd <ScalingHeaderScrollViewRepo>/Example/
Run pod install to install all dependencies
Run open Example.xcworkspace/ to open project in the Xcode
Try it!

Installation

Swift Package Manager

dependencies: [
    .package(url: "https://github.com/exyte/ScalingHeaderScrollView.git")
]

CocoaPods

To install ScalingHeaderScrollView, simply add the following line to your Podfile:

pod 'ScalingHeaderScrollView'

Carthage

To integrate ScalingHeaderScrollView into your Xcode project using Carthage, specify it in your Cartfile

github "Exyte/ScalingHeaderScrollView"

Requirements

iOS 14+
Xcode 12+

Our other open source SwiftUI libraries

PopupView - Toasts and popups library
Grid - The most powerful Grid container
AnimatedTabBar - A tabbar with number of preset animations
MediaPicker - Customizable media picker
Chat - Chat UI framework with fully customizable message cells, input view, and a built-in media picker
ConcentricOnboarding - Animated onboarding flow
FloatingButton - Floating button menu
ActivityIndicatorView - A number of animated loading indicators
ProgressIndicatorView - A number of animated progress indicators
SVGView - SVG parser
LiquidSwipe - Liquid navigation animation

exyte / ScalingHeaderScrollView