gem-hunter

A react native PDF view component (cross-platform support)

• read a PDF from url, blob, local file or asset and can cache it.
• display horizontally or vertically
• drag and zoom
• double tap for zoom
• support password protected pdf
• jump to a specific page in the pdf

We use react-native-blob-util to handle file system access in this package, So you should install react-native-pdf and react-native-blob-util

The table below shows the supported versions of React Native and react-native-blob-util for different versions of react-native-pdf.

🚨 Expo: This package is not available in the Expo Go app. Learn how you can use this package in Custom Dev Clients via the out-of-tree Expo Config Plugin. Example: with-pdf.

# Using npm
npm install react-native-pdf react-native-blob-util --save

# or using yarn:
yarn add react-native-pdf react-native-blob-util

Then follow the instructions for your platform to link react-native-pdf into your project:

React Native 0.60 and above

Run pod install in the ios directory. Linking is not required in React Native 0.60 and above.

React Native 0.59 and below

react-native link react-native-blob-util
react-native link react-native-pdf

If you use RN 0.59.0 and above, please add following to your android/app/build.gradle**

android {

+    packagingOptions {
+       pickFirst 'lib/x86/libc++_shared.so'
+       pickFirst 'lib/x86_64/libjsc.so'
+       pickFirst 'lib/arm64-v8a/libjsc.so'
+       pickFirst 'lib/arm64-v8a/libc++_shared.so'
+       pickFirst 'lib/x86_64/libc++_shared.so'
+       pickFirst 'lib/armeabi-v7a/libc++_shared.so'
+     }

   }

React Native 0.59.0 and below

react-native link react-native-blob-util
react-native link react-native-pdf

• Open your solution in Visual Studio 2019 (eg. windows\yourapp.sln)
• Right-click Solution icon in Solution Explorer > Add > Existing Project...
• If running RNW 0.62: add node_modules\react-native-pdf\windows\RCTPdf\RCTPdf.vcxproj
• If running RNW 0.62: add node_modules\react-native-blob-util\windows\ReactNativeBlobUtil\ReactNativeBlobUtil.vcxproj
• Right-click main application project > Add > Reference...
• Select progress-view and in Solution Projects
  • If running 0.62, also select RCTPdf and ReactNativeBlobUtil
• In app pch.h add #include "winrt/RCTPdf.h"
  • If running 0.62, also select #include "winrt/ReactNativeBlobUtil.h"
• In App.cpp add PackageProviders().Append(winrt::progress_view::ReactPackageProvider()); before InitializeComponent();
  • If running RNW 0.62, also add PackageProviders().Append(winrt::RCTPdf::ReactPackageProvider()); and PackageProviders().Append(winrt::ReactNativeBlobUtil::ReactPackageProvider());

To add a test.pdf like in the example add:

<None Include="..\..\test.pdf">
  <DeploymentContent>true</DeploymentContent>
</None>

in the app .vcxproj file, before <None Include="packages.config" />.

Q1. After installation and running, I can not see the pdf file.
A1: maybe you forgot to excute react-native link or it does not run correctly. You can add it manually. For detail you can see the issue #24 and #2

Q2. When running, it shows 'Pdf' has no propType for native prop RCTPdf.acessibilityLabel of native type 'String'
A2. Your react-native version is too old, please upgrade it to 0.47.0+ see also #39

Q3. When I run the example app I get a white/gray screen / the loading bar isn't progressing .
A3. Check your uri, if you hit a pdf that is hosted on a http you will need to do the following:

iOS: add an exception for the server hosting the pdf in the ios info.plist. Here is an example :

<key>NSAppTransportSecurity</key>
<dict>
  <key>NSExceptionDomains</key>
  <dict>
    <key>yourserver.com</key>
    <dict>
      <!--Include to allow subdomains-->
      <key>NSIncludesSubdomains</key>
      <true/>
      <!--Include to allow HTTP requests-->
      <key>NSTemporaryExceptionAllowsInsecureHTTPLoads</key>
      <true/>
      <!--Include to specify minimum TLS version-->
      <key>NSTemporaryExceptionMinimumTLSVersion</key>
      <string>TLSv1.1</string>
    </dict>
  </dict>
