Package Health Score

86 / 100

security
No known security issues
popularity
Popular
maintenance
Healthy
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
6.7.6	\|	12/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
6.7.5	\|	04/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
6.6.2	\|	07/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.1.7	\|	10/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.0.0	\|	07/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Popular

Weekly Downloads (135,140)

GitHub Stars: 1.61K
Forks: 562
Contributors: 110

Direct Usage Popularity

The npm package react-native-pdf receives a total of 135,140 downloads a week. As such, we scored react-native-pdf popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package react-native-pdf, we found that it has been starred 1,609 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 110
Funding: No

A good and healthy external contribution signal for react-native-pdf project, which invites more than one hundred open source maintainers to collaborate on the repository.

We found a way for you to contribute to the project! Looks like react-native-pdf is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 328
Open PR: 5
Last Release: 18 days ago
Last Commit: 18 days ago

Further analysis of the maintenance status of react-native-pdf based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that react-native-pdf demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 8 years
Dependencies: 2 Direct
Versions: 98
Install Size: 286 kB
Dist-tags: 1
# of Files: 62
Maintainers: 1
TS Typings: Yes

react-native-pdf has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

react-native-pdf

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

Feature

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

Supported versions

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.

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.

Installation

# 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:

iOS installation

iOS details

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

Android installation

Android details

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

Windows installation

Windows details

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());

Bundling PDFs with the app

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


  true

in the app .vcxproj file, before ``.

FAQ

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 #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 :

NSAppTransportSecurity

  NSExceptionDomains
  
    yourserver.com
    
      
      NSIncludesSubdomains
      
      
      NSTemporaryExceptionAllowsInsecureHTTPLoads
      
      
      NSTemporaryExceptionMinimumTLSVersion
      TLSv1.1

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

ChangeLog

ChangeLog details

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

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

v6.7.4

Fixed: fix Android crash issue

v6.7.3

Fixed: fix android package name

v6.7.2

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

v6.7.1

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

v6.7.0

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

v6.6.2

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

v6.6.1 depresed

v6.6.0 depresed

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

v6.5.0

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

v6.4.0

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

v6.3.0

Add windows support
Fixed some bugs

[more]

Example

/**
 * 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: 'https://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&amp;size=xxx"};
        //const source = {uri:"blob:xxxxxxxx-...?offset=0&amp;size=xxx"};

        return (
            
        )
    }
}

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,
    }
});

Configuration

Property	Type	Default	Description	iOS	Android	Windows	FirstRelease
source	object	not null	PDF source like {uri:xxx, cache:false}. see the following for detail.	✔	✔	✔	❤️.0
page	number	1	initial page index	✔	✔	✔	❤️.0
scale	number	1.0	should minScale<=scale<=maxScale	✔	✔	✔	❤️.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]	✔	✔	✔	❤️.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	✔	✔	✔	❤️.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	✔	✔	✔	❤️.0
password	string	""	pdf password, if password error, will call OnError() with message "Password required or incorrect password."	✔	✔	✔	❤️.0
style	object	{backgroundColor:"#eee"}	support normal view style, you can use this to set border/spacing color...	✔	✔	✔	❤️.0
progressContainerStyle	object	{backgroundColor:"#eee"}	support normal view style, you can use this to set border/spacing color...	✔	✔	✔	6.9.0
renderActivityIndicator	(progress) => Component		when loading show it as an indicator, you can use your component	✔	✔	✖	❤️.0
enableAntialiasing	bool	true	improve rendering a little bit on low-res screens, but maybe course some problem on Android 4.4, so add a switch	✖	✔	✖	❤️.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)	✔	✔	✖	❤️.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	❤️.0
onPageChanged	function(page,numberOfPages)	null	callback when page changed ,return current page and total page count	✔	✔	✔	❤️.0
onError	function(error)	null	callback when error happened	✔	✔	✔	❤️.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
`{uri:"https://xxx/xxx.pdf"}`	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

Methods

setPage

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

return (
   { this.pdf = pdf; }}
    source={source}
    ...
  /&gt;
);

setPage()

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

react-native-pdf dependencies

crypto-js deprecated-react-native-prop-types

react-native-pdf development dependencies

@babel/core @babel/runtime prop-types

FAQs

What is react-native-pdf?

A react native PDF view component, support ios and android platform. Visit Snyk Advisor to see a full health score report for react-native-pdf, including popularity, security, maintenance & community analysis.

Is react-native-pdf popular?

The npm package react-native-pdf receives a total of 135,140 weekly downloads. As such, react-native-pdf popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is react-native-pdf well maintained?

We found that react-native-pdf demonstrated a healthy version release cadence and project activity. It has a community of 110 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is react-native-pdf safe to use?

The npm package react-native-pdf was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 December-2024, at 02:01 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP