@livelybone/easy-pdf

An easy-to-use PDF rendering library in browser, can be used as a solution to customize the display of PDF in App. Based on mozilla/pdf.js, the js/css is loaded via CDN asynchronously. 一个简便易用的,原生使用方式的(适用于各大框架)网页端 PDF 渲染插件,也可作为小程序/App webview 中自定义展示 pdf 的解


Keywords
pdfjs, easy to use, cdn, browser, pdf
License
MIT
Install
npm install @livelybone/easy-pdf@1.0.6

Documentation

@livelybone/easy-pdf

NPM Version Download Month gzip with dependencies: 2kb typescript pkg.module

pkg.module supported, which means that you can apply tree-shaking in you project

中文文档

An easy to use web side PDF rendering plug-in, can be used as a solution to customize the display of PDF in WeChat-applet/App. Based on mozilla/pdf.js, the js/css is loaded via CDN asynchronously

repository

https://github.com/livelybone/easy-pdf.git

Demo

https://github.com/livelybone/easy-pdf#readme

Run Example

Your can see the usage by run the example of the module, here is the step:

  1. Clone the library git clone https://github.com/livelybone/easy-pdf.git
  2. Go to the directory cd your-module-directory
  3. Install npm dependencies npm i(use taobao registry: npm i --registry=http://registry.npm.taobao.org)
  4. Open service npm run dev
  5. See the example(usually is http://127.0.0.1:3000/examples/test.html) in your browser

Installation

npm i -S @livelybone/easy-pdf

Global name - The variable the module exported in umd bundle

EasyPDF

Interface

See what method or params you can use in index.d.ts

Usage

import * as EasyPDF from '@livelybone/easy-pdf'

const container = document.getElementById('container')
/** Render all page */
EasyPDF.renderPdf('./sample.pdf', { container }).then(res => {
  console.log(res)
})

/** Render single page */
EasyPDF.readPdf('./sample.pdf').then(pdf => {
  EasyPDF.renderPdfPage(pdf, 1, { container }).then(res => {
    console.log(res)
  })
})

Use in html, see what your can use in CDN: unpkg

<-- use what you want -->
<script src="https://unpkg.com/@livelybone/easy-pdf/lib/umd/<--module-->.js"></script>