Getting Started with Angular PDF Viewer

25 Aug 20265 minutes to read

This section explains how to create a simple Angular application and add the standalone Syncfusion® Angular PDF Viewer component with the minimum required setup.

Prerequisites

System requirements for Syncfusion® Angular components

Create an Angular application

Use Angular CLI to create a new Angular application, as it provides a standardized project structure, built-in testing tools, and simplified deployment. Use an Angular CLI version that matches the target Angular version (e.g., Angular CLI 17 for Angular 17 projects).

Install Angular CLI globally using the following command:

npm install -g @angular/cli

Create a new Angular application using the following commands:

ng new pdfviewer-app
cd pdfviewer-app

Note: When prompted during project creation, select the default options: CSS for stylesheet, No for SSR/SSG, and None for AI tools. The available prompts may vary by Angular CLI version; accept the default values for any prompts not listed here.

Install the Syncfusion® Angular PDF Viewer package

Install the Syncfusion Angular PDF Viewer package from npm:

npm install @syncfusion/ej2-angular-pdfviewer --save

Import the required CSS styles

Themes for PDF Viewer can be applied using CSS or SASS files from the npm theme packages, CDN, CRG, or Theme Studio. For more information, see the themes documentation.

This guide uses the Tailwind 3 theme as an example, sourced from the theme package. In this package, each component includes an index.css file that automatically loads all the required dependency styles. To install the Tailwind 3 theme package, use the following command:

npm install @syncfusion/ej2-tailwind3-theme

Add the required PDF Viewer theme style reference to the src/styles.css file:

@import '../node_modules/@syncfusion/ej2-tailwind3-theme/styles/pdfviewer/index.css';

The index.css file automatically includes all required dependent component styles for the PDF Viewer. You do not need to import individual dependency styles such as Base, Buttons, Dropdowns, Inputs, Navigations, Popups, SplitButtons, and Notifications separately.

Note: Refer to the Themes topic to learn more about built-in themes and different ways to refer to themes in an Angular project.

Add the Syncfusion® Angular PDF Viewer component to the application

Add the PDF Viewer component to your Angular application to render and interact with PDF documents. The component requires the PdfViewerModule and its associated services (for full functionality).

Update src/app/app.ts as shown below:

import { Component } from '@angular/core';
import { PdfViewerModule, LinkAnnotationService, BookmarkViewService,
         MagnificationService, ThumbnailViewService, ToolbarService,
         NavigationService, TextSearchService, TextSelectionService,
         PrintService, FormDesignerService, FormFieldsService,
         AnnotationService, PageOrganizerService } from '@syncfusion/ej2-angular-pdfviewer';

@Component({
  selector: 'app-root',
  standalone: true,
  imports: [PdfViewerModule],
  providers: [ LinkAnnotationService, BookmarkViewService, MagnificationService,
               ThumbnailViewService, ToolbarService, NavigationService,
               TextSearchService, TextSelectionService, PrintService,
               FormDesignerService, FormFieldsService, AnnotationService, PageOrganizerService],
  template: `
    <ejs-pdfviewer
      id="pdfViewer"
      [documentPath]="documentPath"
      [resourceUrl]="resourcesUrl"
      style="height:640px; display:block">
    </ejs-pdfviewer>
  `
})
export class App {
  public documentPath: string =
    'https://cdn.syncfusion.com/content/pdf/pdf-succinctly.pdf';
  public resourcesUrl: string =
    'https://cdn.syncfusion.com/ej2/31.2.2/dist/ej2-pdfviewer-lib';
}

The documentPath property sets the PDF file path to be loaded. You can provide a remote URL, Base64 string, or local file path (e.g., 'assets/sample.pdf') and the resourceUrl property specifies the PDFium library resources path required for PDF rendering. This example uses CDN-hosted resources. For local resources, refer to Load PDF Viewer with Local Resources.

Run the application

Run the following command to start the Angular application:

ng serve --open

After the application starts, open http://localhost (the default dev server URL) in the browser to view the Angular PDF Viewer component. The output will appear as follows:

Rendered PDF Viewer in browser

View Sample in GitHub

Video tutorial

If you prefer a video walkthrough, watch the following tutorial to get started quickly with the Angular PDF Viewer.

Angular version compatibility

For detailed compatibility information, refer to the Angular version support matrix.

Older versions

For older Angular versions, refer to the following guides:

Looking for the full Angular PDF Viewer component overview, features, pricing, and documentation? Visit the Angular PDF Viewer page.

See also