react-native-pdf-thumbnail

A react native module for generating thumbnail for PDF files.

A wrapper for:

• PDFKit on iOS (requires iOS 11+)
• PdfRenderer on Android (requires API level 21 - LOLLIPOP)

No other JavaScript or native dependencies.

Note: This module does not work in Expo.

Installation

1npm install react-native-pdf-thumbnail

Usage

1import PdfThumbnail from "react-native-pdf-thumbnail";
2
3// For iOS, the filePath can be a file URL.
4// For Android, the filePath can be either a content URI, a file URI or an absolute path.
5const filePath = 'file:///mnt/sdcard/myDocument.pdf';
6const page = 0;
7
8// The thumbnail image is stored in caches directory, file uri is returned.
9// Image dimensions are also available to help you display it correctly.
10const { uri, width, height } = await PdfThumbnail.generate(filePath, page);
11
12// Generate thumbnails for all pages, returning an array of the object above.
13const results = await PdfThumbnail.generateAllPages(filePath);
14
15// Default compression quality is 80, you can optionally specify a quality between 0 and 100.
16const { uri, width, height } = await PdfThumbnail.generate(filePath, page, 95);
17const results = await PdfThumbnail.generateAllPages(filePath, 90);

Demo

The example app contains a document picker, it generates and displays a thumbnail for the selected PDF file.

To run it:

1yarn bootstrap
2cd example
3yarn ios
4yarn android

iOS	Android

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT