https://github.com/toshi0383/horizontalstickyheaderlayout
Horizontal UICollectionViewLayout with Sticky HeaderView
https://github.com/toshi0383/horizontalstickyheaderlayout
carthage headerview ios swift tvos uicollectionview uicollectionviewlayout
Last synced: 11 months ago
JSON representation
Horizontal UICollectionViewLayout with Sticky HeaderView
- Host: GitHub
- URL: https://github.com/toshi0383/horizontalstickyheaderlayout
- Owner: toshi0383
- License: mit
- Created: 2017-10-06T16:38:09.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-10-06T04:52:31.000Z (over 2 years ago)
- Last Synced: 2025-07-01T11:53:40.234Z (12 months ago)
- Topics: carthage, headerview, ios, swift, tvos, uicollectionview, uicollectionviewlayout
- Language: Swift
- Size: 91.8 KB
- Stars: 88
- Watchers: 4
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# HorizontalStickyHeaderLayout
Horizontal UICollectionViewLayout with Sticky HeaderView
[](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app)
[](https://cocoapods.org/pods/HorizontalStickyHeaderLayout)
[](http://mit-license.org)
# Requirements
- iOS9+
- tvOS9+
# How to use
Just implement these 5 required delegate methods.
```swift
extension ViewController: HorizontalStickyHeaderLayoutDelegate {
private enum Const {
static let headerSize = CGSize(width: 100, height: 38)
static let itemSize0 = CGSize(width: 50, height: 50)
static let itemSize1 = CGSize(width: 80, height: 80)
static let headerLeft: CGFloat = 8
}
func collectionView(_ collectionView: UICollectionView, hshlSizeForItemAtIndexPath indexPath: IndexPath) -> CGSize {
if indexPath.section % 2 == 0 {
return Const.itemSize0
} else {
return Const.itemSize1
}
}
func collectionView(_ collectionView: UICollectionView, hshlSizeForHeaderAtSection section: Int) -> CGSize {
return Const.headerSize
}
func collectionView(_ collectionView: UICollectionView, hshlHeaderInsetsAtSection section: Int) -> UIEdgeInsets {
return UIEdgeInsets(top: 0, left: Const.headerLeft, bottom: 20, right: 20)
}
func collectionView(_ collectionView: UICollectionView, hshlMinSpacingForCellsAtSection section: Int) -> CGFloat {
return 20
}
func collectionView(_ collectionView: UICollectionView, hshlSectionInsetsAtSection section: Int) -> UIEdgeInsets {
return UIEdgeInsets(top: 0, left: 0, bottom: 0, right: section == 4 ? 0 : 20)
}
}
```
Optionally you can define `contentInset` for outer margin.
See [Example](Example) for detail.
# Animated header Y position for tvOS for free!
## How to implement
- On focus, call `updatePoppingHeaderIndexPaths()` to recalculate the popping header indexPaths to get the latest indexPaths.
- Listen to pop indexPaths change on scroll by implementing `collectionView(_:,hshlDidUpdatePoppingHeaderIndexPaths:)` delegate method.
- animate container view of your header view.
See [Example](Example) for recommended implementation.
```swift
// Either in UICollectionViewDelegate or this override method.
override func didUpdateFocus(in context: UIFocusUpdateContext, with coordinator: UIFocusAnimationCoordinator) {
layout.updatePoppingHeaderIndexPaths()
let (pop, unpop) = self.getHeaders(poppingHeadersIndexPaths: self.layout.poppingHeaderIndexPaths)
UIView.animate(withDuration: Const.unpopDuration, delay: 0, options: [.curveEaseOut], animations: {
unpop.forEach { $0.unpopHeader() }
}, completion: nil)
coordinator.addCoordinatedAnimations({
pop.forEach { $0.popHeader() }
}, completion: nil)
super.didUpdateFocus(in: context, with: coordinator)
}
func collectionView(_ collectionView: UICollectionView, hshlDidUpdatePoppingHeaderIndexPaths indexPaths: [IndexPath]) {
let (pop, unpop) = self.getHeaders(poppingHeadersIndexPaths: self.layout.poppingHeaderIndexPaths)
UIView.animate(withDuration: Const.unpopDuration, delay: 0, options: [.curveEaseOut], animations: {
unpop.forEach { $0.unpopHeader() }
pop.forEach { $0.popHeader() }
}, completion: nil)
}
```
# Install
## SwiftPM
Install via Xcode.
## CocoaPods
```
pod "HorizontalStickyHeaderLayout"
```
# License
MIT