NEW: Subscribe to Hacking with Swift+ and accelerate your learning! >>

How to preview files using Quick Look and QLPreviewController

Swift version: 5.2

Paul Hudson    @twostraws   

Apple’s Quick Look framework lets you embed previewing for a huge range of file types, including iWork documents, Microsoft Office documents, PDFs, images, and more, all without writing much code.

First, import the QuickLook framework, then make your view controller conform to the QLPreviewControllerDataSource protocol. This protocol lets you provide items to Quick Look, which should be URLs pointing to whatever documents you’re trying to preview.

Now go ahead and create and present an instance of QLPreviewController, setting your view controller to be its data source:

let previewController = QLPreviewController()
previewController.dataSource = self
present(previewController, animated: true)

There are two methods you need to implement: how many items your Quick Look controller should show, and the URL for each item. The first of those is just a matter of returning an integer from numberOfPreviewItems():

func numberOfPreviewItems(in controller: QLPreviewController) -> Int {
    return 3
}

Now for the important part: Quick Look will call a previewItemAt method for each item you want to preview, and you need to pass back a QLPreviewItem pointing at it.

For this example I added three PDF files – 0.pdf, 1.pdf, and 2.pdf – to my project, so I’m going to pass back URLs to each of them. URL conforms to QLPreviewItem already, so we can just do an as typecast to make this work:

func previewController(_ controller: QLPreviewController, previewItemAt index: Int) -> QLPreviewItem {
    guard let url = Bundle.main.url(forResource: String(index), withExtension: "pdf") else {
        fatalError("Could not load \(index).pdf")
    }

    return url as QLPreviewItem
}

When that runs you’ll be able to swipe horizontally through Quick Look items, or swipe up and down through pages in your PDFs.

Hacking with Swift is sponsored by Instabug

SPONSORED Are you tired of wasting time debugging your Swift app? Instabug’s SDK is here to help you minimize debugging time by providing you with complete device details, network logs, and reproduction steps with every bug report. All data is attached automatically, and it only takes a line of code to setup. Start your free trial now and get 3 months off exclusively for the Hacking with Swift Community.

Start your free trial!

Sponsor Hacking with Swift and reach the world's largest Swift community!

Listen to the Swift over Coffee podcast

Available from iOS 4.0

Similar solutions…

About the Swift Knowledge Base

This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.

BUY OUR BOOKS
Buy Pro Swift Buy Swift Design Patterns Buy Testing Swift Buy Hacking with iOS Buy Swift Coding Challenges Buy Swift on Sundays Volume One Buy Server-Side Swift (Vapor Edition) Buy Advanced iOS Volume One Buy Advanced iOS Volume Two Buy Advanced iOS Volume Three Buy Hacking with watchOS Buy Hacking with tvOS Buy Hacking with macOS Buy Dive Into SpriteKit Buy Swift in Sixty Seconds Buy Objective-C for Swift Developers Buy Server-Side Swift (Kitura Edition) Buy Beyond Code

Was this page useful? Let us know!

Average rating: 4.8/5