spring-media/lazypages

A highly customizable library that helps you to show a scrollable list of view controllers synchronized with an index. It is written in Swift 5 for iOS 8+.

LazyPages

LazyPages is a highly customizable library that helps you to show a scrollable list of view controllers synchronized with an index. It is written in Swift 5 for iOS 11+.

Requirements

• iOS 11+
• Xcode 12.2+

Features

• Lazy load of view controllers, that allow us not to have all of them in memory when initialazing LazyPages. Furthermore, we can also initialise it with all the UIViewController instances or with closures that provides them.
• View controllers are cached, and freed when memory is low. The number of cached view controllers can be customized.
• View controllers can be instances of different subclasses of UIViewController.
• Highly customizable, we can place the index and pages views as we wish, as well as desigining the index cells, with the help of Storyboard. Scroll directions could be set as wished.
• Public API to go to a desired page.
• Usage of UIViewController, not UIView.

Usage

An instance of LazyPages can be created from the storyboard or just programmatically.

To create it from the storyboard:

• Add an instance of UIViewController to it. It will be the container of the Page Controller.
• Add two container views, one for the index and one for the page controller.
• Linked to these container views we have now two view controllers. In the desired index view controller set the class to PageIndexCollectionViewController, and in the PageController to PageController. Set their module to LazyPages.
• Inside the Index View Controller drag and drop an instance of UICollectionView and link it through an outlet to the collectionView property of the class. This collection view will represent the index; we will be able to customize the cells inside the Storyboard.

In the code of our view controller, we have to link both view controllers together and set the proper data source. We can do that in the prepareForSegue method:

override func prepare(for segue: UIStoryboardSegue, sender: Any?) {
    guard let identifier = segue.identifier else {
      return
    }

    guard let segueEnum = Segue(rawValue: identifier) else {
      return
    }

    switch segueEnum {
    case .PageController:
      guard let pageController = segue.destinationViewController as? PageController else {
        break
      }

      self.pageController = pageController
      pageController.dataSource = self
    case .PageIndex:
      guard let pageIndex = segue.destinationViewController as? PageIndexCollectionViewController else {
        break
      }

      self.pageIndex = pageIndex
      pageIndex.dataSource = self
    }
  }

If you want to implement it programmatically, you have to create and instance of UICollectionView and assign it to the property of PageIndexCollectionViewController as we explained in the storyboard case. As specified before we have to link them together in both cases:

pageController?.pageIndexController = self.pageIndex
pageIndex?.pageController = self.pageController

To populate the views, we assign the data source properties for both the index and the Page Controller. For the Page Controller we can implement the data source ourselves, or use the provided data source classes (PageControllerArrayDataSource and PageControllerClosureDataSource) that respectively require an array of UIViewController or closures. We can easily define a visual state for selection in the index view by overriding the selected property in the UICollectionViewCell subclass that we provide in the PageIndexCollectionViewController data source:

override var isSelected: Bool {
    didSet {
      if isSelected {
        backgroundColor = UIColor.gray
        indexLabel.textColor = UIColor.white
      } else {
        backgroundColor = UIColor.white
        indexLabel.textColor = UIColor.black
      }
    }
  }

If you want to customize the amount of view controllers you cache, customize the cachingNeighborsCount property of PageController according to your needs.

Installation

Swift Package Manager

Add LazyPages to your project through the Xcode or add the following line to your package dependencies:

.package("https://github.com/spring-media/LazyPages", from: "1.0.0")

License

LazyPages is available under the MIT license.

Authors

LazyPages was made in-house by Spring-Media

Contributors

César Vargas Casaseca, [email protected], @toupper on Github, @VargasCasaseca on Twitter

Vittorio Monaco, @vittoriom on Github, @Vittorio_Monaco on Twitter