Skip to content

UIStackView replica for iOS 7.x and iOS 8.x and support Interface Builder

License

Notifications You must be signed in to change notification settings

CosynPa/TZStackView

 
 

Repository files navigation

TZStackView Carthage compatible

A wonderful layout component called the UIStackView was introduced with iOS 9. With this component it is really easy to layout components in a row both horizontally and vertically. Apple recommends using the UIStackView wherever possible and resort to explicit NSLayoutConstraints only when there is no way to do it with UIStackView. This saves you lots of boiler plate NSLayoutConstraint creation code.

UIStackView requires iOS 9, but we're not ready to make our apps require iOS 9+ just yet. In the meanwhile, we developers are eager to try this component in our apps right now! This is why I created this replica of the UIStackView, called the TZStackView (TZ = Tom van Zummeren, my initials). I created this component very carefully, tested every single corner case and matched the results against the real UIStackView with automated XCTestCases.

Features

  • ✅ Compatible with iOS 7.x and iOS 8.x
  • ✅ Supports the complete API of UIStackView including all distribution and alignment options
  • ✅ Supports animating the hidden property of the arranged subviews
  • ✅ Supports Interface Builder

Setup

You basically have two options to include the TZStackView in your Xcode project:

Example Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, "8.0"
use_frameworks!

pod "TZStackView", "1.2.0"

Unfortunately, using CocoaPods with a Swift pod requires iOS 8.

Example Cartfile:

github "tomvanzummeren/TZStackView" ~> 1.2.0

Run carthage to build the framework and drag the built TZStackView.framework into your Xcode project.

Drag files directly into your project

Alternatively (when you do want to support iOS 7) drag in the following classes from the Example folder directly into your Xcode project

  • TZStackView
  • TZSpacerView
  • TZStackViewAlignment
  • TZStackViewDistribution

Example usage

Add Stack View in Interface Builder

  1. Drag multiple views onto the canvas, and select all of then.

TZStackView select all views

  1. Choose Editor > Embed In > View. Then your views are embedded in a container view.

TZStackView embed views

  1. Change the class of the container view to TZStackView, note the module field should be updated automatically.

TZStackView embed views

  1. Update the attributes of the stack view. The meaning of Alignment Value and Distribution Value are defined in TZStackViewAlignment.swift and TZStackViewDistribution.swift files.

TZStackView embed views

  1. Add enough constraints to the stack view, for example a top spacing constraint and a leading spacing constraint.

TZStackView embed views

  1. Use the Resolve Auto Layout Issues tool to update the frames of all views

TZStackView embed views

  1. Then the stack view and its subviews should move to their correct positions automatically!

TZStackView embed views

Add Stack View Programmatically

Given view1, view2 and view3 who have intrinsic content sizes set to 100x100, 80x80 and 60x60 respectively.

let stackView = TZStackView(arrangedSubviews: [view1, view2, view3])
stackView.distribution = .FillEqually
stackView.alignment = .Center
stackView.axis = .Vertical
stackView.spacing = 25

This would produce the following layout:

TZStackView Layout example

See the developer documentation for UIStackView for all other combinatins of distributions, alignments and axis. TZStackView works and behaves exactly the same way as the UIStackView except for not supporting Storyboard. If you do find a case where it does not behave the same way, please file a bug report.

To animate adding a view to or removing a view from the arranged subviews, simply hide or show them by adjusting the hidden property within an animation block (as described by the UIStackView reference docs as well):

UIView.animateWithDuration(0.5, animations: {
	self.view2.hidden = true
})

TZStackView hidden animation example

Migrating to UIStackView

If at a later point you decide to make iOS 9 the minimum requirement of your app (it will happen sooner or later), you will want to migrate to the real UIStackView instead of using this implementation. If you added stack views by code, because the TZStackView is a drop-in replacement for UIStackView, you simply replace:

let stackView = TZStackView(arrangedSubviews: views)

with ...

let stackView = UIStackView(arrangedSubviews: views)

... and you're good to go! You will not need to make any other changes and everything will simply work the way it worked before. If you added stack views in Interface Builder, you have to migrate manually.

License

TZStackView is released under the MIT license. See LICENSE for details.

About

UIStackView replica for iOS 7.x and iOS 8.x and support Interface Builder

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Swift 98.9%
  • Other 1.1%