Swift Package Index

Epoxy

https://github.com/airbnb/epoxy-ios.git

Epoxy is a suite of declarative UI APIs for building UIKit applications in Swift


Compatibility

  • 0.1.0 and master
    5.3
    5.2
    5.1
    5.0
    4.2
  • 0.1.0 and master
    iOS
    macOS(Intel)
    macOS(ARM)
    Linux
    tvOS
    watchOS

Build Status Swift Package Manager compatible Version Platform

Epoxy is a suite of declarative UI APIs for building UIKit applications in Swift. Epoxy is inspired and influenced by the wonderful Epoxy framework on Android, as well as other declarative UI frameworks in Swift such as SwiftUI.

Epoxy was developed at Airbnb and powers thousands of screens in apps that are shipped to millions of users. It has been developed and refined for years by dozens of contributors.

Below are a few sample screens from the Airbnb app that we've built using Epoxy. Our usages of Epoxy span from our simplest forms and static screens to our most advanced and dynamic features.

Home Details Home Photos Messaging Registration
Home Details Home Photos Messaging Registration

Table of contents

Installation

Epoxy can be installed using CocoaPods or Swift Package Manager.

CocoaPods

To get started with Epoxy using Cocoapods add the following to your Podfile and then follow the integration instructions.

pod 'Epoxy'

Epoxy is separated into podspecs for each module so you only have to include what you need.

Swift Package Manager (SPM)

To install Epoxy using Swift Package Manager you can follow the tutorial published by Apple using the URL for the Epoxy repo with the current version:

  1. In Xcode, select “File” → “Swift Packages” → “Add Package Dependency”
  2. Enter https://github.com/airbnb/epoxy-ios.git

Epoxy is separated library products for each module so you only have to include what you need.

Modules

Epoxy has a modular architecture so you only have to include what you need for your use case:

Module Description
Epoxy Includes all of the below modules in a single import statement
EpoxyCollectionView Declarative API for driving the content of a UICollectionView
EpoxyNavigationController Declarative API for driving the navigation stack of a UINavigationController
EpoxyPresentations Declarative API for driving the modal presentations of a UIViewController
EpoxyBars Declarative API for adding fixed top/bottom bar stacks to a UIViewController
EpoxyCore Foundational APIs that are used to build all Epoxy declarative UI APIs

Getting Started

EpoxyCollectionView

EpoxyCollectionView provides a declarative API for driving the content of a UICollectionView. CollectionViewController is a subclassable UIViewController that lets you easily spin up a UICollectionView-backed view controller with a declarative API.

The following code samples will render a single cell in a UICollectionView with a TextRow component rendered in that cell. TextRow is a simple UIView containing two labels that conforms to the EpoxyableView protocol.

You can either instantiate a CollectionViewController instance directly with sections, e.g. this view controller with a selectable row:

enum DataID {
  case row
}

let viewController = CollectionViewController(
  layout: UICollectionViewCompositionalLayout
    .list(using: .init(appearance: .plain)),
  sections: [
    SectionModel(items: [
      TextRow.itemModel(
        dataID: DataID.row,
        content: .init(title: "Tap me!"),
        style: .small)
        .didSelect { _ in
          // Handle selection
        }
    ])
  ])

Or you can subclass CollectionViewController for more advanced scenarios, e.g. this view controller that keeps track of a running count:

class CounterViewController: CollectionViewController {
  init() {
    let layout = UICollectionViewCompositionalLayout
      .list(using: .init(appearance: .plain))
    super.init(layout: layout)
    setSections(sections, animated: false)
  }

  private enum DataID {
    case row
  }

  private var count = 0 {
    didSet { setSections(sections, animated: true) }
  }

  private var sections: [SectionModel] {
    [
      SectionModel(items: [
        TextRow.itemModel(
          dataID: DataID.row,
          content: .init(
            title: "Count \(count)",
            body: "Tap to increment"),
          style: .large)
          .didSelect { [weak self] _ in
            self?.count += 1
          }
      ])
    ]
  }
}

