Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jrsaruo/AceLayout

AceLayout provides a Swifty DSL for Auto Layout.
https://github.com/jrsaruo/AceLayout

appkit autolayout constraints ios macos swift tvos type-safety uikit

Last synced: 2 months ago
JSON representation

AceLayout provides a Swifty DSL for Auto Layout.

Host: GitHub
URL: https://github.com/jrsaruo/AceLayout
Owner: jrsaruo
License: mit
Created: 2021-12-24T17:52:27.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-07-15T11:24:48.000Z (5 months ago)
Last Synced: 2024-09-16T16:17:57.773Z (3 months ago)
Topics: appkit, autolayout, constraints, ios, macos, swift, tvos, type-safety, uikit
Language: Swift
Homepage:
Size: 256 KB
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# AceLayout

AceLayout provides a Swifty DSL for Auto Layout.

[![Test](https://github.com/jrsaruo/AceLayout/actions/workflows/test.yml/badge.svg)](https://github.com/jrsaruo/AceLayout/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/jrsaruo/AceLayout/branch/main/graph/badge.svg?token=NN5TRPRC5O)](https://codecov.io/gh/jrsaruo/AceLayout)

## Requirements

- iOS 11.0+ / macOS 10.13+ / tvOS 11.0+
- Xcode 14.3+
- Swift 5.8+

## Features

- **Strongly typed.**
- The compiler does not accept wrong constraints such as `some.top == another.leading`.
- **Simple, modern and unmistakable APIs.**
- **No need to write boilerplates.**
- `view.translatesAutoresizingMaskIntoConstraints = false`
- `constraint.isActive = true`

## Usage

### Basic

#### Constraints Building

Call the `autoLayout` method of your `UIView`, `UILayoutGuide`, `NSView` or `NSLayoutGuide` with a closure that describes Auto Layout constraints.

```swift
view.autoLayout { item in
item.top.equal(to: anotherView, plus: 16) // to UIView
item.bottom.equalToSuperview() // to superview
item.leading.equal(to: layoutMarginsGuide) // to UILayoutGuide
item.trailing.equal(to: anotherView.centerXAnchor) // to NSLayoutAnchor
item.width.equal(to: 100) // to constant
item.height.equal(to: item.width) // to LayoutAnchor
}
```

In the example, the followings are done automatically:

- Set `view.translatesAutoresizingMaskIntoConstraints` to `false`.

- Activates all constraints.

#### Relations

```swift
view.autoLayout { item in
item.top.greaterThanOrEqual(to: safeAreaLayoutGuide)
item.bottom.lessThanOrEqualToSuperview()
}
```

#### Priority

`UILayoutPriority` and `NSLayoutConstraint.Priority` are available.

```swift
view.autoLayout { item in
item.center.equalToSuperview().priority(.required)
item.size.equal(toSquare: 100).priority(.defaultHigh)
}
```

#### Deactivated Constraints

You can specify an argument `activates` to determine whether to immediately activate constraints.

```swift
let constraints = view.autoLayout(activates: false) { item in
item.edges.equal(to: anotherView)
}
// All constraints are not active.
assert(constraints.allSatisfy { !$0.isActive })

// You can activate them at any time.
NSLayoutConstraint.activate(constraints)
```

### Convenient Anchors

#### Point

```swift
view.autoLayout { item in
item.center.equal(to: anotherView)
item.topLeading.equalToSuperview()
}
```

#### Size

```swift
view.autoLayout { item in
item.size.equal(to: CGSize(width: 100, height: 200))
}
```

#### HorizontalEdges and VerticalEdges

```swift
view.autoLayout { item in
item.leadingTrailing.equal(to: anotherView)
item.topBottom.equalToSuperview(insetBy: 16)
}
```

#### Edges

```swift
view.autoLayout { item in
item.edges.equalToSuperview(insetBy: 16)
}
```

## Available Anchors

### XAxis

- `leading`
- `trailing`
- `left`
- `right`
- `centerX`

### YAxis

- `top`
- `bottom`
- `centerY`

#### Baseline (only `UIView` / `NSView`)

- `firstBaseline`
- `lastBaseline`

### Dimension

- `width`
- `height`

### Point

- `center`
- `topLeading`
- `topTrailing`
- `topLeft`
- `topRight`
- `bottomLeading`
- `bottomTrailing`
- `bottomLeft`
- `bottomRight`

### Size

- `size`

### HorizontalEdges

- `leadingTrailing`
- `leftRight`

### VerticalEdges

- `topBottom`

### Edges

- `edges`

## Using AceLayout in your project

To use the `AceLayout` library in a SwiftPM project, add the following line to the dependencies in your `Package.swift` file:

```swift
.package(url: "https://github.com/jrsaruo/AceLayout", from: "1.1.3"),
```

and add `AceLayout` as a dependency for your target:

```swift
.target(name: "", dependencies: [
.product(name: "AceLayout", package: "AceLayout"),
// other dependencies
]),
```

Finally, add `import AceLayout` in your source code.