---
title: "Vue PDF SDK — add PDF viewing and editing to Vue apps"
canonical_url: "https://www.nutrient.io/sdk/web/getting-started/other-frameworks/vue/"
md_url: "https://www.nutrient.io/sdk/web/getting-started/other-frameworks/vue.md"
last_updated: "2026-06-08T09:14:14.525Z"
description: "Learn how to integrate Nutrient Web SDK into your Vue application. Step-by-step guide for adding PDF viewing, editing, and annotation features."
---

# Add PDF viewing and editing to Vue applications

Nutrient Web SDK is a JavaScript PDF library for viewing, annotating, and editing PDFs directly in the browser. Use it to add PDF capabilities to any web app.

This guide walks you through the steps to integrate Nutrient Web SDK into your project. By the end, you’ll be able to render a PDF document in the user interface (UI).

**Test without installing**

You can test the SDK capabilities in our playground.

[Read more](https://nutrient.io/demo/sandbox/)

**View example**

Prefer to jump straight into code? View the example repo on GitHub.

[Read more](https://github.com/PSPDFKit/nutrient-web-examples/tree/main/examples/vue-composition-api)

## Installation

You can load Nutrient Web SDK directly from Nutrient’s content delivery network (CDN). Nutrient maintains the CDN for customers, and it’s our recommended way to get started. For more control and flexibility, use the local installation option.

#### Note: Creating a new project (optional)

If you don’t yet have a Vue project set up, create one with Vite:

```sh

pnpm create vite nutrient-vue-example --template vue

```

### CDN installation

**Steps:**

1. Add the following in your `index.html` file:

   ```html <!-- Lines inserted: [12] -->

   // index.html
   <!DOCTYPE html>
   <html lang="">
     <head>
       <meta charset="UTF-8" />
       <link rel="icon" href="/favicon.ico" />
       <meta name="viewport" content="width=device-width, initial-scale=1.0" />
       <title>Vite App</title>
     </head>
     <body>
       <div id="app"></div>
       <script src="https://cdn.cloud.nutrient.io/pspdfkit-web@1.16.1/nutrient-viewer.js"></script>
       <script type="module" src="/src/main.ts"></script>
     </body>
   </html>
   ```

2. You’re now ready to use Nutrient Web SDK and reference `window.NutrientViewer` in the client-side code.

### Install via package manager

**Steps:**

1. Add the Nutrient Web SDK (`@nutrient-sdk/viewer`) dependency:

   ```bash

   npm install @nutrient-sdk/viewer
   # or

   yarn add @nutrient-sdk/viewer
   # or

   pnpm install @nutrient-sdk/viewer
   ```

2. If you tried CDN installation first, make sure to remove the script tag:

   ```html <!-- Lines deleted: [2] -->

   <!-- index.html -->

   <script src="https://cdn.cloud.nutrient.io/pspdfkit-web@1.16.1/nutrient-viewer.js"></script>
   <div id="app"></div>
   ```

3. You’re now ready to use Nutrient Web SDK locally in your Vue + Vite app.

## Rendering a PDF

### CDN installation

**Steps:**

1. Load the PDF file in `App.vue`:

   ```vue

   // App.vue
   <script setup lang="ts">
   import { onMounted, onUnmounted, useTemplateRef } from "vue";

   const containerRef = useTemplateRef("container");
   const { NutrientViewer } = window;

   onMounted(() => {
     const container = containerRef.value;

     if (container && NutrientViewer) {
       NutrientViewer.load({
         container,
         document: "https://www.nutrient.io/downloads/nutrient-web-demo.pdf",
       });
     }
   });

   onUnmounted(() => {
     const container = containerRef.value;

     if (container && NutrientViewer) {
       NutrientViewer.unload(container);
     }
   });
   </script>

   <template>
     <div ref="container" class="container" />
   </template>

   <style scoped>
   /* we also need to set the container height and width */.container {
     width: 100vw;
     height: 100vh;
   }
   </style>
   ```

2. Start the development server:

   ```bash

   npm run dev
   # or

   yarn dev
   # or

   pnpm dev
   ```

3. You’ll see the PDF rendered in the Nutrient Web SDK user interface (UI).

### Install via package manager

**Steps:**

1. With package manager installation, access the Nutrient Web SDK module directly. Update your `App.vue` to load the PDF file as shown below:

   ```vue

   // App.vue
   <script setup lang="ts">
   import { onMounted, onUnmounted, useTemplateRef } from "vue";

   const containerRef = useTemplateRef("container");
   let NutrientViewer:
     | typeof import("@nutrient-sdk/viewer").default
     | undefined;

   onMounted(async () => {
     NutrientViewer = (await import("@nutrient-sdk/viewer")).default;
     const container = containerRef.value;

     if (container && NutrientViewer) {
       NutrientViewer.load({
         container,
         document: "https://www.nutrient.io/downloads/nutrient-web-demo.pdf",
         useCDN: true,
       });
     }
   });

   onUnmounted(() => {
     const container = containerRef.value;

     if (container && NutrientViewer) {
       NutrientViewer.unload(container);
     }
   });
   </script>

   <template>
     <div ref="container" class="container" />
   </template>

   <style scoped>
   /* we also need to set the container height and width */.container {
     width: 100vw;
     height: 100vh;
   }
   </style>
   ```

   > **Note:** Adding `useCDN: true` will load the SDK assets from the CDN if `baseUrl` isn’t provided. This flag was introduced in version 1.9.0. If your setup relies on the previous behavior of autodetecting the assets without `baseUrl`, you can omit this flag for now, but be aware that this behavior is deprecated. In future versions, loading from CDN will become a default when `baseUrl` isn’t explicitly provided. `useCDN: true` has no effect if `baseUrl` is set.

   **Optional**: If you decide to self-host the Nutrient Web SDK assets as [described in this guide](https://www.nutrient.io/guides/web/self-host-assets.md), make sure to provide a `baseUrl` in your configuration, as shown below:

   ```vue

   NutrientViewer.load({ container, useCDN: true, document:
   "https://www.nutrient.io/downloads/nutrient-web-demo.pdf", baseUrl:
   `${window.location.protocol}//${window.location.host}/${
   import.meta.env.PUBLIC_URL?? "" // Usually empty for Vite, but supports
   custom deployments. }`, });
   ```

2. Start the development server:

   ```bash

   npm run dev
   # or

   yarn dev
   # or

   pnpm dev
   ```

## Next steps

This section outlines additional steps for setting up your project.

### TypeScript with CDN installation

Nutrient Web SDK comes with built-in support for TypeScript. This should work out of the box for the package manager installation. For the CDN installation, follow the steps below.

**Steps:**

1. Add the Nutrient Web SDK dependency, if not done previously. You need the package installed locally to reference the types:

   ```bash

   npm install @nutrient-sdk/viewer
   # or

   yarn add @nutrient-sdk/viewer
   # or

   pnpm install @nutrient-sdk/viewer
   ```

2. Create a module for custom typings — for example, `global.d.ts` in the `src` directory — to reference the built-in typings for the SDK:

   ```ts

   // src/global.d.ts
   import NutrientViewer from "@nutrient-sdk/viewer";

   declare global {
     interface Window {
       // Nutrient Web SDK will be available on `window.NutrientViewer` once loaded.
       NutrientViewer?: typeof NutrientViewer;
     }
   }
   ```

3. Restart the TypeScript server or your editor, if needed.

### Optimizing the CDN installation

If you use the CDN installation approach in production, we recommend considering optimizations such as [prefetching](https://developer.mozilla.org/en-US/docs/Glossary/Prefetch).

### Optimizing load performance

If your app doesn't open a PDF immediately — for example, the user navigates to a viewer on a different page — call [`NutrientViewer.preloadWorker()`](https://www.nutrient.io/api/web/functions/NutrientViewer.preloadWorker.html) early in your app to fetch and compile the WebAssembly artifacts in the background. When `NutrientViewer.load()` runs later, it can start rendering without waiting for them.

```js

// Call early — for example, on app init or after login.
NutrientViewer.preloadWorker();

```

Refer to the [performance best practices](https://www.nutrient.io/guides/web/best-practices/performance.md) guide for more optimization techniques.




## Troubleshooting

If you encounter issues, refer to the [common issues](https://www.nutrient.io/guides/web/troubleshooting/common-issues.md) guide.

> **Note for developers using AI coding assistants**: To get accurate troubleshooting help, copy the content from the [troubleshooting](https://www.nutrient.io/guides/web/troubleshooting/common-issues.md) guide and include it in your prompt, along with your specific error.

**Test without installing**

You can test the SDK capabilities in our playground.

[Read more](https://nutrient.io/demo/sandbox/)

**View example**

Prefer to jump straight into code? View the example repo on GitHub.

[Read more](https://github.com/PSPDFKit/nutrient-web-examples/tree/main/examples/vue-composition-api)
---

## Related pages

- [Add PDF functionality with PHP](/sdk/web/getting-started/other-frameworks/php.md)
- [Add PDF functionality with JavaScript + Vite](/sdk/web/getting-started/other-frameworks/javascript.md)
- [Add PDF functionality with Flutter](/sdk/web/getting-started/other-frameworks/flutter.md)
- [Add PDF functionality with Nuxt](/sdk/web/getting-started/other-frameworks/nuxt.md)
- [Add PDF functionality with ASP.NET](/sdk/web/getting-started/other-frameworks/aspnet.md)
- [Add PDF functionality with Laravel](/sdk/web/getting-started/other-frameworks/laravel.md)
- [Add PDF functionality with PWA](/sdk/web/getting-started/other-frameworks/pwa.md)
- [Add PDF functionality with Svelte](/sdk/web/getting-started/other-frameworks/svelte.md)
- [Add PDF functionality with jQuery](/sdk/web/getting-started/other-frameworks/jquery.md)
- [Add PDF functionality with Electron](/sdk/web/getting-started/other-frameworks/electron.md)
- [Add PDF functionality with Blazor](/sdk/web/getting-started/other-frameworks/blazor.md)
- [Add PDF functionality with Angular](/sdk/web/getting-started/other-frameworks/angular.md)

