Repository files navigation

Welcome to the Vue PDF Viewer starter toolkit! This repository demonstrates how to integrate Vue PDF Viewer within an Electron application built on Vue 3 using JavaScript.

• Usage
  • Project Setup
  • Running the Example Project
  • Using the Vue PDF Viewer Component
• Documentation
• Meta

1. Clone the Repository

   git clone https://github.com/vue-pdf-viewer/starter-vpv-electron-vue-js.gitcd starter-vpv-electron-vue-js

2. Install Dependencies

   Install the required dependencies using your preferred package manager:

   npm install# oryarn install# orpnpm install# orbun install

   Remark: Forpnpm, there is a bit more configuration required which can be foundhere.

This project includes a fully functional Electron + Vue 3 example showcasing Vue PDF Viewer:

1. Start the Development Server

   npm run dev

2. View the App

   The Electron window will launch automatically. You can also open the app in your browser athttp://localhost:3000.

Within the Vue 3 app, Vue PDF Viewer is integrated as a Vue component with JavaScript support. To use it:

1. Import the Component

   Example in a page or component:

   <scriptsetup>  import{VPdfViewer} from '@vue-pdf-viewer/viewer';</script>

2. Add to Template

   <template>  <VPdfViewer:src="src" /></template>

For more examples, please refer to thesrc/App.vue file in this repository:

• Default Toolbar
• Without Toolbar
• Mobile View

Remark: If you would like more examples, feel free to open an issue.

For more configurations, please check thedocumentation site.

• Homepage:https://www.vue-pdf-viewer.dev
• Docs:https://docs.vue-pdf-viewer.dev

Thank you for using Vue PDF Viewer with Electron and Vue 3! If you have any questions or run into issues, please open an issue in this repository. Happy coding!