https://github.com/cypherpoet/swiftuipreviewutils

Starter utilities for using Xcode previews in SwiftUI projects
https://github.com/cypherpoet/swiftuipreviewutils

swift swift-packages swiftui swiftui-masterrace swiftui-previews swiftui-previews-are-awesome swiftui-xcode-previews xcode xcode-previews

Last synced: 1 day ago
JSON representation

Starter utilities for using Xcode previews in SwiftUI projects

• Host: GitHub
• URL: https://github.com/cypherpoet/swiftuipreviewutils
• Owner: CypherPoet
• License: mit
• Created: 2021-03-09T07:25:47.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-09-14T10:44:26.000Z (about 3 years ago)
• Last Synced: 2024-10-30T17:16:14.833Z (19 days ago)
• Topics: swift, swift-packages, swiftui, swiftui-masterrace, swiftui-previews, swiftui-previews-are-awesome, swiftui-xcode-previews, xcode, xcode-previews
• Language: Swift
• Homepage:
• Size: 2.11 MB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# SwiftUIPreviewUtils



    

    

    

    

    

    

    

    

      

    

    

        

    





_Starter utilities for using Xcode previews in SwiftUI projects._



## 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:

```swift

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.

```swift

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](./.github/ISSUE_TEMPLATE/) for more info.

## 💻 Developing

### Requirements

- Xcode 12.5+ (Recommended)

### 📜 Generating Documentation

Documentation is generated by [Jazzy](https://github.com/realm/jazzy). Installation instructions can be found [here](https://github.com/realm/jazzy#installation), 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](./.github/workflows/PublishDocumentation.yml) 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](./LICENSE) for more info.