A react native PDF view component, support ios and android platform
npm install react-native-pdfA 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
react-native-blob-util to handle file system access in this package,> The table below shows the supported versions of React Native and react-native-blob-util for different versions of react-native-pdf.
| React Native | 0.4x - 0.56 | 0.57 | 0.60+ | 0.62+ | 0.62+ |
| ------------------------- | --------------- | ------- | -------- | -------- | -------- |
| react-native-pdf | 4.x.x - 5.0.x | 5.0.9+ | 6.0.0+ | 6.2.0+ | 6.4.0+ |
| react-native-blob-util | | | | | 0.13.7+ |
> 🚨 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.
``bashUsing npm
npm install react-native-pdf react-native-blob-util --save
Then follow the instructions for your platform to link react-native-pdf into your project:
$3
iOS details
React Native 0.60 and above
Run
in the ios directory. Linking is not required in React Native 0.60 and above.React Native 0.59 and below
`bash
react-native link react-native-blob-util
react-native link react-native-pdf
`
$3
Android details
If you use RN 0.59.0 and above, please add following to your android/app/build.gradle**
diff
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
bash
react-native link react-native-blob-util
react-native link react-native-pdf
`
$3
Windows details
- Open your solution in Visual Studio 2019 (eg.
)
- 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
- Right-click main application project > Add > Reference...
- Select and in Solution Projects
- If running 0.62, also select RCTPdf and ReactNativeBlobUtil
- In app add #include "winrt/RCTPdf.h"
- If running 0.62, also select
- In add PackageProviders().Append(winrt::progress_view::ReactPackageProvider()); before InitializeComponent();
- If running RNW 0.62, also add and PackageProviders().Append(winrt::ReactNativeBlobUtil::ReactPackageProvider());
#### Bundling PDFs with the app
To add a
like in the example add:
`
true
in the app file, before .
$3
FAQ details
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 #2Q2. 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 #39Q3. 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
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 :`
NSAppTransportSecurity
NSExceptionDomains
yourserver.com
NSIncludesSubdomains
NSTemporaryExceptionAllowsInsecureHTTPLoads
NSTemporaryExceptionMinimumTLSVersion
TLSv1.1
Q4. why doesn't it work with react native expo?.
A4. Expo does not support native module. you can read more expo caveats
Q5. Why can't I run the iOS example?
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
$3
ChangeLog details
v7.0.3
1. Fixed: RefObject types, and setPage not working in android (#985)v7.0.2
1. Fixed:
error when bookmarks is 0 (#978)
2. Feature: agp 7.3+ fully supported (#980)
3. Fixed: Downgrade pdfiumandroid version to 1.0.32v7.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 :bug: (#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]](https://github.com/wonday/react-native-pdf/releases)
$3
`js
/**
* 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 (
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}/>
)
}
}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,
}
});
`
$3
| Property | Type | Default | Description | iOS | Android | Windows | FirstRelease |
| ------------------------------ | :-----------------------------------------------------------: | :----------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------- | --------------------------- | ------------------------ |
| source | object | not null | PDF source like {uri:xxx, cache:false}. see the following for detail. | ✔ | ✔ | ✔ | <3.0 |
| page | number | 1 | initial page index | ✔ | ✔ | ✔ | <3.0 |
| scale | number | 1.0 | should minScale<=scale<=maxScale | ✔ | ✔ | ✔ | <3.0 |
| minScale | number | 1.0 | min scale | ✔ | ✔ | ✔ | 5.0.5 |
| maxScale | number | 3.0 | max scale | ✔ | ✔ | ✔ | 5.0.5 |
| horizontal | bool | false | draw page direction, if you want to listen the orientation change, you can use [[react-native-orientation-locker]](https://github.com/wonday/react-native-orientation-locker) | ✔ | ✔ | ✔ | <3.0 |
| showsHorizontalScrollIndicator | bool | true | shows or hides the horizontal scroll bar indicator on iOS | ✔ | | | 6.6 |
| showsVerticalScrollIndicator | bool | true | shows or hides the vertical scroll bar indicator on iOS | ✔ | | | 6.6 |
| scrollEnabled | bool | true | enable or disable scroll | ✔ | | | 6.6 |
| fitWidth | bool | false | if true fit the width of view, can not use fitWidth=true together with scale | ✔ | ✔ | ✔ | <3.0, abandoned from 3.0 |
| fitPolicy | number | 2 | 0:fit width, 1:fit height, 2:fit both(default) | ✔ | ✔ | ✔ | 3.0 |
| spacing | number | 10 | the breaker size between pages | ✔ | ✔ | ✔ | <3.0 |
| password | string | "" | pdf password, if password error, will call OnError() with message "Password required or incorrect password." | ✔ | ✔ | ✔ | <3.0 |
| style | object | {backgroundColor:"#eee"} | support normal view style, you can use this to set border/spacing color... | ✔ | ✔ | ✔ | <3.0
| progressContainerStyle | object | {backgroundColor:"#eee"} | support normal view style, you can use this to set border/spacing color... | ✔ | ✔ | ✔ | 6.9.0 |
| renderActivityIndicator | (progress) => Component |
| enableAntialiasing | bool | true | improve rendering a little bit on low-res screens, but maybe cause some problem on Android 4.4, so add a switch | ✖ | ✔ | ✖ | <3.0 |
| enablePaging | bool | false | only show one page in screen | ✔ | ✔ | ✔ | 5.0.1 |
| enableRTL | bool | false | scroll page as "page3, page2, page1" | ✔ | ✖ | ✔ | 5.0.1 |
| enableAnnotationRendering | bool | true | enable rendering annotation, notice:iOS only support initial setting,not support realtime changing | ✔ | ✔ | ✖ | 5.0.3 |
| enableDoubleTapZoom | bool | true | Enable double tap to zoom gesture | ✔ | ✔ | ✖ | 6.8.0 |
| trustAllCerts | bool | true | Allow connections to servers with self-signed certification | ✔ | ✔ | ✖ | 6.0.? |
| singlePage | bool | false | Only show first page, useful for thumbnail views | ✔ | ✔ | ✔ | 6.2.1 |
| onLoadProgress | function(percent) | null | callback when loading, return loading progress (0-1) | ✔ | ✔ | ✖ | <3.0 |
| onLoadComplete | function(numberOfPages, path, {width, height}, tableContents) | null | callback when pdf load completed, return total page count, pdf local/cache path, {width,height} and table of contents | ✔ | ✔ | ✔ but without tableContents | <3.0 |
| onPageChanged | function(page,numberOfPages) | null | callback when page changed ,return current page and total page count | ✔ | ✔ | ✔ | <3.0 |
| onError | function(error) | null | callback when error happened | ✔ | ✔ | ✔ | <3.0 |
| onPageSingleTap | function(page) | null | callback when page was single tapped | ✔ | ✔ | ✔ | 3.0 |
| onScaleChanged | function(scale) | null | callback when scale page | ✔ | ✔ | ✔ | 3.0 |
| onPressLink | function(uri) | null | callback when link tapped | ✔ | ✔ | ✖ | 6.0.0 |
#### parameters of source
| parameter | Description | default | iOS | Android | Windows |
| ------------ | ----------- | ------- | --- | ------- | ------- |
| uri | pdf source, see the forllowing for detail.| required | ✔ | ✔ | ✔ |
| cache | use cache or not | false | ✔ | ✔ | ✖ |
| cacheFileName | specific file name for cached pdf file | SHA1(uri) result | ✔ | ✔ | ✖ |
| expiration | cache file expired seconds (0 is not expired) | 0 | ✔ | ✔ | ✖ |
| method | request method when uri is a url | "GET" | ✔ | ✔ | ✖ |
| headers | request headers when uri is a url | {} | ✔ | ✔ | ✖ |
#### types of source.uri
| Usage | Description | iOS | Android | Windows |
| ------------ | ----------- | --- | ------- | ------- |
|
| load pdf from a url | ✔ | ✔ | ✔ |
| {require("./test.pdf")} | load pdf relate to js file (do not need add by xcode) | ✔ | ✖ | ✖ |
| {uri:"bundle-assets://path/to/xxx.pdf"} | load pdf from assets, the file should be at android/app/src/main/assets/path/to/xxx.pdf | ✖ | ✔ | ✖ |
| {uri:"bundle-assets://xxx.pdf"} | load pdf from assets, you must add pdf to project by xcode. this does not support folder. | ✔ | ✖ | ✖ |
| {uri:"data:application/pdf;base64,JVBERi0xLjcKJc..."} | load pdf from base64 string | ✔ | ✔ | ✔ |
| {uri:"file:///absolute/path/to/xxx.pdf"} | load pdf from local file system | ✔ | ✔ | ✔ |
| {uri:"ms-appx:///xxx.pdf"}} | load pdf bundled with UWP app | ✖ | ✖ | ✔ |
| {uri:"content://com.example.blobs/xxxxxxxx-...?offset=0&size=xxx"} | load pdf from content URI | ✔* | ✖ | ✖ |
| {uri:"blob:xxxxxxxx-...?offset=0&size=xxx"} | load pdf from blob URL | ✖ | ✔ | ✖ |\*) requires building React Native from source with this patch
$3
* setPageMethods operate on a ref to the PDF element. You can get a ref with the following code:
`
return (
source={source}
...
/>
);
#### setPage()
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