搜索插件、代码仓与 APP 分类

插件详情v1.4.5

flutter_pdfview

一个 Flutter 插件,可在 Android 和 iOS 上提供 PDFView 小部件。

AndroidiOS
近 30 天下载
49.1万
喜欢数
751
Pub 分数
160

安装插件

flutter pub add flutter_pdfview

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

flutter_pdfview 是一个 Flutter 插件,可在 Android 和 iOS 平台上渲染 PDF 文档。它提供了一个 PDFView 小部件,支持缩放、平移和页面导航等基本 PDF 查看功能。该插件利用各平台的原生 PDF 渲染能力,确保流畅的性能和准确的显示效果。适用于需要文档预览或阅读功能而无需外部查看器的应用程序。

适合场景

  • 在应用程序中显示PDF文档
  • 文档预览功能
  • 阅读电子书或手册
  • 在教育类应用程序中集成PDF
  • 离线文档访问

主要特点

  • Android 和 iOS 上的原生 PDF 渲染
  • 缩放和平移支持
  • 页面导航
  • 轻便高效
  • 跨平台兼容性

适合对象

  • 需要PDF查看的App
  • 教育或文档导向的应用程序
  • 移动阅读器
  • 内容分发平台
  • 离线文档访问

使用建议

  • 有限的高级PDF编辑功能
  • 无内置搜索功能
  • 性能可能因大型 PDF 而异
  • 需要对本地或远程PDF进行适当的文件处理
  • 依赖于原生平台的渲染质量

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

flutter_pdfview

Native PDF View for iOS and Android

Buy Me A Coffee

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
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

Name Android iOS Default
defaultPage ✅ ✅ 0
onViewCreated ✅ ✅ null
onRender ✅ ✅ null
onPageChanged ✅ ✅ null
onLoadComplete ✅ ✅ null
onDraw ✅ ✅ null
onError ✅ ✅ null
onPageError ✅ ❌ null
onLinkHandle ✅ ✅ null
gestureRecognizers ✅ ✅ null
filePath ✅ ✅
pdfData ✅ ✅
fitPolicy ✅ ✅ FitPolicy.WIDTH
enableSwipe ✅ ✅ true
swipeHorizontal ✅ ✅ false
password ✅ ✅ null
nightMode ✅ ❌ false
autoSpacing* ✅ ✅ true
pageFling ✅ ✅ true
pageSnap ✅ ❌ true
preventLinkNavigation ✅ ✅ false
backgroundColor ✅ ✅ null
minZoom ✅ ✅ 1.0
maxZoom ✅ ✅ 4.0
showScrollIndicators* ✅ ✅ false

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).
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()),
  },
)

Controller Options

Name Description Parameters Return
getPageCount Get total page count - Future<int>
getCurrentPage Get current page - Future<int>
setPage Go to/Set page int page Future<bool>
getCurrentPageSize Return the width and height of the loaded page - Future<Size>
getScreenshot Create a PNG of the contents of the PDFView and save to fileName String fileName Future<String>
getPosition Get the position of the top left of the PDF with respect to the origin (top left of PDFView) - Future<Offset>
getScale Get the PDF zoom value, for zooming - Future<double>
setPosition Set the position of the top left of the PDF with respect to the origin (top left of PDFView) Offset position Future<bool>
setScale Set the PDF zoom value, for zooming double scale Future<bool>
setZoomLimits Set the minimum, maximum and mid bounds of the zoom limits double minZoom, double midZoom, double maxZoom -
reload Reload the PDF document in the PDFView - Future<bool>

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

Buy Me A Coffee

Donate with PayPal button

Star History

Star History Chart
Developer

所属分类

源码仓库

使用此插件的项目