Skip to content

plivesey/CollectionThing

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A CollectionView-y Thing For SwiftUI

This is a sketch of an approach that lets you put a ton of items into a SwiftUI ScrollView while maintaining decent performance. Even with 50,000 elements, the view appears almost immediately, and memory usage is not terrible.

No weird uses of DispatchQueue.async, and (as far as I am concerned) it doesn't really contain any gross hacks. Beauty is in the eye of the beholder, etc…

How does it work?

It's a lot like a {UI,NS}CollectionView in that you're responsible for maintaining the layout logic of views by yourself. But—as you can see—the WrappedLayout struct that I supplied isn't overly complicated. It just takes your model objects, and packages them up into rows. Those rows have frames, and the layout itself has an overall contentSize.

The ContentView calculates the current visibleRect using PreferenceKeys, and on changing preference values, the layout is queried for the rows that overlap the current visibleRect (plus a bit of "slop factor" to reduce flashing—play around for your own needs).

A @State variable tracks the current set of visibleRows, and those are only updated when we start to get close to the edge of the rows we've already cached.

When everything's laid out, the content of your ScrollView will look like this:

+++++++++++++++++++++++++
|     Color(.clear)     |
|                       |
|                       |
+++++++++++++++++++++++++
|  VStack(visibleRows)  |
|                       +++
|                       | |
|                       | | visibleRect 
|                       | |
|                       +++
|                       |
+++++++++++++++++++++++++
|                       |
|                       |
|                       |
+++++++++++++++++++++++++

Effectively, the "magic" here is in the fact that a VStack contains only as many rows as you'll need, and no more. It is positioned at the same spot where those visible rows would normally appear if you had a VStack containing all of the rows in the layout. It looks an awful lot like the way UICollectionView works—only creating views that are visible, while defining a larger content area.

As you scroll, the inner VStack is only updated when the visibleRows change. So you'll experience the native scrolling speed until it is deemed that new rows need to get "faulted in" to the view. Even then, a reasonably new device should be able to retain smooth scrolling since SwiftUI can generate that new set of views very quickly. Much faster than trying to calculate the viewport for the entire data set.

When the visibleRows do change, they are mostly the same—the amount of churn inside the inner VStack should be minimal because the Rows themselves are Identifiable.

Keys to Performance

There are a few things that (I think) are important here:

  1. The root-level @ObservedObject whose value does not change
  2. The @State variables that only get set when necessary
  3. Row values that are identifiable, used in concert with the inner VStack to try and keep churn to a minimum

Known Issues

The implementation is obviously incomplete, and there many details that you'll need to get sorted out.

Stuff like:

  • Incorporating the safeAreaInsets into your layout (which are readable from the outer GeometryProxy on the ScrollView)
  • Dealing with rotation
  • Insertion/removal animations
  • Being smarter/faster about querying your Rows
  • Selection management

Plenty of exercises for the reader. :)

Credits/etc.

Thanks to the folks at swiftui-lab for their post that gave me a few nifty ideas that helped me narrow down my initial work on this.

If you find this repo helpful, that's great! To repay me, you can go and check out Capo. Then, tell your friends to do the same.

Also, pull requests are welcome if you find any opportunities for making this go even faster without resorting to anything gross.

About

Scroll fast using pure SwiftUI

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Swift 100.0%