pdfx_lite

Standalone PDF renderer & viewer for Flutter on Android and iOS — a replacement for pdfx, forked from ScerIO/packages.flutter at pdfx 2.9.2, with the Web, macOS and Windows renderers removed.

Purpose: minimal and legacy-free, for current toolchains only — no CocoaPods (SPM only), no pdf.js, no CMake, and built against the latest Flutter, AGP, Gradle, Android SDK and Xcode rather than older ones. If you need Web, desktop, or CocoaPods, use the upstream package instead.

Same 2 APIs as upstream, both slightly reduced (see Migrating from pdfx):

• renderer — work with a PDF document, its pages, render a page to an image
• viewer — PdfViewPinch, the texture-backed viewer with pinch-to-zoom. Upstream's second, image-backed PdfView is gone, and with it the photo_view dependency.

Getting started

dependencies:
  pdfx_lite: ^3.9.0

import 'package:pdfx_lite/pdfx_lite.dart';

final controller = PdfControllerPinch(
  document: PdfDocument.openAsset('assets/hello.pdf'),
);
// ...
PdfViewPinch(controller: controller);

Migrating from pdfx

1. Replace the dependency, and package:pdfx/pdfx.dart → package:pdfx_lite/pdfx_lite.dart.
2. Web: drop the pdf.js <script> tags from web/index.html, and guard any PDF viewing behind kIsWeb, falling back to the browser's native viewer. The package still has no web renderer (every native call throws on web), but importing it does not break a web build — it holds no dart:io import, so a kIsWeb runtime guard is enough and no conditional-import seam is needed to keep it out of the web bundle.
3. Drop hasPdfSupport() — it was hardcoded true.
4. PdfView → PdfViewPinch (and PdfController → PdfControllerPinch). The image-backed viewer is gone with the unmaintained photo_view it wrapped. To rebuild it: PdfPageImageProvider is still exported.
5. A PdfPage holds no native resource, so it is addressed by number, not by a handle. Drop page.close() and getPage(autoCloseAndroid:); PdfPage.id, PdfPageImage.id and updateRect's documentId are gone. Only the document is closed.
6. Rotated pages: on iOS, PdfPage.width/.height report the displayed size (/Rotate applied), as they always did on Android. If you swapped them yourself to work around #554, remove that.

Encrypted PDFs

final doc = await PdfDocument.openFile(path, password: 'secret');

password: is a fallback, used only if the document demands one — passing it to a document that opens without one is harmless. (A permissions-only PDF, restricted but with an empty user password, needs none.)

PdfDocument.isPasswordSupported() reports that up front, so you can skip a prompt the device cannot honour. Otherwise catch:

• PdfPasswordProtectedException — needs a password, and none was given or the given one is wrong. The two are not distinguished; the platform cannot tell them apart. Re-prompt.
• PdfPasswordUnsupportedException — encrypted, and this Android device cannot take a password at all. Never a wrong password. Fall back, e.g. to an external viewer.

What changed vs upstream

Plus bug fixes pdfx 2.9.2 still has — a crash in PdfViewPinch, broken cropping on Android, an iOS data race, rotated pages mis-sized on iOS, a viewer that rebuilt every frame even at rest, and more. See the CHANGELOG.