BoxView 1.7.4

BoxView 1.7.4

Maintained by Vladimir Dudkin.



BoxView 1.7.4

  • By
  • Vladimir Dudkin

Let me create autolayout constraints for you!

BoxView

The BoxView is a container view that can layout subviews. It is similar to UIStackView, but use a different approach: it allows to set specific layout for each subview, rather than automatically distribute. BoxView allows to create complex dynamic layouts with minimum efforts. It get rid of boilerplate code, makes it much shorter and readable instead. It doesn't change views or existing constraints, it only creates specified group of constraints, so it doesn't conflict with anything.

Features

  • Pure swift 5 library
  • Short and readable code even for complex layout
  • Easy layout changes, adding, removing and reordering views
  • 100% compatibility with any other autolayout code
  • Supports absolute, relative and flex dimensional constraints
  • Supports animation

Examples

login6 image

We need only few lines of code to create this layout with BoxView:

nameBoxView.items = [nameImageView.boxed.centerY(), nameField.boxed]
passwordBoxView.items = [passwordImageView.boxed.centerY(), passwordField.boxed]
boxView.insets = .all(16.0)
boxView.spacing = 20.0
boxView.items = [
    titleLabel.boxed.centerX(padding: 30.0).bottom(20.0),
    nameBoxView.boxed,
    passwordBoxView.boxed,
    forgotButton.boxed.left(>=0.0),
    loginButton.boxed.top(30.0).left(50.0).right(50.0),
]

Full examples code is available in BoxViewExample project, and also there is a step-by-step tutorial for login example in Docs folder.

It is very easy to add/remove views, or to change any view padding without affecting other views in layout. And these changes optionally can be animated. For example, we can add empty fields validation and show error label below empty field, leaving existing layout code unchanged!

login1 image

Another layout example created with BoxViews only. It shows axis and spacing animation, and using size constraints with BoxView

album image

Basic usage

The BoxView uses items array to arrange its subviews. Each item is of type BoxItem, and it encapsulates the view together with the layout information. So to arrange some views using BoxView we have to create BoxItem from each view and add these items to BoxView.

Creating boxItems

BoxItem can be created from UIView using boxed property, item is created with zero padding from all four sides. There are many methods in BoxItem to change paddings or other parameters, and these methods all can be chained:

// creates a BoxItem with zero paddings from all 4 sides
view.boxed

// creates an item with 20 pt padding from left and zero paddings from other 3 sides.
view.boxed.left(20.0)

// creates an item with 10 pt padding from top, 20 pt from bottom and zero paddings from other 2 sides.
view.boxed.top(10.0).bottom(20.0) 

// creates an item aligned along X-axis, with padding >= 30 pt from left and right sides, top and bottom padding are zero, view height is equal 50 pt, width is half of superview width.
view.boxed.centerX(padding: 30.0).height(50.0).relativeWidth(0.5)

Note, that actual view offsets for all paddings are calculated counting boxView.insets and boxView.spacing properties as it is shown on scheme:

BoxView layout scheme image

It may look complicated, but all these values are zero by default, so only explicitly set values are contributing in actual paddings.

Each padding can be specified with relation using operator ">=" for greaterThanOrEqual relation and operator "<=" for lessThanOrEqual relation. Equal relation is default, so operator "==" is usually not used.

// creates an item with padding greater than or equal 20 pt from left,
// padding less than or equal  30 pt from top and zero paddings from other 2 sides. 
view.boxed.left(>=20.0).top(<=30.0)

Managing BoxView items

Items can be added, inserted or removed at any moment:

// initialize boxView.items with two items 
boxView.items = [view1.boxed, view2.boxed.left(10.0)]

//remove view2 (when subview is removed from boxView corresponding item is also removed)
view2.removeFromSuperview()

//add view3 
boxView.items.append(view3.boxed.centerX())

//insert view2 between view1 and view3 
boxView.insertItem(view2.boxed.right(10.0), after: view1)

It also possible to update an item, changing only specfied layout elements:

// initialize boxView.items with two items 
boxView.items = [view1.boxed, view2.boxed.left(10.0).right(10.0)]
...
// updating code has to be placed in closure which receives item as argument,
// and returns updated item
view2.updateBoxItem{ $0.left(20.0).width(100.0) }
// now view2 still has right padding 10.0, but left padding changed to 20.0 and width constrained to 100.0

Advanced usage and references

More details about BoxView usage in Docs folder.

Requirements

iOS 9 or later

Installation

CocoaPods

BoxView is available through CocoaPods. To install it, simply add the following line to your Podfile:

use_frameworks!

target 'YourTarget' do
  pod 'BoxView', :git => 'https://github.com/vladimir-d/BoxView.git'
end

Author

Vladimir Dudkin, [email protected]

License

BoxView is available under the MIT license. See the LICENSE file for more info.