Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sebastianbaar/sbquicklook
Quickly preview local and remote files and their content using Apple's QuickLook Framework
https://github.com/sebastianbaar/sbquicklook
ios quicklook spm swift swiftui uikit
Last synced: 11 days ago
JSON representation
Quickly preview local and remote files and their content using Apple's QuickLook Framework
- Host: GitHub
- URL: https://github.com/sebastianbaar/sbquicklook
- Owner: sebastianbaar
- License: mit
- Created: 2023-02-23T19:48:15.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-02-26T14:28:27.000Z (over 1 year ago)
- Last Synced: 2024-03-14T18:01:21.087Z (8 months ago)
- Topics: ios, quicklook, spm, swift, swiftui, uikit
- Language: Swift
- Homepage:
- Size: 72.3 KB
- Stars: 10
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SBQuickLook
[](https://github.com/sebastianbaar/SBQuickLook/actions/workflows/ios.yml)
[](https://github.com/sebastianbaar/SBQuickLook/actions/workflows/swiftlint.yml)
[](https://swiftpackageindex.com/sebastianbaar/SBQuickLook)
[](https://swiftpackageindex.com/sebastianbaar/SBQuickLook)
[](https://en.wikipedia.org/wiki/MIT_License)
Quickly preview local & external files and their content using Apple's QuickLook Framework.
This package provides a wrapper around Apple's **[QuickLook Framework](https://developer.apple.com/documentation/quicklook)**.
- Can preview:
- iWork and Microsoft Office documents
- Images
- Live Photos
- Text files
- PDFs
- Audio and video files
- Augmented reality objects that use the USDZ file format (iOS and iPadOS only)
- ZIP files
- ...
- Can be used with **UIKit** or **SwiftUI**
- Can be used to preview **one** or **multiple** files at once.
- Can be used with **local file** URLs or **external** URLs (it also handels downloading the files).
## 📦 Installation
Add this Swift package in Xcode using its Github repository url. (File > Swift Packages > Add Package Dependency...)
## 🚀 How to use
Initialize the View (SwiftUI) or ViewController (UIKit)
```swift
/// Initializes the `SBQuickLookView` or `SBQuickViewController` with the given file items and configuration.
///
/// - Parameters:
/// - fileItems: The `[SBQLFileItem]` data for populating the preview. Could be one or many items.
/// - configuration: Optional `SBQLConfiguration` configurations.
/// - completion: Optional `Result` completion.
/// - success: `QLPreviewController` successfully presented with at least one item. Optional `SBQLError` if some items failed to download.
/// - failure: `QLPreviewController` could not be presented.
public init(
fileItems: [SBQLFileItem],
configuration: SBQLConfiguration? = nil,
completion: ((Result) -> Void)? = nil) {
self.fileItems = fileItems
self.configuration = configuration
self.completion = completion
}
```
You have to pass the file items `SBFileItem` to the initializer. Either pass one item or multiple items to the View (SwiftUI) or ViewController (UIKit).
```swift
/// Initializes the file item with the given values.
///
/// - Parameters:
/// - url: `URL` of the item, choose between local file URLs or external URLs
/// - title: Optional title `String` to be displayed in the QuickLook controller.
/// - content: Optional media type `String` of the file; e.g. `"pdf"`, `"jpeg"`, ...
/// - urlRequest: Optional `URLRequest` used to download the item. The `url` is always set to `fileItem.url`. Default: `URLRequest(url: fileItem.url)`
public init(url: URL, title: String? = nil, mediaType: String? = nil, urlRequest: URLRequest? = nil) {
self.url = url
self.title = title
self.mediaType = mediaType
self.urlRequest = urlRequest
}
```
You can also pass an optional `SBQLConfiguration` to the initializer.
```swift
/// Initializes the file item with the given values.
///
/// - Parameters:
/// - urlRequest: Optional `URLSession`. Overrides the `URLSession` used by the download task. Default: `URLSession.shared`
/// - localFileDir: Optional local directory `URL`. Overrides the local directory `URL` used by the download task. Default: `FileManager.default.urls(for: .cachesDirectory, in: .userDomainMask)`
public init(session: URLSession? = nil, localFileDir: URL? = nil) {
self.session = session
self.localFileDir = localFileDir
}
```
### SwiftUI
Present the `SBQuickLookView` (which is a `UIViewControllerRepresentable` wrapper for the `SBQuickViewController`) from your favorite View.
```swift
@State var isShown = false
let fileItems: [SBFileItem]
let configuration: SBQLConfiguration
init() {
let localFileURL = Bundle.main.url(forResource: "sample-local-pdf", withExtension: "pdf")!
fileItems = [
SBFileItem(url: localFileURL, title: "LOCAL FILE"),
SBFileItem(url: URL(string: "https://file-examples.com/storage/fe197d899c63f609e194cb1/2017/10/file_example_PNG_500kB.png")!, title: "Nice PNG Image", mediaType: "png")
]
let localFileDir = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!
configuration = SBQLConfiguration(localFileDir: localFileDir)
}
var body: some View {
VStack {
Button {
isShown.toggle()
} label: {
Text("Open QuickLook of files")
}
}
.fullScreenCover(isPresented: $isShown, content: {
SBQuickLookView(fileItems: fileItems, configuration: configuration) { result in
switch result {
case .success(let downloadError):
if let downloadError {
print(downloadError)
}
case .failure(let error):
switch error.type {
case .emptyFileItems:
print("emptyFileItems")
case .qlPreviewControllerError:
print("qlPreviewControllerError")
case .download(let errorFileItems):
print("all items failed downloading")
print(errorFileItems)
}
}
}
})
}
```
### UIKit
Present the `SBQuickViewController` from your favorite ViewController.
```swift
let localFileURL = Bundle.main.url(forResource: "sample-local-pdf", withExtension: "pdf")!
let fileItems = [
SBFileItem(url: localFileURL, title: "LOCAL FILE"),
SBFileItem(url: URL(string: "https://file-examples.com/storage/fe197d899c63f609e194cb1/2017/10/file_example_PNG_500kB.png")!, title: "Nice PNG Image", mediaType: "png")
]
let localFileDir = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!
let configuration = SBQLConfiguration(localFileDir: localFileDir)
let qlController = SBQuickViewController(fileItems: fileItems, configuration: configuration)
qlController.modalPresentationStyle = .overFullScreen
present(qlController, animated: true)
```
## 🎓 Example
Example SwiftUI Project can be found [here](https://github.com/sebastianbaar/SBQuickLook-Example/tree/main).