[iOS] StatefulViewController:基于内容状态的占位符实用视图组件

StatefulViewController A protocol to enable UIViewControllers or UIViews to present placeholder views b


A protocol to enable UIViewControllers or UIViews to present placeholder views based on content, loading, error or empty states.

[iOS] StatefulViewController:基于内容状态的占位符实用视图组件


In a networked application a view controller or custom view typically has the following states that need to be communicated to the user:

  • Loading: The content is currently loaded over the network.
  • Content: The content is available and presented to the user.
  • Empty: There is currently no content available to display.
  • Error: An error occured whilst downloading content.

As trivial as this flow may sound, there are a lot of cases that result in a rather large decision tree.

[iOS] StatefulViewController:基于内容状态的占位符实用视图组件

StatefulViewControlleris a concrete implementation of this particular decision tree. (If you want to create your own modified version, you might be interested in thestate machinethat is used to show and hide views.)

Version Compatibility

Current Swift compatibility breakdown:

Swift Version Framework Version
3.0 3.x
2.3 2.x
2.2 1.x


This guide describes the use of the StatefulViewControllerprotocol on UIViewController. However, you can also adopt the StatefulViewControllerprotocol on any UIViewControllersubclass, such as UITableViewControlleror UICollectionViewController, as well as your custom UIViewsubclasses.

First, make sure your view controller adopts to the StatefulViewControllerprotocol.

class MyViewController: UIViewController, StatefulViewController { // ...}

Then, configure the loadingView, emptyViewand errorViewproperties (provided by the StatefulViewControllerprotocol) in viewDidLoad.

override func viewDidLoad() { super.viewDidLoad() // Setup placeholder views loadingView = // UIView emptyView = // UIView errorView = // UIView}

In addition, call the setupInitialViewState()method in viewWillAppear:in order to setup the initial state of the controller.

override func viewWillAppear(animated: Bool) { super.viewWillAppear(animated) setupInitialViewState()}

After that, simply tell the view controller whenever content is loading and StatefulViewControllerwill take care of showing and hiding the correct loading, error and empty view for you.

override func viewWillAppear(animated: Bool) { super.viewWillAppear(animated) loadDeliciousWines()}func loadDeliciousWines() { startLoading() let url = NSURL(string: "http://example.com/api") let session = NSURLSession.sharedSession() session.dataTaskWithURL(url) { (let data, let response, let error) in endLoading(error: error) }.resume()}

Life cycle

StatefulViewController calls the hasContentmethod to check if there is any content to display. If you do not override this method in your own class, StatefulViewControllerwill always assume that there is content to display.

func hasContent() -> Bool { return datasourceArray.count > 0}

Optionally, you might also be interested to respond to an error even if content is already shown. StatefulViewControllerwill not show its errorViewin this case, because there is already content that can be shown.

To e.g. show a custom alert or other unobtrusive error message, use handleErrorWhenContentAvailable:to manually present the error to the user.

func handleErrorWhenContentAvailable(error: ErrorType) { let alertController = UIAlertController(title: "Ooops", message: "Something went wrong.", preferredStyle: .Alert) alertController.addAction(UIAlertAction(title: "OK", style: .Default, handler: nil)) self.presentViewController(alertController, animated: true, completion: nil)}

Custom Placeholder View insets

Per default, StatefulViewController presents all configured placeholder views fullscreen (i.e. with 0 insets from top, bottom, left & right from the superview). In case a placeholder view should have custom insets the configured placeholderview may conform to the StatefulPlaceholderViewprotocol and override the placeholderViewInsetsmethod to return custom edge insets.

class MyPlaceholderView: UIView, StatefulPlaceholderView { func placeholderViewInsets() -> UIEdgeInsets { return UIEdgeInsets(top: 20, left: 20, bottom: 20, right: 20) }}

View State Machine

Note: The following section is only intended for those, who want to create a stateful controller that differs from the flow described above.

You can also use the underlying view state machine to create a similar implementation for your custom flow of showing/hiding views.

let stateMachine = ViewStateMachine(view: view)// Add statesstateMachine["loading"] = loadingViewstateMachine["other"] = otherView// Transition to statestateMachine.transitionToState(.View("loading"), animated: true) { println("finished switching to loading view")}// Hide all viewsstateMachine.transitionToState(.None, animated: true) { println("all views hidden now")}



Add the following line to yourCartfile.

github "aschuch/StatefulViewController" ~> 1.0

Then run carthage update.


Add the following line to your Podfile.

pod "StatefulViewController", "~> 1.0"

Then run pod installwith CocoaPods 0.36 or newer.


Just drag and drop the two .swiftfiles in the StatefulViewControllerfolder into your project.


Open the Xcode project and press ⌘-Uto run the tests.

Alternatively, all tests can be run from the terminal usingxctool.

xctool -scheme StatefulViewControllerTests -sdk iphonesimulator test


  • Default loading, error, empty views
  • Protocol on views that notifies them of removal and add
  • Views can provide delays in order to tell the state machine to show/remove them only after a specific delay (e.g. for hide and show animations)


  • Create something awesome, make the code better, add some functionality, whatever (this is the hardest part).
  • Fork it
  • Create new branch to make your changes
  • Commit all your changes to your branch
  • Submit apull request


Feel free to get in touch.