Forked by Cantoo

This fork adds the support for svg to the pdf-lib project. Until pdf-lib project gets a better maintainance, we will maintain this project as long as we need it but cannot guarantee the support for issues too far from our own roadmap.

Install with: npm install @cantoo/pdf-lib

> 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
- Extract Attachments
- Set Document Metadata
- Read Document Metadata
- Set Viewer Preferences
- Read Viewer Preferences
- Draw SVG Paths
- Draw SVG
- 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
- Extract 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

$3

_This example produces this PDF._

Try the JSFiddle demo

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

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

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

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

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

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

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

// For example, pdfBytes can be:
// • Written to a file in Node
// • Downloaded from the browser
// • Rendered in an