> For the complete documentation index, see [llms.txt](https://docs.apryse.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.apryse.com/web/get-started/libraries-and-frameworks/svelte.md). # Build a Svelte PDF viewer with Apryse WebViewer SDK Create a Svelte PDF viewer and editor with Apryse WebViewer. Learn how to integrate the SDK into your Svelte apps and render PDFs in the viewer UI. This guide shows how to build a Svelte PDF viewer using the Apryse [WebViewer SDK](/web/what-is-webviewer/overview.md). You'll learn how to integrate the SDK into a [Svelte](https://svelte.dev/docs/kit/introduction) application to render, view, and interact with PDF documents using the WebViewer UI. You can also download a ready-to-use [GitHub sample](https://github.com/ApryseSDK/webviewer-samples/tree/main/webviewer-svelte) to get started quickly, or explore the interactive [Showcase demo](https://showcase.apryse.com/) to see WebViewer's full capabilities in action. ## Prerequisites This guide assumes basic familiarity with Svelte development. Before you start: * Install [Node.js](https://nodejs.org/en/download) and npm. See the [Svelte documentation](https://svelte.dev/docs/kit/migrating-to-sveltekit-2#Updated-dependency-requirements) for version details. * Install [Visual Studio Code](https://code.visualstudio.com/Download) or another code editor to develop and debug your code. * Get your Apryse trial key. {% @apryse-license-key/apryse-license-key platform="WEB\_VIEWER" variant="full" %} ## 1. Create a Svelte project In this section, you’ll create a new Svelte application using npm. This project provides the foundation for integrating Apryse WebViewer. If you already have a Svelte app, skip this and continue to [Install WebViewer](#2-install-webviewer). 1. In your terminal, go to the directory where you want to create the project. 2. Create a new `webviewer-svelte` project using a minimal setup: {% tabs %} {% tab title="Shell" %} {% code lineNumbers="true" %} ```shell npx --yes sv create webviewer-svelte --template minimal --no-types --no-add-ons --install npm ``` {% endcode %} {% endtab %} {% endtabs %} {% hint style="info" %} **Info** Flags are used to skip prompts during project configuration. The setup uses a SvelteKit minimal template, excludes type checking, omits project add-ons, and defaults to npm as the package manager. Select different options if preferred. {% endhint %} 3. Navigate to your new Svelte project directory and install dependencies: {% tabs %} {% tab title="Shell" %} {% code lineNumbers="true" %} ```shell cd webviewer-svelte npm install ``` {% endcode %} {% endtab %} {% endtabs %} ## 2. Install WebViewer Next, install the Apryse WebViewer SDK using npm. This command adds the [WebViewer package](https://www.npmjs.com/package/@pdftron/webviewer) to your project, allowing you to integrate the PDF viewer and editor into your Svelte application. After navigating to your `webviewer-svelte` project directory, run the following command to install WebViewer: {% tabs %} {% tab title="Shell" %} {% code lineNumbers="true" %} ```shell npm i @pdftron/webviewer ``` {% endcode %} {% endtab %} {% endtabs %} ## 3. Copy WebViewer assets WebViewer needs access to its static assets at runtime, including WebAssembly modules, HTML, and CSS files. In a Svelte project, you must copy these assets into the `static` directory so they can be served correctly. For more, see [Copying WebViewer static assets](/web/get-started/copy-assets.md). 1. From your project root, create the `static/lib/webviewer` directory if it doesn't already exist: {% tabs %} {% tab title="Shell" %} {% code lineNumbers="true" %} ```shell npx --yes shx mkdir -p static/lib/webviewer ``` {% endcode %} {% endtab %} {% endtabs %} 2. Copy all WebViewer static assets from `node_modules/@pdftron/webviewer/public` into the new `static/lib/webviewer` directory: {% tabs %} {% tab title="Shell" %} {% code lineNumbers="true" %} ```shell npx --yes cpy-cli "node_modules/@pdftron/webviewer/public/**/*" static/lib/webviewer ``` {% endcode %} {% endtab %} {% endtabs %} Your project should now include a similar structure: {% code lineNumbers="true" %} ``` webviewer-svelte/ ├── .svelte-kit/ ├── .vscode/ ├── node_modules/ ├── src/ ├── static/ │ ├── lib/ │ │ └── webviewer/ │ │ ├── core/ │ │ └── ui/ │ └── robots.txt └── .gitignore └── ... ``` {% endcode %} {% hint style="info" %} **Info** The `path` option used when initializing WebViewer must point to this directory (for example, `/lib/webviewer`). If the path is incorrect, WebViewer will fail to load. {% endhint %} ## 4. Create the PDF viewer In this section, you'll add WebViewer to your Svelte app by creating a component and initializing the viewer. This mounts the WebViewer UI and loads a document in your application. 1. Create a `WebViewer.svelte` file in the `src` folder of your project: {% tabs %} {% tab title="Shell" %} {% code lineNumbers="true" %} ```shell npx --yes shx touch src/WebViewer.svelte ``` {% endcode %} {% endtab %} {% endtabs %} 2. In Visual Studio Code, add this code to the `WebViewer.svelte` file and save: 
<script>
  import { onMount } from 'svelte';
  
  // Reference DOM element that will host WebViewer
  let viewer;

  // Run WebViewer setup once component is mounted in DOM
  onMount(() => {
    // Load WebViewer dynamically to avoid build/SSR issues
	  import("@pdftron/webviewer").then(({default: WebViewer}) => {

      // Initialize WebViewer instance
      WebViewer({
        // Path to WebViewer library assets
        path: '/lib/webviewer',
        // Replace with your Apryse license key
        licenseKey: 'visitor.claims.wvKey || "YOUR_LICENSE_KEY"',
        // Initial document to load into viewer
        initialDoc: 'https://apryse.s3.amazonaws.com/public/files/samples/WebviewerDemoDoc.pdf',
        }, viewer,
      ).then((instance) => {
	        // WebViewer APIs are available via the instance
	    });
	  });
  });
</script>

<style>
#viewer {
  /* Fill viewport with the viewer */
  width: 100%;
  height: 100vh;
  margin: 0 auto;
}
</style>