You can learn more about EpoxyCollectionView in its wiki entry.

EpoxyBars

EpoxyBars provides a declarative API for rendering fixed top, fixed bottom, or input accessory bar stacks in a UIViewController.

The following code example will render a ButtonRow component fixed to the bottom of the UIViewController's view. ButtonRow is a simple UIView component that contains a single UIButton constrained to the margins of the superview that conforms to the EpoxyableView protocol:

class BottomButtonViewController: UIViewController {
  override func viewDidLoad() {
    super.viewDidLoad()
    bottomBarInstaller.install()
  }

  private lazy var bottomBarInstaller = BottomBarInstaller(
    viewController: self,
    bars: bars)

  private var bars: [BarModeling] {
    [
      ButtonRow.barModel(
        content: .init(text: "Click me!"),
        behaviors: .init(didTap: {
          // Handle button selection
        }))
    ]
  }
}

You can learn more about EpoxyBars in its wiki entry.

EpoxyNavigationController

EpoxyNavigationController provides a declarative API for driving the navigation stack of a UINavigationController.

The following code example shows how you can use this to easily drive a feature that has a flow of multiple view controllers:

class FormNavigationController: NavigationController {
  init() {
    super.init()
    setStack(stack, animated: false)
  }

  private struct State {
    var showStep2 = false
  }

  private enum DataID {
    case step1, step2
  }

  private var state = State() {
    didSet { setStack(stack, animated: true) }
  }

  private var stack: [NavigationModel?] {
    [step1, step2]
  }

  private var step1: NavigationModel {
    .root(dataID: DataID.step1) { [weak self] in
      Step1ViewController(didTapNext: {
        self?.state.showStep2 = true
      })
    }
  }

  private var step2: NavigationModel? {
    guard state.showStep2 else { return nil }

    return NavigationModel(
      dataID: DataID.step2,
      makeViewController: {
        Step2ViewController(didTapNext: {
          // Navigate away from this step.
        })
      },
      remove: { [weak self] in
        self?.state.showStep2 = false
      })
  }
}

You can learn more about EpoxyNavigationController in its wiki entry.

EpoxyPresentations

EpoxyPresentations provides a declarative API for driving the modal presentation of a UIViewController.

The following code example shows how you can use this to easily drive a feature that shows a modal when it first appears:

class PresentationViewController: UIViewController {
  override func viewDidAppear(_ animated: Bool) {
    super.viewDidAppear(animated)
    setPresentation(presentation, animated: true)
  }

  private enum DataID {
    case detail
  }

  private var showDetail = true {
    didSet {
      setPresentation(presentation, animated: true)
    }
  }

  private var presentation: PresentationModel? {
    guard showDetail else { return nil }

    return PresentationModel(
      dataID: DataID.detail,
      presentation: .system,
      makeViewController: { [weak self] in
        DetailViewController(didTapDismiss: {
          // Handle tapping the dismiss button:
          self?.showDetail = false
        })
      },
      dismiss: { [weak self] in
        // Or swiping down the sheet:
        self?.showDetail = false
      })
  }
}

You can learn more about EpoxyPresentations in its wiki entry.

Documentation and Tutorials

For full documentation and step-by-step tutorials please check the wiki.

There's also a full sample app with a lot of examples that you can either run via the EpoxyExample scheme in Epoxy.xcworkspace or browse its source.

If you still have questions, feel free to create a new issue.

FAQ

Contributing

Pull requests are welcome! We'd love help improving this library. Feel free to browse through open issues to look for things that need work. If you have a feature request or bug, please open a new issue so we can track it. Contributors are expected to follow the Code of Conduct.

License

Epoxy is released under the Apache License 2.0. See LICENSE for details.

Credits

Logo design by Alana Hanada and Jonard La Rosa