Waterfall Grids

Waterfall grid layout with lazy loading support for SwiftUI

<p> <a href="https://github.com/ricocrescenzio95/WaterfallGrids/releases"> <img src="https://img.shields.io/github/v/release/ricocrescenzio95/WaterfallGrids?include_prereleases&label=Swift%20Package%20Manager"> </a> <a href="https://swiftpackageindex.com/ricocrescenzio95/WaterfallGrids"> <img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fricocrescenzio95%2FWaterfallGrids%2Fbadge%3Ftype%3Dswift-versions"> </a> <a href="https://swiftpackageindex.com/ricocrescenzio95/WaterfallGrids"> <img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fricocrescenzio95%2FWaterfallGrids%2Fbadge%3Ftype%3Dplatforms"> </a> <a href="https://saythanks.io/to/rico.crescenzio"> <img src="https://img.shields.io/badge/SayThanks.io-%E2%98%BC-1EAEDB.svg"> </a> <a href="https://www.paypal.com/donate/?hosted_button_id=RWDBC8TS5CNVA"> <img src="https://img.shields.io/badge/$-donate-ff69b4.svg?maxAge=2592000&amp;style=flat"> </a> </p> <p align="center"> <img src="./Sources/WaterfallGrids/Documentation.docc/Resources/all@3x.png" width="800"> </p>

Features

• Lazy and non-lazy loading
• Vertical and horizontal arrangement
• Programmatic scroll
• All SwiftUI animations
• Support scroll view system modifiers such as scrollTargetLayout, scrollTargetBehavior, scrollTransition and so on
• Section header and footer

| Items roerder | Custom scroll paging and transitions | | --- | --- | | <img src="./Sources/WaterfallGrids/Documentation.docc/Resources/reorder.gif"> | <img src="./Sources/WaterfallGrids/Documentation.docc/Resources/advancedui.gif"> |

Installation

WaterfallGrids can be installed using Swift Package Manager.

1. In Xcode open File/Swift Packages/Add Package Dependency... menu.

2. Copy and paste the package URL:

https://github.com/ricocrescenzio95/WaterfallGrids

For more details refer to Adding Package Dependencies to Your App documentation.

Usage

In general WaterfallGrid or LazyWaterfallGrid APIs are very similar to other SwiftUI views like LazyVGrid and ForEach; both views have same initializers, allowing to easily switch between eager and lazy version.

WaterfallGrid(
	items: .columns([.init(), .init(alignment: .trailing, spacing: 10)]),
	spacing: 20,
	data: [0, 1, 2, 3, 4, 5, 6, 8, 9, 10],
	id: \.self
) { item in
	ItemView(item: item)
}

• items can be either rows() or column(), passing an array of WaterfallItems.Row or WaterfallItems.Column to specify how to arrange rows or columns; alignment and spacing allows to customize position and spacing of each view in a column/row
• spacing specify the distance between columns or rows
• data the collection of items to be showed in the grid
• id the keypath to identify which property of each element is the id. For Identifiable elements, this is inferred.
• content: a closure that returns a view for each element of data.

For advanced usages, please refer to the full Documentation.

Documentation

Use Apple DocC generated documentation, from Xcode, Product > Build Documentation.

Found a bug or want new feature?

If you found a bug, you can open an issue as a bug here

Want a new feature? Open an issue here

You can also open your own PR and contribute to the project! Contributing 🤝

License

This software is provided under the MIT license