epoxy-ios

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

Table of contents

• Installation
  • CocoaPods
  • Swift Package Manager (SPM)
• Modules
• Documentation and tutorials
• Getting started
  • EpoxyCollectionView
  • EpoxyBars
  • EpoxyNavigationController
  • EpoxyPresentations
  • EpoxyLayoutGroups
• FAQ
• Contributing
• License
• Credits

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
EpoxyLayoutGroups	Declarative API for building composable layouts in UIKit with a syntax similar to SwiftUI's stack APIs
EpoxyCore	Foundational APIs that are used to build all Epoxy declarative UI APIs

Documentation and tutorials

For full documentation and step-by-step tutorials please check the wiki. For type-level documentation, see the Epoxy DocC documentation hosted on the Swift Package Index.

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.

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.

This is the beginning of the README. Read the rest at the original. Read the full README ↗