Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/fhisa/SwiftyLayout

Lightweight declarative auto-layout framework for Swift
https://github.com/fhisa/SwiftyLayout

Last synced: 8 days ago
JSON representation

Lightweight declarative auto-layout framework for Swift

Host: GitHub
URL: https://github.com/fhisa/SwiftyLayout
Owner: fhisa
License: mit
Created: 2015-08-14T04:30:30.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2017-02-19T23:23:00.000Z (almost 8 years ago)
Last Synced: 2024-08-14T14:06:29.236Z (4 months ago)
Language: Swift
Homepage:
Size: 127 KB
Stars: 15
Watchers: 4
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README-ja.md
- Changelog: CHANGES.md
- License: LICENSE

Awesome Lists containing this project

awesome-ios - SwiftyLayout - Lightweight declarative auto-layout framework for Swift. (Layout / Other Hardware)
awesome-ios-star - SwiftyLayout - Lightweight declarative auto-layout framework for Swift. (Layout / Other Hardware)
awesome-swift-cn - SwiftyLayout - Lightweight mathematical declarative auto-layout framework for Swift. (Libs / Layout)

README

        # SwiftyLayout

[![GitHub license](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/fhisa/SwiftyLayout/master/LICENSE)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

[![GitHub release](https://img.shields.io/github/release/fhisa/SwiftyLayout.svg)](https://github.com/fhisa/SwiftyLayout/releases)

[![build passing](https://travis-ci.org/fhisa/SwiftyLayout.png?branch=master)](https://travis-ci.org/fhisa/SwiftyLayout)

[![Join the chat at https://gitter.im/fhisa/SwiftyLayout](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/fhisa/SwiftyLayout?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

SwiftyLayout は、Swiftプログラムにおいて、レイアウト制約(NSLayoutConstraint)を簡単な数式として定義できるようにするフレームワークです。

## バージョンについて

- SwiftyLayout 3 は Swift 2 用です。

- SwiftyLayout 4 は Swift 3 用です。

## コード例

### 基本的な使い方

「ビューAの横幅はビューBの横幅の50%から4.0引いたものと等しい」というレイアウト制約は、SwiftyLayoutフレームワークを使って:

```swift

viewA[.Width] == 0.5 * viewB[.Width] - 4.0

```

のように記述できます。これは以下のコードと同じレイアウト制約を生成します:

```swift

NSLayoutConstraint(

    item: viewA, attribute: .Width,

    relatedBy: .Equal,

    toItem: viewB, attribute: .Width,

    multiplier: 0.5, constant: -4.0)

```

### 例)アスペクト比

また「ビューAのサイズの縦横比は 3:4 に等しい」という制約は:

```swift

viewA[.Width] * 3.0 == viewA[.Height] * 4.0

```

のように記述できます。これは以下のコードと同じレイアウト制約を生成します:

```swift

NSLayoutConstraint(

    item: viewA, attribute: .Width,

    relatedBy: .Equal,

    toItem: viewA, attribute: .Height,

    multiplier: 4.0/3.0, constant: 0.0)

```

### 例)優先順位の指定

二項演算子`~`を使ってレイアウト制約の優先順位を指定することができます:

```swift

innerView[.Leading] == outerView[.Leading] + 4.0 ~ 750.0

```

この演算子は、レイアウト制約の優先順位を設定した上でそのレイアウト制約を返します:

```swift

var constraint = NSLayoutConstraint(

    item: innerView, attribute: .Leading,

    relatedBy: .Equal,

    toItem: outerView, attribute: .Leading,

    multiplier: 1.0, constant: 4.0)

constraint.priority = 750.0

// -> constraint

```

[サンプルアプリ](https://github.com/fhisa/SwiftyLayout/blob/master/SampleApp/ViewController.swift)や[テストケース](https://github.com/fhisa/SwiftyLayout/blob/master/SwiftyLayoutTests/SwiftyLayoutTests.swift)のコードも参考にしてください。

## リファレンスガイド

### 制約項 (ConstraintTerm)

制約項(ConstraintTerm)とは、レイアウト制約の右辺または左辺で、ビューを含む項のことです。

あるビュー`viewA`の横幅`.Width`を表す制約項は:

```swift

viewA[.Width]

```

と記述します。`viewA`のところにはUIViewオブジェクトが、`.Width`のところには`NSLayoutAttribute`型の値が入ります。

制約項は、以下のような構造体として定義されています:

```swift

public struct ConstraintTerm

{

    let view: UIView?

    let attribute: NSLayoutAttribute

    var multiplier: CGFloat = 1.0

    var constant: CGFloat = 0.0

}

```

### 演算子

*以下の表で「制約項」は`ConstraintTerm`型の値、「定数」は`CGFloat`型の値、「レイアウト制約」は`NSLayoutConstraint`オブジェクトを表します。*

| 演算子 | 左辺 | 右辺 | 評価値 | 意味 |

|:-----:|:------|:------|:-------|:--|

| +     | 制約項 | 定数   | 制約項 | 左辺の`constant`に右辺の値を加算 |

| +     | 定数   | 制約項 | 制約項 | 右辺の`constant`に左辺の値を加算 |

| -     | 制約項 | 定数   | 制約項 | 左辺の`constant`から右辺の値を減算 |

| *     | 制約項 | 定数   | 制約項 | 左辺の`multiplier`と`constant`に右辺の値を乗算 |

| *     | 定数   | 制約項 | 制約項 | 右辺の`multiplier`と`constant`に左辺の値を乗算 |

| /     | 制約項 | 定数   | 制約項 | 左辺の`multiplier`と`constant`を右辺の値で除算 |

| ==    | 制約項 | 制約項 | レイアウト制約 | 「左辺と右辺の値が等しい」というレイアウト制約を生成 |

| ==    | 制約項 | 定数   | レイアウト制約 | 同上 |

| ==    | 定数   | 制約項 | レイアウト制約 | 同上 |

| <=    | 制約項 | 制約項 | レイアウト制約 | 「左辺の値は右辺の値より小さいか等しい」というレイアウト制約を生成 |

| <=    | 制約項 | 定数   | レイアウト制約 | 同上 |

| <=    | 定数   | 制約項 | レイアウト制約 | 同上 |

| >=    | 制約項 | 制約項 | レイアウト制約 | 「左辺の値は右辺の値より大きいか等しい」というレイアウト制約を生成 |

| >=    | 制約項 | 定数   | レイアウト制約 | 同上 |

| >=    | 定数   | 制約項 | レイアウト制約 | 同上 |

| ~     | レイアウト制約 | 定数(Float型) | レイアウト制約 | レイアウト制約の優先度を変更して、そのレイアウト制約を返す |

## Requirements

- Swift 2.0 (Xcode 7 以降)

- iOS 8 以降 / iOS 7 (ソースコードを直接コピー)

- iOS

  - iOS 8 以降 / iOS 7 (ソースコードを直接コピー)

- Mac

  - Mac OS X 10.10 以降 / 10.9 以前での動作は不明

## インストール

2種類の方法があります。

### Carthage を使ってインストール

SwiftyLayout は [Carthage](https://github.com/Carthage/Carthage) を使うと簡単にプロジェクトに追加できます。

- Cartfile に `github "fhisa/SwiftyLayout"` の1行を追加

- `carthage update` を実行

- Carthage/Build の中にできたフレームワークをプロジェクトに追加

### ソースファイルを直接コピー (iOS 7)

- Add this repository as a git submodule:

```shell

$ git submodule add https://github.com/fhisa/SwiftyLayout.git PATH_TO_SUBMODULE

// or

$ carthage update --use-submodules

```

- Then just add references of SwiftyLayout/*.swift to your Xcode project.

## TODO

- [CocoaPods](https://cocoapods.org) 対応

## ライセンス

SwiftyLayout は [MIT license](https://github.com/fhisa/SwiftyLayout/blob/master/LICENSE) の元で配布しています。