flutter_pdfview #

Native PDF View for iOS and Android

Use this package as a library #

1. Depend on it #

Add this to your package's pubspec.yaml file:

dependencies:
  flutter_pdfview: ^1.4.5

Trying the 1.5.0 beta

1.5.0-beta.3 continues the Kotlin/Swift line and adds a first-class onTap callback (#133). Pre-releases are not picked up by a ^ constraint, so pin it explicitly:

dependencies:
  flutter_pdfview: 1.5.0-beta.3

Feedback is welcome in #351.

2. Install it #

You can install packages from the command line:

with Flutter:

$ flutter packages get

Alternatively, your editor might support pub get or flutter packages get. Check the docs for your editor to learn more.

3. Import it #

Now in your Dart code, you can use:

import 'package:flutter_pdfview/flutter_pdfview.dart';

Options #

Notes:

• showScrollIndicators is ignored on iOS while horizontal page-flipping is active (pageFling: true together with swipeHorizontal: true).
• autoSpacing only adds gaps between pages. It does not change initial zoom or fitPolicy (fixed in #150).

Detecting taps (onTap) #

For a reliable single-tap callback, use the first-class onTap parameter. It is delivered from the native PDF control on both platforms:

PDFView(
  filePath: path,
  onTap: () {
    // e.g. toggle chrome / app bar
  },
)

Do not rely on gestureRecognizers with a TapGestureRecognizer for taps. Flutter’s platform-view gesture arena often never delivers onTap for embedded native views (#133). Keep gestureRecognizers for parent-scroll conflicts (below).

Using PDFView inside a scrollable widget #

When a PDFView is embedded in a scrollable parent (SingleChildScrollView, ListView, PageView, ...), the parent can claim drag gestures before they reach the native view, so swiping inside the PDF does not work — most notably on iOS (#265). Pass an EagerGestureRecognizer to let the PDF view consume gestures within its bounds:

import 'package:flutter/foundation.dart';
import 'package:flutter/gestures.dart';

PDFView(
  filePath: path,
  gestureRecognizers: {
    Factory<OneSequenceGestureRecognizer>(() => EagerGestureRecognizer()),
  },
)

BackdropFilter / ColorFiltered over PDFView (iOS) #

PDFView is a platform view (UiKitView on iOS, hybrid composition on Android). Flutter composites native views outside the normal Flutter layer tree, so some widgets that sample or recolor the scene do not apply to the PDF pixels — especially on iOS.

This is not a bug in flutter_pdfview. Flutter documents it under iOS platform view composition limitations: ShaderMask and ColorFiltered are unsupported; BackdropFilter works only within the constraints of the iOS Platform View Backdrop Filter design.

Workarounds

1. Color inversion / dark pages — Prefer the plugin API instead of wrapping the view in ColorFiltered:

   • Android: nightMode: true (native invert).
   • iOS: nightMode is not available today; use a theme-appropriate backgroundColor, or invert offline content before load if you control the PDF bytes.

2. Blur / glass under a sheet — Place the BackdropFilter so it samples Flutter-drawn content (not only the hole where the native PDF sits), use a semi-transparent barrierColor / scrim, or capture a static preview with PDFViewController.getScreenshot and blur that Image with Flutter widgets.

3. Static filtered preview — For a one-shot recolor (e.g. thumbnail), take a screenshot and wrap the resulting image:

final path = await controller.getScreenshot('preview.png');
// Then:
ColorFiltered(
  colorFilter: const ColorFilter.mode(Colors.grey, BlendMode.saturation),
  child: Image.file(File(path)),
);

Wrapping PDFView itself in ColorFiltered will keep painting a solid tint under the native view on iOS while leaving the PDF contents unchanged (#213).

Controller Options #

Example #

PDFView(
  filePath: path,
  enableSwipe: true,
  swipeHorizontal: true,
  autoSpacing: false,
  pageFling: false,
  showScrollIndicators: true,
  backgroundColor: Colors.grey,
  onRender: (_pages) {
    setState(() {
      pages = _pages;
      isReady = true;
    });
  },
  onError: (error) {
    print(error.toString());
  },
  onPageError: (page, error) {
    print('$page: ${error.toString()}');
  },
  onViewCreated: (PDFViewController pdfViewController) {
    _controller.complete(pdfViewController);
  },
  onPageChanged: (int page, int total) {
    print('page change: $page/$total');
  },
  onLoadComplete: (int? pages) {
    print('# of pages: $pages');
  },
  onDraw: (double xOffset, double yOffset, double scale) {
    print('onDraw');
  },
),

Dependencies #

Android #

AndroidPdfViewer

iOS (only support> 12.0) #

PDFKit

Future plans #

• Replace barteksc/AndroidPdfViewer with MuPDF or Android Native PDF Renderer.
• Improve documentation
• Support other platforms such as MacOS, Windows, Linux and Web
• Add search functionality
• Improve performance on zooming, page changing
• Improve image quality
• Write more test

Support #

Star History #

Developer #

• endigo