Vue PDF Viewer Component

The Vue PDF Viewer component enables you to view, annotate, prepare and fill forms, and print PDF files from your web applications.

Setup

Create a Vue Application

You can use Vue CLI to setup your Vue 2 applications.To install Vue CLI use the following commands.

npm install -g @vue/cli
npm install -g @vue/cli-init
vue init webpack-simple quickstart
cd quickstart
npm install

Initiating a new project prompts us to choose the type of project to be used for the current application. Select the option Default ([Vue 2] babel, eslint) from the menu.

Adding Syncfusion PDF Viewer package

All Syncfusion Vue packages are published in npmjs.com registry. To install Vue PDF Viewer package, use the following command.

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

Registering PDF Viewer component

You can register the PDF Viewer component in your application by using the Vue.use(). Refer to the code example given below.

import { PdfViewerPlugin } from '@syncfusion/ej2-vue-pdfviewer';

Vue.use(PdfViewerPlugin);

Registering PdfViewerPlugin in Vue, will register the PDF Viewer component along with its required child directives globally.

Adding CSS references for PDF Viewer

Add CSS references needed for PDF Viewer in style section of the App.vue file from ../node_modules/@syncfusion package folder.

<style>
@import '../node_modules/@syncfusion/ej2-base/styles/material.css';
@import '../node_modules/@syncfusion/ej2-buttons/styles/material.css';
@import '../node_modules/@syncfusion/ej2-inputs/styles/material.css';
@import '../node_modules/@syncfusion/ej2-popups/styles/material.css';
@import '../node_modules/@syncfusion/ej2-lists/styles/material.css';
@import '../node_modules/@syncfusion/ej2-navigations/styles/material.css';
@import '../node_modules/@syncfusion/ej2-dropdowns/styles/material.css';
@import '../node_modules/@syncfusion/ej2-splitbuttons/styles/material.css';
@import '../node_modules/@syncfusion/ej2-notifications/styles/material.css';  
@import "../node_modules/@syncfusion/ej2-vue-pdfviewer/styles/material.css";
</style>

Add PDF Viewer component

Add the Vue PDF Viewer by using ejs-pdfviewer selector in template section of the App.vue file.

<template>
  <div id="app">
<ejs-pdfviewer id="pdfViewer" :serviceUrl="serviceUrl" :documentPath="documentPath"> </ejs-pdfviewer>
  </div>
</template>

<script>
import Vue from 'vue';
import { PdfViewerPlugin, Toolbar, Magnification, Navigation, LinkAnnotation, BookmarkView, ThumbnailView, Print, TextSelection, TextSearch, Annotation, FormFields, FormDesigner } from '@syncfusion/ej2-vue-pdfviewer';
Vue.use(PdfViewerPlugin);
export default {
  name: 'app',
  data () {
return {
  serviceUrl:"https://ej2services.syncfusion.com/production/web-services/api/pdfviewer",
  documentPath:"PDF_Succinctly.pdf"
};
  },
  provide: {
PdfViewer: [Toolbar, Magnification, Navigation, LinkAnnotation, BookmarkView, ThumbnailView, Print, TextSelection, TextSearch, Annotation, FormFields, FormDesigner]
  }
}
</script>

Refer the Getting Started with Vue3 for using Syncfusion Vue components in Vue 3 applications.

Supported frameworks

PDF Viewer component is also offered in the following list of frameworks.

|      JavaScript     |        Angular       |        Vue          |   ASP.NET Core   |   ASP.NET MVC   | | :-----: | :-----: | :-----: | :-----: | :-----: |

Key features

• View PDF Document - Open and display both the normal and the protected PDF files with AES and RC4 encryption.
• Annotations - Annotate with text markup, shapes, stamps, ink, and sticky notes.
• Form Fields - Form filling and form designing can be done.
• Signature - Hand-written and digital signatures are allowed.
• Toolbar - Built-in-toolbar and custom toolbars to perform user interaction of PDF Viewer functionalities.
• Navigation - Easy navigation with the help of bookmarks, thumbnails, hyperlinks, and table of contents.
• Magnification - Fit to page, fit to width, and automatic (fits to the visible area).
• Search - Search a text easily across the PDF document.
• Core Interactions - Allows scrolling, zooming, panning, selection, and page navigation.
• Print - Print the entire document or a specific page directly from the browser.
• Globalization - Provides inherent support to localize the UI.

Support

Product support is available through the following mediums.

• Support ticket - Guaranteed Response in 24 hours | Unlimited tickets | Holiday support
• Community forum
• GitHub issues
• Request feature or report bug
• Live chat

Changelog

Check the changelog here. Get minor improvements and bug fixes every week to stay up to date with frequent updates.

License and copyright

This is a commercial product and requires a paid license for possession or use. Syncfusion’s licensed software, including this component, is subject to the terms and conditions of Syncfusion's EULA. To acquire a license for 80+ Vue UI components, you can purchase or start a free 30-day trial.

A free community license is also available for companies and individuals whose organizations have less than $1 million USD in annual gross revenue and five or fewer developers.

See LICENSE FILE for more info.

© Copyright 2024 Syncfusion, Inc. All Rights Reserved. The Syncfusion Essential Studio license and copyright applies to this distribution.