Skip to content


Folders and files

Last commit message
Last commit date

Latest commit



38 Commits

Repository files navigation

WebViewer - React sample

WebViewer is a powerful JavaScript-based PDF Library that's part of the PDFTron PDF SDK. It provides a slick out-of-the-box responsive UI that interacts with the core library to view, annotate and manipulate PDFs that can be embedded into any web project.

WebViewer UI

This repo is specifically designed for any users interested in integrating WebViewer into React project. You can watch a video here to help you get started.



WebViewer comes with a 7-day trial without any feature limitations or trial key needed. To extend the trial, you can obtain the trial key by signing-up on our developer portal.

Initial setup

Before you begin, make sure your development environment includes Node.js.

This sample requires Node version 18.0.0 or higher. To check your version, run node -v in a terminal/console window.


git clone
cd webviewer-react-sample
npm install


npm start

After the app starts, you will be able to see WebViewer running on localhost:3000.


Run npm run build to build the project. The build artifacts will be stored in the build/ directory. See the section about deployment for more information.

To test the build directory locally you can use serve or http-server. In case of serve, by default it strips the .html extension stripped from paths. We added serve.json configuration to disable cleanUrls option.

GitHub Pages

You can deploy your app to GitHub Pages. To do so, make sure to update paths accordingly, for example, to deploy on, modify the path:

   path: '/webviewer-react-sample/webviewer/lib',
   initialDoc: '/webviewer-react-sample/files/PDFTRON_about.pdf',
).then((instance) => {

WebViewer APIs

See API documentation.


See contributing.


See license.