Playbook Documentation Beta

Classes

Playbook

The central scenario manager.

Scenario​Store

The class for managing a set of scenarios identified by the arbitrary kind.

Scenario​View​Controller

The view controller to layout scenario's content.

Snapshot​Waiter

A snapshot timing manager to wait and fulfillment for the scenario content to be rendered.

Structures

Scenarios​Builder

The custom parameter attribute that constructs scenarios from multi-statement closures.

Scenario

Represents part of the component state.

Scenario​Context

The context of scenario.

Scenario​Kind

Represents a unique identifier of the set of scenarios.

Scenario​Layout

Represents how the component should be laid out.

Scenario​Name

Represents a unique name of the scenario.

Snapshot​Device

The device representation for simulating environments of each device such as size, orientation, safe area, trait collection, or dark mode appearance.

Snapshot

The testing tool which generates snapshot images from scenarios managed by Playbook.

Playbook​Catalog

A view that displays scenarios manged by given Playbook instance with catalog-style appearance.

Playbook​Gallery

A view that displays scenarios manged by given Playbook instance with gallery-style appearance.

Enumerations

Scenario​Layout.​Sizing

A sizing strategy for the horizontal or vertical dimensions.

Snapshot​Device.​Orientation

Represents the orientation of a device.

Snapshot​Support

A namespace for the methods supporting to generate snapshot from scenarios.

Snapshot​Support.​Image​Format

The image format of the exported file.

Protocols

Scenarios​Buildable

Represents an instance that can build an array of scenarios.

Scenario​Content

Represents a content of scenario.

Scenario​Provider

Products a group of separated scenario definitions.

Test​Tool

Represents a tool for testing scenarios managed by playbooks.