Integrate WebViewer into React

This sample is designed to show you how to integrate WebViewer into a React project. Read more about integrating with React.

You can watch a video here to help you get started.

WebViewer provides a slick out-of-the-box responsive UI that enables you to view, annotate and manipulate PDFs and other document types inside any web project.

Once you generate your license key, it will automatically be included in your sample code below.

Click the button below to view the full project in GitHub.

TSX

App.tsx

import { useRef, useEffect } from 'react';
import WebViewer, { type WebViewerInstance } from '@pdftron/webviewer';
import './App.css';

const App = () => {
  const viewer = useRef<HTMLDivElement | null>(null);

  useEffect(() => {
    const viewerElement = viewer.current;
    if (!viewerElement) return;

    let isUnmounted = false;
    let webViewerInstance: WebViewerInstance | null = null;
    let onDocumentLoaded: (() => void) | null = null;

    WebViewer(
      {
        path: '/lib/webviewer',
        initialDoc: 'https://apryse.s3.amazonaws.com/public/files/samples/WebviewerDemoDoc.pdf',
        licenseKey: import.meta.env.VITE_DEMO_KEY,  // sign up to get a free trial key at https://dev.apryse.com
      },
      viewerElement,
    ).then((instance: WebViewerInstance) => {
      if (isUnmounted) {
        instance.UI.dispose();
        return;
      }

      webViewerInstance = instance;

      // Access WebViewer instance here
      const { documentViewer, annotationManager, Annotations } = instance.Core;

      // Example: Add a rectangle annotation to the first page when the document is loaded
      onDocumentLoaded = () => {
        const rectangleAnnot = new Annotations.RectangleAnnotation({
          PageNumber: 1,
          // values are in page coordinates with (0, 0) in the top left
          X: 100,
          Y: 150,
          Width: 200,
          Height: 50,
          Author: annotationManager.getCurrentUser()
        });

        annotationManager.addAnnotation(rectangleAnnot);
        // Need to draw the annotation otherwise it won't show up until the page is refreshed
        annotationManager.redrawAnnotation(rectangleAnnot);
      };

      documentViewer.addEventListener('documentLoaded', onDocumentLoaded);
    });

    return () => {
      isUnmounted = true;

      if (webViewerInstance) {
        if (onDocumentLoaded) {
          webViewerInstance.Core.documentViewer.removeEventListener('documentLoaded', onDocumentLoaded);
        }

        webViewerInstance.UI.dispose();
      }
    };
  }, []);

  return (
    <div className="App">
      <div className="header">React sample</div>
      <div className="webviewer" ref={viewer}></div>
    </div>
  );
};

export default App;