Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nicoelayda/uikitlivepreview
Xcode live previews for UIKit.
https://github.com/nicoelayda/uikitlivepreview
ios live-preview preview swift swiftui uikit xcode
Last synced: 26 days ago
JSON representation
Xcode live previews for UIKit.
- Host: GitHub
- URL: https://github.com/nicoelayda/uikitlivepreview
- Owner: nicoelayda
- License: mit
- Created: 2021-04-28T15:15:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-02-23T19:44:24.000Z (over 2 years ago)
- Last Synced: 2024-09-19T21:02:15.730Z (about 2 months ago)
- Topics: ios, live-preview, preview, swift, swiftui, uikit, xcode
- Language: Swift
- Homepage:
- Size: 51.8 KB
- Stars: 16
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# UIKitLivePreview
Enables SwiftUI live previews for UIKit views and view controllers.
## Requirements
- macOS Catalina or later
- Xcode 12 or later
- iOS Deployment Target 12.0 or later
## Installation
### Swift Package Manager (Recommended)
In Xcode 13 or later, select **File > Add Packages...**
In Xcode 12, select **File > Swift Packages > Add Package Dependency...**
Add `https://github.com/nicoelayda/UIKitLivePreview.git` as the package repository URL.
**or**
If you have an existing `Package.swift` file, add `UIKitLivePreview` package to your target's dependencies.
```swift
dependencies: [
.package(url: "https://github.com/nicoelayda/UIKitLivePreview.git", .upToNextMajor(from: "1.3.1"))
]
```
### Carthage
1. Add `UIKitLivePreview` to your `Cartfile`.
```
github "nicoelayda/UIKitLivePreview" ~> 1.3.1
```
2. Run `carthage update --use-xcframeworks`
3. Drag `UIKitLivePreview.xcframework` in `Carthage/Build` into your application target's **Frameworks, Libraries and Embedded Content**.
### Cocoapods
1. Add `UIKitLivePreview` to your `Podfile`.
```ruby
pod 'UIKitLivePreview', '~> 1.3.1'
```
2. Run `pod install`
### Manual Install
Copy the contents of [`Sources/UIKitLivePreview`](https://github.com/nicoelayda/UIKitLivePreview/tree/main/Sources/UIKitLivePreview) to your project.
A prebuilt [XCFramework binary](https://github.com/nicoelayda/UIKitLivePreview/releases/latest) is also available
## Usage
1. Import `UIKitLivePreview` in your view or view controller.
2. In the same Swift file, define a new struct conforming to `PreviewProvider`.
3. Inside the `previews` property:
- Initialise your UIKit view or view controller.
- Call `preview()` on it to create a wrapped SwiftUI `View` instance.
- Return the preview instance.
4. Optionally, you may chain `ViewModifier`s to customise the preview. See example below.
#### Example
```swift
final class MyViewController: UIViewController { /* ... */ }
#if DEBUG && canImport(SwiftUI)
import SwiftUI
@available(iOS 13.0, *)
struct MyViewController_Preview: PreviewProvider {
static var previews: some View {
MyViewController()
.preview()
.device(.iPhone11)
.landscape()
}
}
#endif
```
**NOTE:** If your project is targeting iOS 12, it is recommended to wrap the `PreviewProvider` struct in a `#if canImport(SwiftUI)` directive and add the `@available(iOS 13.0, *)` attribute to it.
Check out [**UIKitLivePreview-Examples**](https://github.com/nicoelayda/UIKitLivePreview-Examples) for a sample project.
## License
MIT. See [LICENSE](https://github.com/nicoelayda/UIKitLivePreview/blob/main/LICENSE).