Skip to content

Latest commit

 

History

History
124 lines (89 loc) · 4.8 KB

README.md

File metadata and controls

124 lines (89 loc) · 4.8 KB
Raw

Swift   Bazel   Pages   Artifactory

Layout

High Fidelity Auto Layout Result Builder Syntax for UIKit

Overview

Layout was introduced into the iOS codebase at Tinder in 2017 and has since been used to programmatically define the screens of the app.

Layout is a wrapper around the Apple platform Auto Layout SDK and provides a less verbose DSL to aid in adoption and ease troubleshooting UI layout issues. Projects with large codebases use this type of programmatic UI code instead of visual WYSIWYG editors (such as Xcode storyboards) to avoid unmanageable merge conflicts that occur in file formats such as XML (the serialized format of Xcode storyboards).

Code written with Layout leverages a high fidelity syntax, meaning it is easy to visualize the UI layout that the code represents. However, Layout does not limit the native Auto Layout capabilities in any way, which can readily be used along with the Layout API. In recent years, mobile platforms have seen the introduction of declarative UI frameworks such as SwiftUI and Jetpack Compose which realize significantly reduced learning curves. Layout also takes a declarative approach, in this case for the UIKit framework.

Minimum Requirements

  • iOS 13.0
  • Swift 5.7

Installation

Swift Package Manager

Package Dependency

Replace <version> with the desired minimum version.

.package(url: "https://github.com/Tinder/Layout.git", from: "<version>")

Target Dependencies

Layout

"Layout"

Snapshot Testing Extensions (for test targets)

.product(name: "SnapshotTestingExtensions", package: "Layout")

Swift Package Collection

https://swiftpackageindex.com/Tinder/collection.json

Usage

The following example demonstrates adding a label, an image view and a button as subviews of a view controller's view.

override func viewDidLoad() {
    super.viewDidLoad()
    view.layout {
        label
            .toSafeArea([.top])
            .center(.horizontal)
        imageView
            .toSideEdges(inset: 20)
            .height(200)
        button
            .center(.horizontal)
    }
    .vertical([label, imageView, button], spacing: 50)
    .activate()
}

The code above is equivalent to the following Auto Layout code.

override func viewDidLoad() {
    super.viewDidLoad()
    label.translatesAutoresizingMaskIntoConstraints = false
    imageView.translatesAutoresizingMaskIntoConstraints = false
    button.translatesAutoresizingMaskIntoConstraints = false
    view.addSubview(label)
    view.addSubview(imageView)
    view.addSubview(button)
    NSLayoutConstraint.activate([
        label.topAnchor.constraint(equalTo: view.safeAreaLayoutGuide.topAnchor),
        label.centerXAnchor.constraint(equalTo: view.centerXAnchor),
        imageView.leftAnchor.constraint(equalTo: view.leftAnchor, constant: 20),
        imageView.rightAnchor.constraint(equalTo: view.rightAnchor, constant: -20),
        imageView.heightAnchor.constraint(equalToConstant: 200),
        button.centerXAnchor.constraint(equalTo: view.centerXAnchor),
        imageView.topAnchor.constraint(equalTo: label.bottomAnchor, constant: 50),
        button.topAnchor.constraint(equalTo: imageView.bottomAnchor, constant: 50)
    ])
}

Documentation

Documentation is viewable in Xcode by selecting Build Documentation from the Product menu, or online at: https://tinder.github.io/Layout

And a quick reference guide is available at: https://tinder.github.io/Layout/cheatsheet

Related Tools

Layout is an alternative solution to other open source Auto Layout libraries, such as:

Contributing

While interest in contributing to this project is appreciated, it has been open sourced solely for the purpose of sharing with the community. This means we are unable to accept outside contributions at this time and pull requests will not be reviewed or merged. To report a security concern or vulnerability, please submit a GitHub issue.

License

Licensed under the Match Group Modified 3-Clause BSD License.