@registered/pdf-lib
v1.19.0TypeScript
Create and modify PDF files with JavaScript
0/weekUpdated 11 months agoMITUnpacked: 18.3 MB
Published by Andrew Dillon
npm install @registered/pdf-lib@pdfme/pdf-lib
This version is forked from Hopding/pdf-lib.
Incorporated several bug fixes and additional features into the original code.
2023/12/22 - Incorporate @cantoo/pdf-lib Refactor drawSvg PR
PR: Refactor drawSvg to handle transfomations as matrix and to crop elements #42
To achieve Add SVG Schema #29 feature, pull the @cantoo/pdf-lib into this repo.
@pdfme/pdf-lib compatible with foliojs/fontkit v2
``js
import { PDFDocument, rgb } from 'pdf-lib'
import fontkit from 'fontkit' // <- Do not use @pdf-lib/fontkit
// This should be a Uint8Array or ArrayBuffer
// This data can be obtained in a number of different ways
// If you're running in a Node environment, you could use fs.readFile()
// In the browser, you could make a fetch() call and use res.arrayBuffer()
const fontBytes = ...
// Create a new PDFDocument
const pdfDoc = await PDFDocument.create()
// Register the fontkit instance`
pdfDoc.registerFontkit(fontkit)
---
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.
alt="NPM Version"
/>
alt="CircleCI Build Status"
/>
alt="Prettier Badge"
/>
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
$3
_This example produces this PDF._
`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