mirrors
/
SnapKit
mirror of https://github.com/SnapKit/SnapKit
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Temporarily remove Swift syntax highlighting

This commit is contained in:
Robert Payne 2015-06-12 00:05:55 +12:00
parent 053eaca59b
commit 03234bf6d9
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs.md
View File

@ -76,7 +76,7 @@ $ git submodule add https://github.com/SnapKit/SnapKit.git
SnapKit is designed to be extremely easy to use. Let's say we want to layout a box that is constrained to it's superview's edges with 20pts of padding. SnapKit is designed to be extremely easy to use. Let's say we want to layout a box that is constrained to it's superview's edges with 20pts of padding.
```swift ```
let box = UIView() let box = UIView()
superview.addSubview(box) superview.addSubview(box)
@ -90,7 +90,7 @@ box.snp_makeConstraints { (make) -> Void in
Or even shorter: Or even shorter:
```swift ```
let box = UIView() let box = UIView()
superview.addSubview(box) superview.addSubview(box)
@ -117,7 +117,7 @@ These three equality constraints accept one argument which can be any of the fol
#### 1. ViewAttribute #### 1. ViewAttribute
```swift ```
make.centerX.lessThanOrEqualTo(view2.snp_left) make.centerX.lessThanOrEqualTo(view2.snp_left)
``` ```
@ -140,7 +140,7 @@ view.snp_baseline | NSLayoutAttribute.Baseline
if you want view.left to be greater than or equal to label.left: if you want view.left to be greater than or equal to label.left:
```swift ```
// these two constraints are exactly the same // these two constraints are exactly the same
make.left.greaterThanOrEqualTo(label) make.left.greaterThanOrEqualTo(label)
make.left.greaterThanOrEqualTo(label.snp_left) make.left.greaterThanOrEqualTo(label.snp_left)
@ -151,7 +151,7 @@ make.left.greaterThanOrEqualTo(label.snp_left)
Auto Layout allows width and height to be set to constant values. Auto Layout allows width and height to be set to constant values.
if you want to set view to have a minimum and maximum width you could pass a primitive to the equality blocks: if you want to set view to have a minimum and maximum width you could pass a primitive to the equality blocks:
```swift ```
// width >= 200 && width <= 400 // width >= 200 && width <= 400
make.width.greaterThanOrEqualTo(200) make.width.greaterThanOrEqualTo(200)
make.width.lessThanOrEqualTo(400) make.width.lessThanOrEqualTo(400)
@ -160,14 +160,14 @@ make.width.lessThanOrEqualTo(400)
However Auto Layout does not allow alignment attributes such as left, right, centerY etc to be set to constant values. However Auto Layout does not allow alignment attributes such as left, right, centerY etc to be set to constant values.
So if you pass a primitive for these attributes SnapKit will turn these into constraints relative to the view's superview ie: So if you pass a primitive for these attributes SnapKit will turn these into constraints relative to the view's superview ie:
```swift ```
// creates view.left <= view.superview.left + 10 // creates view.left <= view.superview.left + 10
make.left.lessThanOrEqualTo(10) make.left.lessThanOrEqualTo(10)
``` ```
You can also use other primitives and structs to build your constraints, like so: You can also use other primitives and structs to build your constraints, like so:
```swift ```
make.top.equalTo(42) make.top.equalTo(42)
make.height.equalTo(20) make.height.equalTo(20)
make.size.equalTo(CGSizeMake(50, 100)) make.size.equalTo(CGSizeMake(50, 100))
@ -187,7 +187,7 @@ make.left.equalTo(view).offset(UIEdgeInsetsMake(10, 0, 10, 0))
Priorities are can be tacked on to the end of a constraint chain like so: Priorities are can be tacked on to the end of a constraint chain like so:
```swift ```
make.left.greaterThanOrEqualTo(label.snp_left).priorityLow() make.left.greaterThanOrEqualTo(label.snp_left).priorityLow()
make.top.equalTo(label.snp_top).priority(600) make.top.equalTo(label.snp_top).priority(600)
``` ```
@ -198,7 +198,7 @@ SnapKit also gives you a few convenience methods to create multiple constraints
#### edges #### edges
```swift ```
// make top, left, bottom, right equal view2 // make top, left, bottom, right equal view2
make.edges.equalTo(view2); make.edges.equalTo(view2);
@ -209,7 +209,7 @@ make.edges.equalTo(superview).insets(UIEdgeInsetsMake(5, 10, 15, 20))
#### size #### size
```swift ```
// make width and height greater than or equal to titleLabel // make width and height greater than or equal to titleLabel
make.size.greaterThanOrEqualTo(titleLabel) make.size.greaterThanOrEqualTo(titleLabel)
@ -219,7 +219,7 @@ make.size.equalTo(superview).offset(CGSizeMake(100, -50))
#### center #### center
```swift ```
// make centerX and centerY = button1 // make centerX and centerY = button1
make.center.equalTo(button1) make.center.equalTo(button1)
@ -229,7 +229,7 @@ make.center.equalTo(superview).offset(CGPointMake(-5, 10))
You can chain view attributes for increased readability: You can chain view attributes for increased readability:
```swift ```
// All edges but the top should equal those of the superview // All edges but the top should equal those of the superview
make.left.right.bottom.equalTo(superview) make.left.right.bottom.equalTo(superview)
make.top.equalTo(otherView) make.top.equalTo(otherView)
@ -244,7 +244,7 @@ In SnapKit there are a few different approaches to updating constraints.
You can hold on to a reference of a particular constraint by assigning the result of a constraint make expression to a local variable or a class property. You can hold on to a reference of a particular constraint by assigning the result of a constraint make expression to a local variable or a class property.
You could also reference multiple constraints by storing them away in an array. You could also reference multiple constraints by storing them away in an array.
```swift ```
var topConstraint: Constraint? = nil var topConstraint: Constraint? = nil
... ...
@ -267,7 +267,7 @@ self.topConstraint.updateOffset(5)
Alternative if you are only updating the **constant** value of the constraint you can use the method `snp_updateConstraints` instead of `snp_makeConstraints` Alternative if you are only updating the **constant** value of the constraint you can use the method `snp_updateConstraints` instead of `snp_makeConstraints`
```swift ```
// this is Apple's recommended place for adding/updating constraints // this is Apple's recommended place for adding/updating constraints
// this method can get called multiple times in response to setNeedsUpdateConstraints // this method can get called multiple times in response to setNeedsUpdateConstraints
// which can be called by UIKit internally or in your code if you need to trigger an update to your constraints // which can be called by UIKit internally or in your code if you need to trigger an update to your constraints
@ -289,7 +289,7 @@ override func updateConstraints() {
`snp_remakeConstraints` is similar to `snp_makeConstraints`, but will first remove all existing constraints installed by SnapKit. `snp_remakeConstraints` is similar to `snp_makeConstraints`, but will first remove all existing constraints installed by SnapKit.
```swift ```
func changeButtonPosition() { func changeButtonPosition() {
self.button.snp_remakeConstraints { (make) -> Void in self.button.snp_remakeConstraints { (make) -> Void in
make.size.equalTo(self.buttonSize) make.size.equalTo(self.buttonSize)