# pardnio/pdf2image

> pdf2image is a JavaScript library by Pardn Chiu that converts PDF pages to PNG or WebP images in the browser with pdf.js, a progress overlay, and ZIP download.

Maintained by 邱敬幃 Pardn Chiu (pardnio), Pardn Co., Ltd. Source: https://github.com/pardnio/pdf2image

Full text in one file: [English](https://pdf2image.pardn.io/llms-full.txt) · [中文](https://pdf2image.pardn.io/zh/llms-full.txt)

## Overview

- [Home](https://pdf2image.pardn.io/index.md): pdf2image is a JavaScript library by Pardn Chiu that converts PDF pages to PNG or WebP images in the browser with pdf.js, a progress overlay, and ZIP download.
- [Getting Started](https://pdf2image.pardn.io/getting-started.md): Install pdf2image from npm or a CDN, pass a PDF ArrayBuffer, and convert your first PDF to images in the browser after the load event.

## Concepts

- [Core Concepts](https://pdf2image.pardn.io/core-concepts.md): What pdf2image injects into the page on load (pdf.js, JSZip, stylesheet), why convert() must wait for the load event, and its runtime limits.
- [Conversion](https://pdf2image.pardn.io/conversion.md): How pdf2image convert() renders PDF pages: scale and pixel size, why type jpg yields PNG, result order, single-use ArrayBuffer, and errors.
- [ZIP Download](https://pdf2image.pardn.io/zip-download.md): How pdf2image download() bundles images into a ZIP with JSZip: the flow, yyyy-MM-DD hh:mm filename tokens, output names, and failures.
- [Progress Overlay](https://pdf2image.pardn.io/progress-overlay.md): The pdf2image progress overlay: its DOM and data-percent attribute, conversion and compression progress, zh/en labels, and CSS.
- [Architecture](https://pdf2image.pardn.io/architecture.md): A one-diagram overview of pdf2image: load-time CDN injection, the pdf2image class, the progress overlay, and pdf.js and JSZip.

## Reference

- [Constructor Options](https://pdf2image.pardn.io/api-reference.md): Every pdf2image constructor option (file, filename, scale, type) with defaults and the normalization rules for invalid values.
- [Methods and Properties](https://pdf2image.pardn.io/api-reference-methods.md): The pdf2image instance API: convert(), download(), and the images getter, with resolve and reject values for each.

## Symbols

Exported symbol -> page that documents it.

- `pdf2image` (src): [Constructor Options](https://pdf2image.pardn.io/api-reference.md), [Core Concepts](https://pdf2image.pardn.io/core-concepts.md)

## 中文文件

- [首頁](https://pdf2image.pardn.io/zh/index.md): pdf2image 是邱敬幃開發的 JavaScript 套件，以 pdf.js 在瀏覽器將 PDF 轉成 PNG、WebP 圖片，附進度遮罩與 ZIP 下載。
- [快速開始](https://pdf2image.pardn.io/zh/getting-started.md): 從 npm 或 CDN 安裝 pdf2image，傳入 PDF 的 ArrayBuffer，在 load 事件後完成第一次 PDF 轉圖片。
- [核心概念](https://pdf2image.pardn.io/zh/core-concepts.md): pdf2image 載入時注入哪些相依（pdf.js、JSZip、樣式表）、convert() 為何要等 load 事件，以及執行環境限制。
- [轉換流程](https://pdf2image.pardn.io/zh/conversion.md): pdf2image convert() 的渲染流程：scale 與尺寸、jpg 為何輸出 PNG、結果順序、ArrayBuffer 單次使用與錯誤。
- [ZIP 下載](https://pdf2image.pardn.io/zh/zip-download.md): pdf2image download() 如何以 JSZip 打包 ZIP：流程、yyyy-MM-DD hh:mm 檔名記號、產出檔名與失敗行為。
- [進度遮罩](https://pdf2image.pardn.io/zh/progress-overlay.md): pdf2image 進度遮罩：DOM 與 data-percent、轉換與壓縮進度計算、中英文字切換與樣式。
- [架構](https://pdf2image.pardn.io/zh/architecture.md): 以一張圖概覽 pdf2image：載入時的 CDN 注入、pdf2image 類別、進度遮罩，以及 pdf.js 與 JSZip。
- [建構參數](https://pdf2image.pardn.io/zh/api-reference.md): pdf2image 建構參數 file、filename、scale、type 的預設值，以及無效值的正規化規則。
- [方法與屬性](https://pdf2image.pardn.io/zh/api-reference-methods.md): pdf2image 實例 API：convert()、download() 與 images getter，以及各自的 resolve 與 reject 值。

## Optional

- [Release Notes](https://pdf2image.pardn.io/released/index.md): pardnio/pdf2image changelog by version