Resource Base
Table of contents

Adding the dependency

To use the SDK, we need to include the package below.

  • dynamsoft-document-viewer: Required, it provides functions to create the viewers.

It has several plugins that we can load on demand. Check Plugins and On-Demand Loading to learn more.

Use a CDN

The simplest way to include the SDK is to use either the jsDelivr or UNPKG CDN.

  • jsDelivr

    <script src="https://cdn.jsdelivr.net/npm/dynamsoft-document-viewer@latest/dist/ddv.js"></script>
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/dynamsoft-document-viewer@latest/dist/ddv.css">
    

    With plugins:

    <script src="https://cdn.jsdelivr.net/npm/dynamsoft-document-viewer@latest/dist/plugins/ddv-plugin-camera.js"></script>
    <script src="https://cdn.jsdelivr.net/npm/dynamsoft-document-viewer@latest/dist/plugins/ddv-plugin-annotation.js"></script>
    <script src="https://cdn.jsdelivr.net/npm/dynamsoft-document-viewer@latest/dist/plugins/ddv-plugin-image-pdf.js"></script>
    
  • UNPKG

    <script src="https://unpkg.com/dynamsoft-document-viewer@latest/dist/ddv.js"></script>
    <link rel="stylesheet" href="https://unpkg.com/dynamsoft-document-viewer@latest/dist/ddv.css">
    

    With plugins:

    <script src="https://unpkg.com/dynamsoft-document-viewer@latest/dist/plugins/ddv-plugin-camera.js"></script>
    <script src="https://unpkg.com/dynamsoft-document-viewer@latest/dist/plugins/ddv-plugin-annotation.js"></script>
    <script src="https://unpkg.com/dynamsoft-document-viewer@latest/dist/plugins/ddv-plugin-image-pdf.js"></script>
    

Host the SDK yourself

Besides using the CDN, you can also download the Solution and host related files on your own website/server before including it in your application.

Options to download the SDK:

Depending on how you downloaded the SDK and where you put it, you can typically include it like this:

  <!-- Upon extracting the zip package into your project, you can generally include it in the following manner -->
  <script src="./Your-Folder/dist/ddv.js"></script>
  <link rel="stylesheet" href="./Your-Folder/dist/ddv.css">

With plugins:

  <script src="./Your-Folder/dist/plugins/ddv-plugin-camera.js"></script>
  <script src="./Your-Folder/dist/plugins/ddv-plugin-annotation.js"></script>
  <script src="./Your-Folder/dist/plugins/ddv-plugin-image-pdf.js"></script>

or

  <script src="./node_modules/dynamsoft-document-viewer/dist/ddv.js"></script>
  <link rel="stylesheet" href="./node_modules/dynamsoft-document-viewer/dist/ddv.css">

With plugins:

  <script src="./node_modules/dynamsoft-document-viewer/dist/plugins/ddv-plugin-camera.js"></script>
  <script src="../node_modules/dynamsoft-document-viewer/dist/plugins/ddv-plugin-annotation.js"></script>
  <script src="./node_modules/dynamsoft-document-viewer/dist/plugins/ddv-plugin-image-pdf.js"></script>

or

  import { DDV } from 'dynamsoft-document-viewer';
  import "dynamsoft-document-viewer/dist/ddv.css";

With plugins:

  import { CameraPlugin } from 'dynamsoft-document-viewer/camera';
  import { AnnotationPlugin } from 'dynamsoft-document-viewer/annotation';
  import { ImagePdfParserPlugin } from 'dynamsoft-document-viewer/imagePdf';

Use Plugins

To actually use the plugins, you also need to run the following JavaScript code:

Dynamsoft.DDV.use(Dynamsoft.DDV.AnnotationPlugin);
Dynamsoft.DDV.use(Dynamsoft.DDV.CameraPlugin);
Dynamsoft.DDV.use(Dynamsoft.DDV.ImagePdfParserPlugin);

This page is compatible for: