パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v1.4.5

flutter_pdfview

Android および iOS で PDFView ウィジェットを提供する Flutter プラグインです。

AndroidiOS
30日間ダウンロード
49.1万
いいね数
751
Pub ポイント
160

パッケージをインストール

flutter pub add flutter_pdfview

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

flutter_pdfview は、Android および iOS プラットフォーム上の Flutter アプリケーションで PDF ドキュメントをレンダリングできる Flutter プラグインです。ズーム、パン、ページナビゲーションなどの基本的な PDF 表示機能をサポートする PDFView ウィジェットを提供しています。プラットフォームごとのネイティブな PDF レンダリング機能を利用することで、スムーズなパフォーマンスと正確な表示を実現しています。外部ビューアーが必要ない文書プレビューまたはリーディング機能を必要とするアプリに最適です。

用途

  • アプリケーションでPDFドキュメントを表示する
  • ドキュメントプレビュー機能
  • 電子書籍やマニュアルを読む
  • 教育用アプリケーションでのPDFの統合
  • オフライン文書アクセス

主な機能

  • Android および iOS でのネイティブ PDF レンダリング
  • ズームとパン対応
  • ページナビゲーション
  • 軽量かつ効率的
  • クロスプラットフォーム互換性

適している対象

  • PDF表示が必要なアプリ
  • 教育またはドキュメンテーションを重視したアプリ
  • モバイルリーダー
  • コンテンツ配信プラットフォーム
  • オフライン文書アクセス

注意事項

  • 制限された高度な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

カテゴリー

ソースリポジトリ

このパッケージを使用しているプロジェクト