Skip to content

App to demonstrate state preservation and restoration APIs

License

Notifications You must be signed in to change notification settings

shagedorn/StateRestorationDemo

Repository files navigation

StateRestorationDemo

Swift app to demonstrate state preservation and restoration APIs.

Created for a presentation at CocoaHeads Dresden on 09 July 2014. The Deckset presentation (rendered as PDF and the Markdown source) is included in the repository. Feel free to open a GitHub Issue for questions regarding this project.

Last verified with Xcode 14.3 and iOS 16.2. The app is written in Swift 5.7.

⚠️ This app demonstrates view- and view-controller-based state restoration in UIKit. As of iOS 13, Apple encourages to adopt user-activity-based state restoration.

Please consult the official documentation for a comparison of the two approaches and official demo material.

Tags

Tags outline the various steps to enable state restoration in iOS apps:

  • NO_STATE_RESTORATION: The app without state restoration
  • STATE_RESTORATION_OPT_IN: The app generally enables state restoration, but does not implement it yet
  • RESTORATION_IDENTIFIERS: The app sets restoration identifiers on view controllers, but the controllers are not restored successfully yet
  • BASIC_STATE_RESTORATION: Initially created view controllers are restored successfully
  • RESTORATION_CLASS: Non-initial view controllers are restored, too
  • STATE_ENCODING: View controllers restore their views' state
  • SIZE_CLASSES: The window's size classes are preserved

Note: Both to improve the project and to support the current version of Swift, there have been major updates that are not reflected by the tagged commits. The tags are still helpful to follow the various steps, but you should use the latest commit on main for a working version.

Limitations

By default, state restoration happens synchronously at launch on the main queue. While you can move work off the main queue, it will still kick in right after app launch and should finish as quickly as possible, which means it cannot easily be adopted by apps that need to log in or fetch a new session on every launch.

Other Resources

Apple Sample Code: State Restoration of Child View Controllers