Buscar pacotes, repositórios e categorias de apps

Detalhes do pacotev1.4.5

flutter_pdfview

Um plugin Flutter que fornece um widget PDFView no Android e no iOS.

AndroidiOS
Downloads em 30 dias
491 mil
Curtidas
751
Pontos Pub
160

Instalar pacote

flutter pub add flutter_pdfview

Visão geral do pacote

Orientação gerada a partir de informações públicas. Apenas para referência.

flutter_pdfview é um plugin do Flutter que permite renderizar documentos PDF em aplicativos Flutter para plataformas Android e iOS. Ele fornece um widget PDFView que suporta funcionalidades básicas de visualização de PDF, como zoom, panorâmica e navegação entre páginas. O plugin utiliza os recursos nativos de renderização de PDF de cada plataforma para garantir desempenho suave e exibição precisa. É ideal para aplicativos que exigem recursos de pré-visualização ou leitura de documentos sem a necessidade de visualizadores externos.

Casos de uso

  • Exibindo documentos PDF em aplicativos
  • Funcionalidade de visualização de documentos
  • Ler livros eletrônicos ou manuais
  • Integrando PDFs em aplicativos educacionais
  • Acesso offline a documentos

Principais recursos

  • Renderização nativa de PDF no Android e no iOS
  • Suporte a zoom e panorâmica
  • Navegação de página
  • Leve e eficiente
  • Compatibilidade multiplataforma

Indicado para

  • Aplicativos que precisam de visualização de PDF
  • Aplicativos educacionais ou voltados para documentação
  • Leitores móveis
  • Plataformas de entrega de conteúdo
  • Acesso offline a documentos

Considerações

  • Recursos limitados de edição avançada de PDF
  • Sem funcionalidade de pesquisa embutida
  • O desempenho pode variar com PDFs grandes
  • Requer manipulação adequada de arquivos para PDFs locais ou remotos
  • Depende da qualidade de renderização da plataforma nativa

README original

Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.

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

Categorias

Repositório-fonte

Projetos que usam este pacote