<!-- Container element bound to viewer variable -->
<div id="viewer" bind:this={viewer}></div>
{% hint style="info" %} **Info** * If you're signed in with an Apryse account, your license key is automatically prepopulated in all code snippets. * SvelteKit manages its Vite version internally. Recent versions use Vite 8, which requires a small configuration change when using WebViewer. For more, see [Using WebViewer with Vite 8](https://apryse.com/blog/webviewer-vite-8-fix). * In this example, WebViewer is imported dynamically to avoid running it during server‑side rendering. If your app doesn't use server‑side rendering, you can import WebViewer statically at the top of the file instead. {% endhint %} 3. Replace the contents of the `src/routes/+page.svelte` file with the following and save: {% tabs %} {% tab title="Svelte" %} {% code title="src/routes/+page.svelte" lineNumbers="true" %} ```svelte ``` {% endcode %} {% endtab %} {% endtabs %} ## 5. Verify your output You can now load and display a PDF document in the WebViewer UI. Run your Svelte application to launch WebViewer and see the PDF in your browser. 1. From your project directory, run the following command to start the application: {% tabs %} {% tab title="Shell" %} {% code lineNumbers="true" %} ```shell npm run dev ``` {% endcode %} {% endtab %} {% endtabs %} A successful output looks similar to: {% tabs %} {% tab title="Shell" %} {% code lineNumbers="true" %} ```shell > webviewer-svelte@0.0.1 dev > vite dev 11:31:01 AM [vite] (client) Forced re-optimization of dependencies VITE v8.0.16 ready in 740 ms ➜ Local: http://localhost:5173/ ➜ Network: use --host to expose ➜ press h + enter to show help ``` {% endcode %} {% endtab %} {% endtabs %} 2. Open the localhost URL from your terminal to view the WebViewer UI and PDF document. ## Get started video In this 4-minute video, learn how to install and integrate the Apryse WebViewer SDK into a Svelte project using TypeScript. You’ll set up the PDF viewer and explore the [DOCX Editor](/web/docx-editor/docx-editor.md). {% embed url="" %} Integrate WebViewer in a Svelte project with PDF editing and DOCX Editor. {% endembed %} ## Next steps UsageGuidesSamplesAPI docs --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.apryse.com/web/get-started/libraries-and-frameworks/svelte.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.