• Stars
    star
    284
  • Rank 145,616 (Top 3 %)
  • Language
    Swift
  • License
    MIT License
  • Created almost 2 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

ScrollKit is a SwiftUI library that adds powerful scrolling features to SwiftUI, such as offset tracking and sticky scroll view headers.

ScrollKit Logo

Version Swift 5.9 Swift UI MIT License Twitter: @danielsaidi Mastodon: @danielsaidi@mastodon.social

About ScrollKit

ScrollKit is a SwiftUI SDK that adds powerful scroll features, like offset tracking and a header view that stretches & transforms as you pull down, and sticks to the top when you scroll.

The result can look like this, or completely different:

ScrollKit is designed to be easy to use and works on all major Apple platforms.

Installation

ScrollKit can be installed with the Swift Package Manager:

https://github.com/danielsaidi/ScrollKit.git

Getting started

ScrollKit has a ScrollViewWithOffsetTracking view that can detect scrolling:

ScrollViewWithOffsetTracking { offset in
    print(offset)
} content: {
    // Add your scroll content here, e.g. a `LazyVStack`
}

ScrollKit also has a ScrollViewWithStickyHeader that makes it easy to set up a stretchy, sticky header:

struct MyView: View {

    @State
    private var offset = CGPoint.zero
    
    @State
    private var visibleRatio = CGFloat.zero
    
    func handleOffset(_ scrollOffset: CGPoint, visibleHeaderRatio: CGFloat) {
        self.offset = scrollOffset
        self.visibleRatio = visibleHeaderRatio
    }
    
    func header() -> some View {
        ZStack(alignment: .bottomLeading) {
            Color.blue
            Color.yellow.opacity(visibleRatio)  // Fades in
        }
    }

    var body: some View {
        ScrollViewWithStickyHeader(
            header: header,
            headerHeight: 250,
            headerMinHeight: 150,
            onScroll: handleOffset
        ) {
            // Add your scroll content here, e.g. a `LazyVStack`
        }
    }
}

For more information, please see the getting started guide.

Documentation

The online documentation has more information, articles, code examples, etc.

Demo Application

The demo app lets you explore the library. To try it out, just open and run the Demo project.

Support my work

You can sponsor me on GitHub Sponsors or reach out for paid support, to help support my open-source projects.

Your support makes it possible for me to put more work into these projects and make them the best they can be.

Contact

Feel free to reach out if you have questions or want to contribute in any way:

License

ScrollKit is available under the MIT license. See the LICENSE file for more info.

More Repositories

1

Sheeeeeeeeet

Sheeeeeeeeet is a Swift library for creating menus, custom action sheets, context menus etc.
Swift
1,538
star
2

SwiftUIKit

SwiftUIKit contains additional functionality for SwiftUI.
Swift
911
star
3

RichTextKit

RichTextKit is a Swift SDK that helps you use rich text in Swift and SwiftUI.
Swift
910
star
4

OnboardingKit

Tutti is a Swift library that lets you create tutorial and hint-based onboarding.
Swift
376
star
5

DeckKit

DeckKit makes it easy to create deck-based apps in SwiftUI.
Swift
331
star
6

SystemNotification

SystemNotification is a SwiftUI library that lets you mimic the native iOS system notification. It supports extensive styling, custom views and can be used on all major Apple platforms.
Swift
205
star
7

BottomSheet

BottomSheet lets you add custom bottom sheets to your SwiftUI apps.
Swift
181
star
8

SwiftUIBlurView

This view is also part of SwiftUIKit: https://github.com/danielsaidi/SwiftUIKit
Swift
122
star
9

KeyboardKitSwiftUI

KeyboardKitSwiftUI contains SwiftUI add-ons to KeyboardKit
Swift
63
star
10

MockingKit

MockingKit is a Swift-based library that lets you mock protocols and classes. It lets you register function results, invoke and inspect method calls etc.
Swift
57
star
11

WebViewKit

WebViewKit adds a WebView to SwiftUI.
Swift
55
star
12

SwiftKit

SwiftKit adds extra functionality to the Swift programming language.
Swift
51
star
13

StoreKitPlus

StoreKitPlus contains additional functionality for working with StoreKit 2.
Swift
38
star
14

nextra

NExtra is a C# library with extended functionality for the .NET Framework.
C#
27
star
15

TagKit

TagKit makes it easy to create tag-based apps in SwiftUI.
Swift
26
star
16

osx

Setup OS X with Homebrew, Cask, Node, npm, Gulp and a lot of other goodies.
Shell
25
star
17

Cloney

Cloney is an open-source client application that lets you clone .NET solutions
C#
24
star
18

ApiKit

ApiKit is a Swift library that makes it easy to perform async api calls.
Swift
18
star
19

iExtra

iExtra contains a bunch of general functionality that I use in my apps.
Swift
17
star
20

PrintingKit

PrintingKit is a Swift-based SDK that helps you print in Swift and SwiftUI.
Swift
12
star
21

GoogleTranslateSwift

A micro framework for integrating with the Google Translate api
Swift
8
star
22

Vandelay

Vandelay is an iOS importer/exporter, written in Swift.
Swift
7
star
23

trySwiftTvApp

This repository contains the SwiftUI-based tvOS app for the try! Swift World tvOS workshop.
Swift
5
star
24

SwiftData

I can't wait anymore! Let's build a Swifty layer on top of Core Data! πŸ˜…
4
star
25

wwdc20

WWDC20 test projects
Swift
3
star
26

trySwiftColorKitProSource

This repository contains the closed-source library for the try! Swift World SPM workshop.
Ruby
3
star
27

trySwiftColorKit

This repository contains the open-source library for the try! Swift World SPM workshop.
Swift
2
star
28

wwdc21

WWDC21 test projects
Swift
2
star
29

QuartzPdfTest

A test project for writing attributed strings to a local PDF
Swift
2
star
30

QuickType

QuickSearch lets type into a searchable text fields by typing on the keyboard without first having to focus on the text field.
Swift
2
star
31

trySwiftColorKitPro

This repository contains the closed-source distribution package for the try! Swift World SPM workshop.
C
1
star
32

VandelayQr

VandelayQr adds QR code support to Vandelay.
Swift
1
star