Awesome

SwiftUIPreviewUtils

<p> <img src="https://img.shields.io/badge/iOS-14.0+-865EFC.svg" /> <img src="https://img.shields.io/badge/iPadOS-14.0+-F65EFC.svg" /> <img src="https://img.shields.io/badge/macOS-11.0+-179AC8.svg" /> <img src="https://img.shields.io/badge/tvOS-14.0+-41465B.svg" /> <img src="https://img.shields.io/badge/watchOS-7.0+-1FD67A.svg" /> <img src="https://img.shields.io/badge/License-MIT-blue.svg" /> <img src="https://github.com/CypherPoet/SwiftUIPreviewUtils/workflows/Build%20&%20Test/badge.svg" /> <a href="https://github.com/apple/swift-package-manager"> <img src="https://img.shields.io/badge/spm-compatible-brightgreen.svg?style=flat" /> </a> <a href="https://twitter.com/cypher_poet"> <img src="https://img.shields.io/badge/Contact-@cypher_poet-lightgrey.svg?style=flat" alt="Twitter: @cypher_poet" /> </a> </p> <p align="center">

Starter utilities for using Xcode previews in SwiftUI projects.

<p />

Installation

Xcode Projects

Select File -> Swift Packages -> Add Package Dependency and enter https://github.com/CypherPoet/SwiftUIPreviewUtils.

Swift Package Manager Projects

You can add SwiftUIPreviewUtils as a package dependency in your Package.swift file:

let package = Package(
    //...
    dependencies: [
        .package(url: "https://github.com/CypherPoet/SwiftUIPreviewUtils", .exact("0.0.10")),
    ],
    //...
)

From there, refer to SwiftUIPreviewUtils as a "target dependency" in any of your package's targets that need it.

targets: [
    .target(
        name: "YourLibrary",
        dependencies: [
          "SwiftUIPreviewUtils",
        ],
        ...
    ),
    ...
]

Then simply import SwiftUIPreviewUtils wherever you’d like to use it.

Contributing

Contributions to SwiftUIPreviewUtils are most welcome. Check out some of the issue templates for more info.

💻 Developing

Requirements

Xcode 12.5+ (Recommended)

📜 Generating Documentation

Documentation is generated by Jazzy. Installation instructions can be found here, and as soon as you have it set up, docs can be generated simply by running jazzy from the command line.

📝 Note that this will only generate the docs folder for you to view locally. This folder is being ignored by git, as an action exists to automatically generate docs at the root level and serve them on the project's gh-pages branch.

🏷 License

SwiftUIPreviewUtils is available under the MIT license. See the LICENSE file for more info.