A library for isolated developing UI components and automatically snapshots of them.

Playbook

soon...

Android version is 🔜

Usage

• API Document
• Example App

Playbook

soon...

PlaybookSnapshot

soon...

PlaybookUI

PlaybookGallery

UI	Browser	Detail
Light
Dark

soon...

PlaybookCatalog

UI	Browser	Detail
Light
Dark

soon...

How to Save Snapshot Images

soon...

Integration with reg-viz/reg-suit

It's highly recommended to use reg-suit in order to sublimate the snapshot images generated by Playbook to the visual regression test.

soon...

Requirements

• Swift 5.1+
• Xcode 11.0+
• iOS
  • Playbook: 11.0+
  • PlaybookSnapshot: 11.0+
  • PlaybookUI: 13.0+

Installation

Playbook features are separated into the following frameworks.

• Playbook: Core system of component management.
• PlaybookSnapshot: Generates snapshots of all components.
• PlaybookUI: Products a browsing UI for components managed by Playbook.

CocoaPods

Add the following to your Podfile:

pod 'Playbook' # Playbook, PlaybookSnapshot and PlaybookUI

pod 'Playbook/System' # Playbook only

pod 'Playbook/Snapshot' # Playbook and PlaybookSnapshot

pod 'Playbook/UI' # Playbook and PlaybookUI

Carthage

Add the following to your Cartfile:

github "playbook-ui/playbook-ios"

Swift Package Manager

Select Xcode menu File > Swift Packages > Add Package Dependency... and enter repository URL with GUI.

Repository: https://github.com/playbook-ui/playbook-ios

Development

soon...

TODO

• Write README completely.
• Compare snapshot diffs without dependency.
• Visual regression testing on CI.
• Automatic deployment for CocoaPods on CI.

License

Playbook is released under the Apache 2.0 License.