Getting Started with the KendoReact PDFViewer

This guide provides essential information about using the KendoReact PDFViewer package. You will learn how to install the PDFViewer package, add a PDFViewer component to your project, style the component, and activate your license.

After completing this guide, you will be able to reproduce the following example.

Setting Up Your React Project

Before you install the KendoReact PDFViewer, make sure that you have a running React project. The easiest way to set up a project for the KendoReact components is to use the create-kendoreact-app tool that is described in the Get Started with KendoReact article.

Installing the PDFViewer Package

All KendoReact packages are distributed through npm and offer a similar installation experience. To use the PDFViewer component, start with the installation of the PDFViewer npm package and its dependencies. Use Node.js v5.0.0 or later.

Copy Codenpm install --save @progress/kendo-react-pdf-viewer @progress/kendo-data-query @progress/kendo-drawing @progress/kendo-file-saver @progress/kendo-react-animation @progress/kendo-react-buttons @progress/kendo-react-data-tools @progress/kendo-react-dateinputs @progress/kendo-react-dropdowns @progress/kendo-react-indicators @progress/kendo-react-inputs @progress/kendo-react-intl @progress/kendo-react-progressbars @progress/kendo-react-treeview @progress/kendo-react-upload @progress/kendo-licensing @progress/kendo-svg-icons

When using the component with Next.js, it will also be required to install the node-loader library and load it to the webpack in next.config.js as demonstrated below. In addition, depending on the configuration, it might also be needed to install the canvas dependency:

Copy Codeconst nextConfig = {
  webpack: (config, { dev, isServer, webpack, nextRuntime }) => {
    config.module.rules.push({
      test: /\.node$/,
      loader: "node-loader"
    });
    return config;
  }
}

Importing the Component

After installing the package, import the PDFViewer component in the React App.

In the src/App.js file of your React project, import the PDFViewer component from the PDFViewer package.

Copy Code// ES2015 module syntax
import { PDFViewer } from '@progress/kendo-react-pdf-viewer';

Copy Code// CommonJS format
const { PDFViewer } = require('@progress/kendo-react-pdf-viewer');

Using the Component

1. After installing the PDFViewer package and importing the components, add the PDFViewer tag to the App component file of your React project (for example, src/App.js).

2. Set the url prop to a local PDF file in order to display initial PDF content in the viewer.

   Copy Codefunction PDFViewerContainer() {
       return (
         <>
           <PDFViewer url="sample.pdf"/>
         </>
       );
   }
   
   ReactDOM.render(
     <PDFViewerContainer />,
     document.getElementById('app')
   );

3. To style the PDFViewer, install and import the Default theme, which is one of the three beautiful themes for KendoReact.

   3.1. Install the Default theme package.

   Copy Codenpm install --save @progress/kendo-theme-default

   3.2. Import the CSS file from the package in src/App.js. Add this import before your existing App.css import.

   Copy Codeimport '@progress/kendo-theme-default/dist/all.css';

4. Build and run the application by typing the following command in the root folder of your project:

   Copy Codenpm start

5. Navigate to http://localhost:3000 to see the KendoReact PDFViewer component on the page.

Activating Your License Key

Using any of the UI components in the KendoReact library requires either a commercial license key or an active trial license key.

Follow the instructions on the KendoReact My License page to activate your trial or commercial license. You can skip this step if your application already contains a KendoReact license file.

Dependencies

The PDFViewer package requires you to install the following peer dependencies in your application:

Suggested Links

• API Reference of the PDFViewer
• Globalization
• Toolbar
• Events

Learning Resources

• Getting Started with KendoReact
• Virtual Classroom (Training Courses for Registered Users)
• Explore the Finance Portfolio Sample Application
• Explore the Coffee Warehouse Sample Application
• Explore the Github Issues Grid Sample Application