Update readme

efekanegeli · Jan 17, 2019 · 6e602b9 · 6e602b9
1 parent 824d92b
commit 6e602b9
Show file tree

Hide file tree

Showing 2 changed files with 75 additions and 33 deletions.
diff --git a/EEStackLayout/ViewController.swift b/EEStackLayout/ViewController.swift
@@ -45,11 +45,11 @@ class ViewController: UIViewController {
 
             // Vertical EEStackLayout setup
             stackLayout = EEStackLayout(frame: CGRect(x: 0, y: 50, width: 300, height: 0),
-                                            rowHeight: 20,
-                                            minimumInteritemSpacing: 15,
-                                            minimumItemSpacing: 10,
-                                            insets: UIEdgeInsets(top: 15, left: 15, bottom: 15, right: 15),
-                                            subviews: viewArray)
+                                        rowHeight: 20,
+                                        minimumInteritemSpacing: 15,
+                                        minimumItemSpacing: 10,
+                                        insets: UIEdgeInsets(top: 15, left: 15, bottom: 15, right: 15),
+                                        subviews: viewArray)
 
         } else {
             // Horizontal EEStackLayout
@@ -72,11 +72,11 @@ class ViewController: UIViewController {
 
             // Horizontal EEStackLayout setup
             stackLayout = EEStackLayout(frame: CGRect(x: 0, y: 50, width: 0, height: 400),
-                                            columnWidth: 20,
-                                            minimumInteritemSpacing: 15,
-                                            minimumItemSpacing: 10,
-                                            insets: UIEdgeInsets(top: 15, left: 15, bottom: 15, right: 15),
-                                            subviews: viewArray)
+                                        columnWidth: 20,
+                                        minimumInteritemSpacing: 15,
+                                        minimumItemSpacing: 10,
+                                        insets: UIEdgeInsets(top: 15, left: 15, bottom: 15, right: 15),
+                                        subviews: viewArray)
         }
 
         self.view.addSubview(stackLayout)

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ A vertical stackview which takes subviews with different widths and adds them to
 
 
 [![Twitter: @efekanegeli](https://img.shields.io/badge/contact-%40efekanegeli-blue.svg)](https://twitter.com/efekanegeli)
-[![CocoaPods](https://img.shields.io/badge/pod-v0.1.6-blue.svg)](https://github.com/efekanegeli/EEStackLayout)
+[![CocoaPods](https://img.shields.io/badge/pod-v0.1.7-blue.svg)](https://github.com/efekanegeli/EEStackLayout)
 
 ![Screenshot](https://github.com/efekanegeli/EEStackLayout/blob/master/example1.png)
 
@@ -26,37 +26,79 @@ pod install
 
 ## Example Usage
 
-```
+```swift
+// Subviews that will be added to stack layout
 var viewArray = [UIView]()
-for _ in 1...25 {
-  let view1 = UIView(frame: CGRect(x: 0, y: 0, width: 20, height: 42))
-  view1.backgroundColor = .green
-  let view2 = UIView(frame: CGRect(x: 0, y: 0, width: 30, height: 42))
-  view2.backgroundColor = .blue
-  let view3 = UIView(frame: CGRect(x: 0, y: 0, width: 40, height: 42))
-  view3.backgroundColor = .yellow
-  let view4 = UIView(frame: CGRect(x: 0, y: 0, width: 50, height: 42))
-  view4.backgroundColor = .black
-  viewArray.append(view1)
-  viewArray.append(view2)
-  viewArray.append(view3)
-  viewArray.append(view4)
+
+// Choose the orientation of EEStackLayout -> vertical / horizontal [Just for demo purposes, change it if you want to see how horizontal EEStackLayout works]
+let targetOrientationOfStackLayout = NSLayoutConstraint.Axis.vertical
+
+let stackLayout: EEStackLayout
+
+if targetOrientationOfStackLayout == .vertical {
+    // Vertical EEStackLayout
+
+    // Views with same height for the vertical layout
+    for _ in 1...25 {
+        let view1 = UIView(frame: CGRect(x: 0, y: 0, width: 20, height: 42))
+        view1.backgroundColor = .green
+        let view2 = UIView(frame: CGRect(x: 0, y: 0, width: 30, height: 42))
+        view2.backgroundColor = .blue
+        let view3 = UIView(frame: CGRect(x: 0, y: 0, width: 40, height: 42))
+        view3.backgroundColor = .yellow
+        let view4 = UIView(frame: CGRect(x: 0, y: 0, width: 50, height: 42))
+        view4.backgroundColor = .black
+        viewArray.append(view1)
+        viewArray.append(view2)
+        viewArray.append(view3)
+        viewArray.append(view4)
+    }
+
+    // Vertical EEStackLayout setup
+    stackLayout = EEStackLayout(frame: CGRect(x: 0, y: 50, width: 300, height: 0),
+                                rowHeight: 20,
+                                minimumInteritemSpacing: 15,
+                                minimumItemSpacing: 10,
+                                insets: UIEdgeInsets(top: 15, left: 15, bottom: 15, right: 15),
+                                subviews: viewArray)
+
+} else {
+    // Horizontal EEStackLayout
+
+    // Views with same width for the horizontal layout
+    for _ in 1...25 {
+        let view1 = UIView(frame: CGRect(x: 0, y: 0, width: 30, height: 15))
+        view1.backgroundColor = .green
+        let view2 = UIView(frame: CGRect(x: 0, y: 0, width: 30, height: 25))
+        view2.backgroundColor = .blue
+        let view3 = UIView(frame: CGRect(x: 0, y: 0, width: 30, height: 35))
+        view3.backgroundColor = .yellow
+        let view4 = UIView(frame: CGRect(x: 0, y: 0, width: 30, height: 45))
+        view4.backgroundColor = .black
+        viewArray.append(view1)
+        viewArray.append(view2)
+        viewArray.append(view3)
+        viewArray.append(view4)
+    }
+
+    // Horizontal EEStackLayout setup
+    stackLayout = EEStackLayout(frame: CGRect(x: 0, y: 50, width: 0, height: 400),
+                                columnWidth: 20,
+                                minimumInteritemSpacing: 15,
+                                minimumItemSpacing: 10,
+                                insets: UIEdgeInsets(top: 15, left: 15, bottom: 15, right: 15),
+                                subviews: viewArray)
 }
 
-let stackLayout = EEStackLayout(frame: CGRect(x: 0, y: 50, width: 200, height: 0),
-                                        rowHeight: 20,
-                                        minimumInteritemSpacing: 15,
-                                        minimumLineSpacing: 10,
-                                        insets: UIEdgeInsets(top: 15, left: 15, bottom: 15, right: 15),
-                                        subviews: viewArray)
 self.view.addSubview(stackLayout)
 ```
 
 ## Init Properties
 ```
-minimumLineSpacing -> Spacing between rows
+minimumItemSpacing -> Spacing between rows(vertical layout) or colums(horizontal layout)
 rowHeight -> Row height of the main vertical stack view
-minimumInteritemSpacing -> Spacing between items in a row
+columnWidth -> Column width of the main horizontal stack view
+minimumInteritemSpacing -> Spacing between items in a row/column
 insets -> Layout margins of main vertical stack view
 subviews -> View array of elements to be added to the main stack view
 ```