</dict>

Android: see here

Q4. why doesn't it work with react native expo?.
A4. Expo does not support native module. you can read more expo caveats here

Q5. Why can't I run the iOS example? 'Failed to build iOS project. We ran "xcodebuild" command but it exited with error code 65.'
A5. Run the following commands in the project folder (e.g. react-native-pdf/example) to ensure that all dependencies are available:

yarn install (or npm install)
cd ios
pod install
cd ..
react-native run-ios

v7.0.5

1. Security: upgrade shell-quote to 1.8.4 to address CVE-2026-9277 (#1034)
2. Fixed: restore zoom and scroll offset on Android when the view is re-attached to the window (#1028)
3. Fixed(ios): allow PDFKit long-press to start text selection (#1032)
4. Fixed(download): restore missing fetch() call; await temp-file unlink+cp to avoid ENOENT race and unhandled rejection; expose download HTTP status (#1019, #1020, #1031)
5. Fixed(ios): return NO from PdfManager requiresMainQueueSetup (#1027)
6. Fixed: avoid loading legacy PdfView on Fabric path (#1022)
7. Fixed: flow type and stylesheet import (#678)
8. Chore(deps): bump example deps in FabricExample (json, concurrent-ruby) (#1029,#1025)

v7.0.4

1. Fixed: Android PDF crash: IllegalStateException: Already closed (#989) (#999)
2. Fixed: scrollTop on initial render on iOS (#1001)
3. Feature(ios): add text selection support via PDFKit (#1003)

v7.0.3

1. Fixed: RefObject types, and setPage not working in android (#985)

v7.0.2

1. Fixed: Loaded page is null error when bookmarks is 0 (#978)
2. Feature: agp 7.3+ fully supported (#980)
3. Fixed: Downgrade pdfiumandroid version to 1.0.32

v7.0.1

1. Fixed: not rendering on iOS
2. Added: Android 16 KB Page Size support
3. Fixed: crash issue in io.legere:pdfiumandroid that occurred due to multithreading
4. Added: Upgrade Fabric Example to Latest React Native 0.81.0
5. Added: support RTL android

v6.7.7

1. Added: add support for customizable scroll indicators in PdfView component (#904)
2. Fixed: fix field values not being visible on android. issue #864 🐛 (#896)

v6.7.6

1. Fixed: Add missing 'enableDoubleTapZoom' to fabric codegen source (#832)
2. Fixed: added missing 'scrollEnabled' prop (#842)
3. Fixed: java.lang.IllegalStateException: Tried to access a JS module before the React instance was fully set up (#840)
4. Fixed: an issue that crashes when cancel is not present (#852)
5. Added: add load method (#861)
6. Fixed: encoded accented character is decoded incorrectly (#873)
7. Fixed: enableDoubleTapZoom bugfix

v6.7.5

1. Added progressContainerStyle prop
2. Improved: Added enableDoubleTapZoom option
3. Fixed: Fix app crash with this.lastRNBFTask.cancel is not a function (#827)
4. Fixed: Remove override to fix 'no matching methods to override' error (#822)

v6.7.4

1. Fixed: fix Android crash issue

v6.7.3

1. Fixed: fix android package name

v6.7.2

1. Fixed: fix iOS double tap zoom scrolling
2. Fixed: fix RN 73 compatibility
3. Fixed: bump crypto-js to avoid critical vulnerability

v6.7.1

1. Fixed: fix ios project setting
2. Fixed: fix typo in RNPDFPdfViewManagerInterface interface causing android build error

v6.7.0

1. Fixed: fix(iOS): center page at tap point after double tap to zoom
2. Fixed: add PDFKit to podspec to make ios compile
3. Improved: Update build.gradle to support RN 0.71 on new arch
4. Fixed: fix some small bugs and documents.

v6.6.2

1. Fixed: Migrate to ViewPropTypes exported from 'deprecated-react-native-prop-types'
2. Added: Decode File Path for iOS
3. Improved: prefer current page for calculating scale factor on fit

v6.6.1 depresed

v6.6.0 depresed

1. Fixed: Migrate to ViewPropTypes exported from 'deprecated-react-native-prop-types'
2. Added: Decode File Path for iOS
3. Improved: prefer current page for calculating scale factor on fit
4. Improved: Typescript version source

v6.5.0

1. Fix: replace mavenCentral with maven
2. Breaking Change(Android): replace deprecated repository: jcenter()
3. Fix: loading progress
4. Add: Typed "source" prop
5. Remove: dependency to fbjs

v6.4.0

1. Remove sample for reducing NPM package size
2. Add support for setting a filename for the cached pdf file
3. Use react-native-blob-util instead of rn-fetch-blob
4. Add blob support
5. remove progress-view dependency

v6.3.0

1. Add windows support
2. Fixed some bugs

[more]

/**
 * Copyright (c) 2017-present, Wonday (@wonday.org)
 * All rights reserved.
 *
 * This source code is licensed under the MIT-style license found in the
 * LICENSE file in the root directory of this source tree.
 */

import React from 'react';
import { StyleSheet, Dimensions, View } from 'react-native';
import Pdf from 'react-native-pdf';

export default class PDFExample extends React.Component {
    render() {
        const source = { uri: 'http://samples.leanpub.com/thereactnativebook-sample.pdf', cache: true };
        //const source = require('./test.pdf');  // ios only
        //const source = {uri:'bundle-assets://test.pdf' };
        //const source = {uri:'file:///sdcard/test.pdf'};
        //const source = {uri:"data:application/pdf;base64,JVBERi0xLjcKJc..."};
        //const source = {uri:"content://com.example.blobs/xxxxxxxx-...?offset=0&size=xxx"};
        //const source = {uri:"blob:xxxxxxxx-...?offset=0&size=xxx"};

        return (
            <View style={styles.container}>
                <Pdf
                    source={source}
                    onLoadComplete={(numberOfPages,filePath) => {
                        console.log(`Number of pages: ${numberOfPages}`);
                    }}
                    onPageChanged={(page,numberOfPages) => {
                        console.log(`Current page: ${page}`);
                    }}
                    onError={(error) => {
                        console.log(error);
                    }}
                    onPressLink={(uri) => {
                        console.log(`Link pressed: ${uri}`);
                    }}
                    style={styles.pdf}/>
            </View>
        )
    }
}

const styles = StyleSheet.create({
    container: {
        flex: 1,
        justifyContent: 'flex-start',
        alignItems: 'center',
        marginTop: 25,
    },
    pdf: {
        flex:1,
        width:Dimensions.get('window').width,
        height:Dimensions.get('window').height,
    }
});

If the pdf file needs to be transformed before it is displayed (e.g. when the stored or downloaded file is encrypted), set the transformFile prop to true. The transformation itself is performed by react-native-blob-util, so you must set a file transformer on that library first — see setting a file transformer in the react-native-blob-util documentation.

<Pdf
    source={source}
    transformFile={true}
    onLoadComplete={(numberOfPages,filePath) => {
        console.log(`Number of pages: ${numberOfPages}`);
    }}
    onError={(error) => {
        console.log(error);
    }}
    style={styles.pdf}/>

Note: when transformFile is enabled, the transformed file is written to a separate .view file, so the original file on disk stays in its transformed (e.g. encrypted) form.

*) requires building React Native from source with this patch

• setPage

Methods operate on a ref to the PDF element. You can get a ref with the following code:

return (
  <Pdf
    ref={(pdf) => { this.pdf = pdf; }}
    source={source}
    ...
  />
);

setPage(pageNumber)

Set the current page of the PDF component. pageNumber is a positive integer. If pageNumber > numberOfPages, current page is not changed.

Example:

this.pdf.setPage(42); // Display the answer to the Ultimate Question of Life, the Universe, and Everything