Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vue-pdf-viewer/vue-pdf-viewer

Vue PDF Viewer – Flexible and Powerful Vue.js PDF Component to display PDF smoothly on a Vue.js website
https://github.com/vue-pdf-viewer/vue-pdf-viewer

javascript nuxt nuxt3 nuxtjs pdf pdf-viewer typescript vue vue-pdf vue-pdf-viewer vue3 vuejs

Last synced: 3 months ago
JSON representation

Vue PDF Viewer – Flexible and Powerful Vue.js PDF Component to display PDF smoothly on a Vue.js website

Host: GitHub
URL: https://github.com/vue-pdf-viewer/vue-pdf-viewer
Owner: vue-pdf-viewer
Created: 2024-06-27T07:36:01.000Z (6 months ago)
Default Branch: main
Last Pushed: 2024-08-31T03:41:30.000Z (4 months ago)
Last Synced: 2024-09-22T18:02:18.723Z (3 months ago)
Topics: javascript, nuxt, nuxt3, nuxtjs, pdf, pdf-viewer, typescript, vue, vue-pdf, vue-pdf-viewer, vue3, vuejs
Language: CSS
Homepage: https://www.vue-pdf-viewer.dev/
Size: 602 KB
Stars: 12
Watchers: 1
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- Security: SECURITY.md

Awesome Lists containing this project

README

        


  

    

      

      

    

  



PDF Viewer for Vue 3




  Works seamlessly on your Vue or Nuxt websites. Customizable themes, built-in localizations and accessibility support.

  






  

  [Vue PDF Viewer Home][vuepdfviewer] - [License](#page_facing_up-license) - [Documentation][vuepdfviewer-docs]

  

  Available for: Vue.js (3.0^), Nuxt (3.0^)

[![NPM Version](https://img.shields.io/npm/v/%40vue-pdf-viewer%2Fviewer)][npm]

[![Twitter](https://img.shields.io/twitter/follow/VuePDF?label=VuePDF&style=social)][twitter]



# :book: Table of Contents

1. [Why Vue PDF Viewer](#star-why-vue-pdf-viewer)

2. [Features](#sparkles-features)

3. [Documentation](#bookmark_tabs-documentation)

4. [Starter Toolkit](#pushpin-starter-toolkit)

5. [Need Help?](#raising_hand-need-help)

6. [License](#page_facing_up-license)

7. [Acknowledgement](#acknowledgement)

# :star: Why Vue PDF Viewer

As developers ourselves, we faced many issues such as browser incompatibility and customizability while working with PDF libraries. Vue PDF Viewer (VPV) is created to solve these issues, and be flexible and simple to use for Vue.js developers. More importantly, we also built our technical documentation to be detailed and easy to follow along.

# :sparkles: Features

  

    
1. Interactive & immersive experience


    2. Responsive display for different devices


  

  

    3. Customizable to your website's style


    4. Navigate across document easily


  

Check out the full list of Vue PDF Viewer features [over here](https://www.vue-pdf-viewer.dev/features)

# :bookmark_tabs: Documentation

To explore VPV's technical information such as basic usage or component API, please feel free to explore [Docs][vuepdfviewer-docs].

## :pushpin: Starter Toolkit

Here are some sample projects to get started on Vue PDF Viewer quickly:

1. [Vue – Composition API - TypeScript](https://github.com/vue-pdf-viewer/starter-vpv-composition-ts) 

2. [Vue – Options API - TypeScript](https://github.com/vue-pdf-viewer/starter-vpv-options-ts)

3. [Vue – Composition API - JavaScript](https://github.com/vue-pdf-viewer/starter-vpv-composition-js)

4. [Vue – Options API - JavaScript](https://github.com/vue-pdf-viewer/starter-vpv-options-js)

5. [Vue – SSR - TypeScript](https://github.com/vue-pdf-viewer/starter-vpv-ssr-vue-ts)

6. [Nuxt - TypeScript](https://github.com/vue-pdf-viewer/starter-vpv-nuxt-ts)

7. [VitePress](https://github.com/vue-pdf-viewer/starter-vpv-vitepress)

8. [Quasar](https://github.com/vue-pdf-viewer/starter-vpv-quasar)

# :raising_hand: Need Help?

We are more than happy to help you. If you have any questions, run into any errors or face any problems, please feel free to create an issue in [Issues](../../issues) or PM us directly in [Twitter][twitter]. Anything related to VPV is on the table!

# :page_facing_up: License

Vue PDF Viewer is distributed under our proprietary license. Please refer to our [License page](https://www.vue-pdf-viewer.dev/license-agreement) file for more details.

If you would like to use Vue PDF Viewer commercially, please purchase a license from [our website][vuepdfviewer] or reach out to us directly at [[email protected]](mailto:[email protected]).

# Acknowledgement

- [pdf.js](https://github.com/mozilla/pdf.js)

- [Img Shields](https://shields.io)

- [Vue.js](https://vuejs.org/)

[twitter]: https://x.com/VuePDF

[vuepdfviewer]: https://www.vue-pdf-viewer.dev

[vuepdfviewer-docs]: https://docs.vue-pdf-viewer.dev

[npm]: https://www.npmjs.com/package/@vue-pdf-viewer/viewer