Skip to content
Backport of UICollectionViewCompositionalLayout to earlier iOS 12
Swift Objective-C Ruby
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows Update main.yml Aug 25, 2019
.swiftpm/xcode/package.xcworkspace Adding support for Swift Package Manager Aug 22, 2019
Carthage/Checkouts Update Carthage/Checkouts Sep 16, 2019
Configurations
Example Fix example UIColor extension Sep 16, 2019
IBPCollectionViewCompositionalLayout.xcodeproj Extract build settings to xcconfig files Aug 25, 2019
IBPCollectionViewCompositionalLayout.xcworkspace Initial commit Aug 6, 2019
Sources Bump version to 0.6.6 Sep 16, 2019
Tests Adding support for Swift Package Manager Aug 22, 2019
.gitignore
Cartfile.private
Cartfile.resolved Use DiffableDataSources 0.2.0 for the example project Sep 16, 2019
IBPCollectionViewCompositionalLayout.podspec
IBPCollectionViewCompositionalLayoutInteroperability.swift Adding support for Swift Package Manager Aug 22, 2019
LICENSE Initial commit Aug 6, 2019
Package.swift Add platform param Aug 22, 2019
README.md
azure-pipelines.yml Tweaks Aug 25, 2019

README.md

Languages Release CocoaPods Carthage MIT License


IBPCollectionViewCompositionalLayout

Backport of UICollectionViewCompositionalLayout to earlier iOS 12.

A new UICollectionViewCompositionalLayout class has been added to UIKit to make it incredibly easier to create custom complex collection view layout. You can use new excellent APIs immediately without maintaining two different code bases until iOS 13 would be widely adopted.

Note: that this library is still currently under active development. Please file all bugs, issues, and suggestions as an Issue in the GitHub repository.

What is Collection View Compositional Layouts?

At the WWDC 2019, Apple introduced a new form of UICollectionViewLayout. A new UICollectionViewCompositionalLayout class has been added to UIKit to make it easier to create compositional layouts without requiring a custom UICollectionViewLayout.

In iOS 12 and earlier, we need subclassing of UICollectionViewLayout to do that. We have to override lots of methods correctly, and it is error-prone.

With Collection View Compositional Layouts, you can make very complex layout even nested collection views with independently scrolling sections just within few lines of code.

See also:

Screenshots

Nested Group Orthogonal Scroll Orthogonal Scroll
screenshot screenshot screenshot
List Grid Inset Grid Column
screenshot screenshot screenshot screenshot
Distinct Sections Badges Nested Groups
screenshot screenshot screenshot
Mosaic Tile Grid Banner Tile Grid Portlait Tile Grid
screenshot screenshot screenshot screenshot

Usage

Copy IBPCollectionViewCompositionalLayout/IBPCollectionViewCompositionalLayoutInteroperability.swift file to your project. It tricks the compiler to make the same code base available for iOS 13 and earlier than iOS 12.

Import IBPCollectionViewCompositionalLayout.

Then you can use Collection View Compositonal Layouts API as-is.

import IBPCollectionViewCompositionalLayout

let itemSize = NSCollectionLayoutSize(widthDimension: .fractionalWidth(1),
                                     heightDimension: .fractionalHeight(1))
let item = NSCollectionLayoutItem(layoutSize: itemSize)

let groupSize = NSCollectionLayoutSize(widthDimension: .fractionalWidth(1),
                                      heightDimension: .absolute(44))
let group = NSCollectionLayoutGroup.horizontal(layoutSize: groupSize, subitems: [item])

let section = NSCollectionLayoutSection(group: group)

let layout = UICollectionViewCompositionalLayout(section: section)

let collectionView = UICollectionView(frame: .zero, collectionViewLayout: layout)
...

IBPCollectionViewCompositionalLayoutInteroperability.swift

This file silences the following compilation errors when building on Xcode 11 or higher environment.

'UICollectionViewCompositionalLayout' is only available in iOS 13.0 or newer

Features

  • Inter Item Spacing
  • Inter Group Spacing
  • Inter Section Spacing
  • Fixed Spacing
  • Flexible Spacing
  • Nested Groups
  • Vertical Scrolling
  • Horizontal Scrolling
  • Supplemental Views (e.g. Section Header/Footers)
  • Pinned Section Header/Footers
  • Decoration Views (e.g. Background Views)
  • Orthogonal Scrolling
  • Orthogonal Scrolling Behavior
  • Estimated Size (Autosizing)
  • Custom Group Item (Absolute Positions)
  • Drop-in replacement

TODOs (Not yet supported)

  • RTL Support
  • Visual Debug Description
  • Performance Optimization

Requirements

  • Swift 5.0+ or Objective-C
  • iOS 10.0+

Installation

CocoaPods

Add the following to your Podfile:

pod 'IBPCollectionViewCompositionalLayout'

Carthage

Add the following to your Cartfile:

github "kishikawakatsumi/IBPCollectionViewCompositionalLayout"

Special Thanks

Thanks to Ryo Aoyama, the author of DiffableDataSources. A backport library of Diffable Data Sources. It is used in the sample code.

Thanks to Astemir Eleev. Most of the sample code are borrowed from his uicollectionview-layouts-kit.

Author

Kishikawa Katsumi

Licence

The project is available under MIT Licence

You can’t perform that action at this time.