PDF-LIB

Create and modify PDF documents in any JavaScript environment

PDF
Hopding/pdf-libpdf-lib.js.orgpdf-lib

README

pdf-lib

Create and modify PDF documents in any JavaScript environment.
  Designed to work in any modern JavaScript runtime. Tested in Node, Browser, Deno, and React Native environments.
  
    <img
      src="https://img.shields.io/npm/v/pdf-lib.svg?style=flat-square"
      alt="NPM Version"
    />
  
    <img
      src="https://img.shields.io/circleci/project/github/Hopding/pdf-lib/master.svg?style=flat-square&label=CircleCI"
      alt="CircleCI Build Status"
    />
  
    <img
      src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square"
      alt="Prettier Badge"
    />
  
    <img
      src="https://img.shields.io/static/v1?label=discord&message=pdf-lib&color=566fbb&style=flat-square"
      alt="Discord Badge"
    />

Learn more at pdf-lib.js.org


Table of Contents


- Features
- Motivation
- Usage Examples
  - Create Document
  - Modify Document
  - Create Form
  - Fill Form
  - Flatten Form
  - Copy Pages
  - Embed PNG and JPEG Images
  - Embed PDF Pages
  - Embed Font and Measure Text
  - Add Attachments
  - Set Document Metadata
  - Read Document Metadata
  - Set Viewer Preferences
  - Read Viewer Preferences
  - Draw SVG Paths
- Deno Usage
- Complete Examples
- Installation
- Documentation
- Fonts and Unicode
- Creating and Filling Forms
- Limitations
- Help and Discussion
- Encryption Handling
- Migrating to v1.0.0
- Contributing
- Maintainership
- Tutorials and Cool Stuff
- Prior Art
- Git History Rewrite
- License

Features


- Create new PDFs
- Modify existing PDFs
- Create forms
- Fill forms
- Flatten forms
- Add Pages
- Insert Pages
- Remove Pages
- Copy pages between PDFs
- Draw Text
- Draw Images
- Draw PDF Pages
- Draw Vector Graphics
- Draw SVG Paths
- Measure width and height of text
- Embed Fonts (supports UTF-8 and UTF-16 character sets)
- Set document metadata
- Read document metadata
- Set viewer preferences
- Read viewer preferences
- Add attachments

Motivation


pdf-lib was created to address the JavaScript ecosystem's lack of robust support for PDF manipulation (especially for PDF _modification_).

Two of pdf-lib's distinguishing features are:

1. Supporting modification (editing) of existing documents.
2. Working in all JavaScript environments - not just in Node or the Browser.

There are other good open source JavaScript PDF libraries available. However, most of them can only _create_ documents, they cannot _modify_ existing ones. And many of them only work in particular environments.

Usage Examples


Create Document


_This example produces this PDF._

Try the JSFiddle demo


  1. ``` js
  2. import { PDFDocument, StandardFonts, rgb } from 'pdf-lib'

  4. // Create a new PDFDocument
  5. const pdfDoc = await PDFDocument.create()

  7. // Embed the Times Roman font
  8. const timesRomanFont = await pdfDoc.embedFont(StandardFonts.TimesRoman)

  10. // Add a blank page to the document
  11. const page = pdfDoc.addPage()

  13. // Get the width and height of the page
  14. const { width, height } = page.getSize()

  16. // Draw a string of text toward the top of the page
  17. const fontSize = 30
  18. page.drawText('Creating PDFs in JavaScript is awesome!', {
  19.   x: 50,
  20.   y: height - 4 * fontSize,
  21.   size: fontSize,
  22.   font: timesRomanFont,
  23.   color: rgb(0, 0.53, 0.71),
  24. })

  26. // Serialize the PDFDocument to bytes (a Uint8Array)
  27. const pdfBytes = await pdfDoc.save()

  29. // For example, `pdfBytes` can be:
  30. //   • Written to a file in Node
  31. //   • Downloaded from the browser
  32. //   • Rendered in an