Is vfr/Reader still being updated for iOS 15 or later?

No, vfr/Reader is explicitly marked as no longer maintained in the README. The author suggests the UXReader PDF Framework as a replacement, but it also hasn't seen recent updates, so it's not a reliable choice for new iOS versions.

How do I add a PDF viewer to my iOS app using vfr/Reader?

You need to integrate all required files from the README, create a ReaderDocument object with the PDF path, and present a ReaderViewController. The ReaderDemoController class in the sample shows how to do this with a bundled PDF file.

Can vfr/Reader handle annotations or form filling in PDFs?

No, vfr/Reader focuses on core viewing features like rendering, navigation, and encryption. It lacks support for annotations, form filling, or other interactive PDF elements, limiting its use for editable documents.

vfr/Reader vs Apple's PDFKit: which should I use?

PDFKit is Apple's native framework, better supported and integrated with modern iOS, while vfr/Reader offers more customization and performance tuning for specific needs. However, vfr/Reader's abandonment makes PDFKit a safer bet for most projects.

How to customize the toolbar in vfr/Reader?

Customization is done via compile-time #define options in ReaderConstants.h, such as READER_FLAT_UI or READER_ENABLE_THUMBS. For deeper changes, you must modify the Objective-C source code directly, which requires familiarity with the codebase.

Does vfr/Reader work with Swift projects?

Yes, but since it's written in Objective-C, you'll need to set up a bridging header to use it in Swift. This adds complexity and might not be worth the effort compared to native Swift libraries or PDFKit.

Open-Awesome

Reader

NOASSERTIONObjective-C

A universal, high-performance PDF reader core for iOS apps with iBooks-like navigation and multithreaded rendering.

Visit Website GitHub

4.2k stars1.1k forks0 contributors

What is Reader?

vfr/Reader is an open-source PDF reader core for iOS that enables developers to embed high-performance PDF viewing capabilities into their applications. It handles rendering, navigation, and optimization for various PDF types and device capabilities, providing a complete template for building custom PDF readers. The project solves the challenge of integrating robust PDF functionality without relying on external libraries or building complex rendering systems from scratch.

Target Audience

iOS developers building apps that require embedded PDF viewing, such as document readers, educational apps, or enterprise tools. It's particularly useful for those needing a customizable, high-performance alternative to system PDF viewers or third-party SDKs.

Value Proposition

Developers choose vfr/Reader for its proven performance with large PDFs, iBooks-like navigation, and deep customization options via compile-time flags. Its code-generated UI and modular design make it easy to integrate into existing projects while maintaining full control over the user experience.

Overview

PDF Reader Core for iOS

Use Cases

Best For

Embedding a PDF viewer in an iOS app without using Apple's native PDFKit
Building custom document reader apps with tailored navigation and UI
Handling large or complex PDF files (250MB+, 2800+ pages) on iOS
Supporting encrypted or password-protected PDFs in an iOS application
Creating universal iOS apps that need PDF viewing on iPhone and iPad
Optimizing PDF rendering performance on older iOS devices (e.g., iPhone 3GS)

Not Ideal For

Projects requiring active maintenance and support for the latest iOS versions and Swift
Teams looking for a Swift-based or SwiftUI-integrated PDF viewer with modern syntax
Apps needing advanced PDF interactions like annotations, form filling, or digital signatures
Developers wanting a quick, drop-in solution with minimal setup and dependencies

Pros & Cons

Pros

Wide iOS Compatibility

Supports iPhone, iPad, and iPod touch from iOS 6.0 onward, including Retina displays and full internationalization, as stated in the README, ensuring broad device coverage.

High-Performance Rendering

Uses CATiledLayer and multithreading to smoothly handle large PDFs up to 250MB and 2800+ pages, tested even on older devices like iPhone 3GS.

Customizable UI Options

Offers compile-time #define flags for features like flat UI, shadows, thumbnail navigation, and bookmarks, allowing tailored experiences without runtime overhead.

Encrypted PDF Support

Handles password-protected PDFs and supports PDF links (URI and page navigation), making it suitable for secure document viewing scenarios.

Cons

No Longer Maintained

The README explicitly states the project is unsupported, risking bugs, security issues, and incompatibility with future iOS updates or devices.

Objective-C Legacy Code

Written in Objective-C without Swift support, creating integration hurdles for modern iOS projects and limiting accessibility for Swift-focused developers.

Complex Integration Process

Requires manually adding over 20 source files and multiple frameworks, making setup more involved than using a packaged SDK or native alternatives like PDFKit.

Frequently Asked Questions

Related Projects

FolioReaderKit

📚 A Swift ePub reader and parser framework for iOS.

Stars2,684

Forks779

Last commit6 years ago

FastPdfKit

A Static Library to be embedded on iOS applications to display pdf documents derived from Fast PDF

Stars1,220

Forks321

Last commit7 years ago

TPPDF

TPPDF is a simple-to-use PDF builder for iOS and macOS written in Swift

Stars836

Forks136

Last commit27 days ago

PDFGenerator

A simple generator of PDF written in Swift.

Stars766

Forks109

Last commit5 years ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub