Playbook
A library for isolated development and snapshot testing of UI components in SwiftUI and UIKit.
What is Playbook?
Playbook is a library for iOS development that provides a sandbox for building UI components in isolation, without application-specific dependencies. It allows developers to create a living styleguide and automatically generate snapshots of components for visual regression testing, helping catch UI changes early and improve design robustness.
iOS developers and teams building applications with SwiftUI or UIKit who want to streamline UI component development, review, and testing.
Developers choose Playbook for its Storybook-like workflow tailored for iOS, enabling isolated component development, automated snapshot generation, and integration with visual regression tools to maintain UI consistency and speed up development cycles.
Overview
📘A library for isolated developing UI components and automatically taking snapshots of them.
Use Cases
Best For
- Building and reviewing UI components in isolation from business logic
- Automating visual regression testing for iOS apps
- Creating a living styleguide for SwiftUI or UIKit components
- Integrating snapshot testing into CI/CD pipelines for iOS projects
- Improving UI development workflow with Storybook-like tools for iOS
- Testing accessibility of UI components with visual snapshots
Not Ideal For
- Teams supporting iOS versions below 13.0, as Playbook's core requires iOS 13.0+ and PlaybookUI needs iOS 15.0+
- Cross-platform projects needing a unified UI testing tool across iOS and Android, since Playbook is iOS-specific
- Projects with minimal UI components or simple apps where the overhead of setting up Playbook and snapshot testing isn't justified
- Developers who prefer fully integrated Xcode testing without additional third-party dependencies, due to Playbook's separate snapshot generation
Pros & Cons
Pros
Supports both SwiftUI and UIKit, allowing teams to manage components across modern and legacy codebases seamlessly, as shown in the README with examples for both.
Enables automatic snapshot generation via unit tests with PlaybookSnapshot, facilitating visual regression testing and early detection of UI changes without manual effort.
Generates a standalone app (PlaybookUI) for browsing components as a living styleguide, making it easy to review and document UI designs without running the main application.
Integrates seamlessly with tools like Percy and reg-suit for advanced visual diffing, enhancing the visual testing pipeline with detailed regression reports.
Cons
Core requires iOS 13.0+, and PlaybookUI requires iOS 15.0+, which restricts use in projects targeting older iOS versions or needing broader compatibility.
Swift Package Manager doesn't support specifying OS versions per library, so installation is limited to iOS 13+ only, potentially complicating version-specific setups.
Split into multiple frameworks (Playbook, PlaybookSnapshot, PlaybookUI), adding complexity to initial setup, dependency management, and learning curve.
Open Source Alternative To
Playbook is an open-source alternative to the following products:
Frequently Asked Questions
Related Projects
DoraemonKit一款面向泛前端产品研发全生命周期的效率平台。
SwifterSwiftA handy collection of more than 500 native Swift extensions to boost your productivity.
FlexAn in-app debugging and exploration tool for iOS
R.swiftStrong typed, autocompleted resources like images, fonts and segues in Swift projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.