Table of Contents

Features

Motivation

Usage Examples

Create Document

import{PDFDocument,StandardFonts,rgb}from'pdf-lib'// Create a new PDFDocumentconstpdfDoc=awaitPDFDocument.create()// Embed the Times Roman fontconsttimesRomanFont=awaitpdfDoc.embedFont(StandardFonts.TimesRoman)// Add a blank page to the documentconstpage=pdfDoc.addPage()// Get the width and height of the pageconst{ width, height}=page.getSize()// Draw a string of text toward the top of the pageconstfontSize=30page.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)constpdfBytes=awaitpdfDoc.save()// For example, `pdfBytes` can be://   • Written to a file in Node//   • Downloaded from the browser//   • Rendered in an <iframe>

Modify Document

import{degrees,PDFDocument,rgb,StandardFonts}from'pdf-lib';// This should be a Uint8Array or ArrayBuffer// This data can be obtained in a number of different ways// If your running in a Node environment, you could use fs.readFile()// In the browser, you could make a fetch() call and use res.arrayBuffer()constexistingPdfBytes= ...// Load a PDFDocument from the existing PDF bytesconstpdfDoc=awaitPDFDocument.load(existingPdfBytes)// Embed the Helvetica fontconsthelveticaFont=awaitpdfDoc.embedFont(StandardFonts.Helvetica)// Get the first page of the documentconstpages=pdfDoc.getPages()constfirstPage=pages[0]// Get the width and height of the first pageconst{ width, height}=firstPage.getSize()// Draw a string of text diagonally across the first pagefirstPage.drawText('This text was added with JavaScript!',{x:5,y:height/2+300,size:50,font:helveticaFont,color:rgb(0.95,0.1,0.1),rotate:degrees(-45),})// Serialize the PDFDocument to bytes (a Uint8Array)constpdfBytes=awaitpdfDoc.save()// For example, `pdfBytes` can be://   • Written to a file in Node//   • Downloaded from the browser//   • Rendered in an <iframe>

Create Form

import{PDFDocument}from'pdf-lib'// Create a new PDFDocumentconstpdfDoc=awaitPDFDocument.create()// Add a blank page to the documentconstpage=pdfDoc.addPage([550,750])// Get the form so we can add fields to itconstform=pdfDoc.getForm()// Add the superhero text field and descriptionpage.drawText('Enter your favorite superhero:',{x:50,y:700,size:20})constsuperheroField=form.createTextField('favorite.superhero')superheroField.setText('One Punch Man')superheroField.addToPage(page,{x:55,y:640})// Add the rocket radio group, labels, and descriptionpage.drawText('Select your favorite rocket:',{x:50,y:600,size:20})page.drawText('Falcon Heavy',{x:120,y:560,size:18})page.drawText('Saturn IV',{x:120,y:500,size:18})page.drawText('Delta IV Heavy',{x:340,y:560,size:18})page.drawText('Space Launch System',{x:340,y:500,size:18})constrocketField=form.createRadioGroup('favorite.rocket')rocketField.addOptionToPage('Falcon Heavy',page,{x:55,y:540})rocketField.addOptionToPage('Saturn IV',page,{x:55,y:480})rocketField.addOptionToPage('Delta IV Heavy',page,{x:275,y:540})rocketField.addOptionToPage('Space Launch System',page,{x:275,y:480})rocketField.select('Saturn IV')// Add the gundam check boxes, labels, and descriptionpage.drawText('Select your favorite gundams:',{x:50,y:440,size:20})page.drawText('Exia',{x:120,y:400,size:18})page.drawText('Kyrios',{x:120,y:340,size:18})page.drawText('Virtue',{x:340,y:400,size:18})page.drawText('Dynames',{x:340,y:340,size:18})constexiaField=form.createCheckBox('gundam.exia')constkyriosField=form.createCheckBox('gundam.kyrios')constvirtueField=form.createCheckBox('gundam.virtue')constdynamesField=form.createCheckBox('gundam.dynames')exiaField.addToPage(page,{x:55,y:380})kyriosField.addToPage(page,{x:55,y:320})virtueField.addToPage(page,{x:275,y:380})dynamesField.addToPage(page,{x:275,y:320})exiaField.check()dynamesField.check()// Add the planet dropdown and descriptionpage.drawText('Select your favorite planet*:',{x:50,y:280,size:20})constplanetsField=form.createDropdown('favorite.planet')planetsField.addOptions(['Venus','Earth','Mars','Pluto'])planetsField.select('Pluto')planetsField.addToPage(page,{x:55,y:220})// Add the person option list and descriptionpage.drawText('Select your favorite person:',{x:50,y:180,size:18})constpersonField=form.createOptionList('favorite.person')personField.addOptions(['Julius Caesar','Ada Lovelace','Cleopatra','Aaron Burr','Mark Antony',])personField.select('Ada Lovelace')personField.addToPage(page,{x:55,y:70})// Just saying...page.drawText(`* Pluto should be a planet too!`,{x:15,y:15,size:15})// Serialize the PDFDocument to bytes (a Uint8Array)constpdfBytes=awaitpdfDoc.save()// For example, `pdfBytes` can be://   • Written to a file in Node//   • Downloaded from the browser//   • Rendered in an <iframe>

Fill Form

import{PDFDocument}from'pdf-lib'// These should be Uint8Arrays or ArrayBuffers// This data can be obtained in a number of different ways// If your running in a Node environment, you could use fs.readFile()// In the browser, you could make a fetch() call and use res.arrayBuffer()constformPdfBytes= ...constmarioImageBytes= ...constemblemImageBytes= ...// Load a PDF with form fieldsconstpdfDoc=awaitPDFDocument.load(formPdfBytes)// Embed the Mario and emblem imagesconstmarioImage=awaitpdfDoc.embedPng(marioImageBytes)constemblemImage=awaitpdfDoc.embedPng(emblemImageBytes)// Get the form containing all the fieldsconstform=pdfDoc.getForm()// Get all fields in the PDF by their namesconstnameField=form.getTextField('CharacterName 2')constageField=form.getTextField('Age')constheightField=form.getTextField('Height')constweightField=form.getTextField('Weight')consteyesField=form.getTextField('Eyes')constskinField=form.getTextField('Skin')consthairField=form.getTextField('Hair')constalliesField=form.getTextField('Allies')constfactionField=form.getTextField('FactionName')constbackstoryField=form.getTextField('Backstory')consttraitsField=form.getTextField('Feat+Traits')consttreasureField=form.getTextField('Treasure')constcharacterImageField=form.getButton('CHARACTER IMAGE')constfactionImageField=form.getTextField('Faction Symbol Image')// Fill in the basic info fieldsnameField.setText('Mario')ageField.setText('24 years')heightField.setText(`5' 1"`)weightField.setText('196 lbs')eyesField.setText('blue')skinField.setText('white')hairField.setText('brown')// Fill the character image field with our Mario imagecharacterImageField.setImage(marioImage)// Fill in the allies fieldalliesField.setText([`Allies:`,`  • Princess Daisy`,`  • Princess Peach`,`  • Rosalina`,`  • Geno`,`  • Luigi`,`  • Donkey Kong`,`  • Yoshi`,`  • Diddy Kong`,``,`Organizations:`,`  • Italian Plumbers Association`,].join('\n'),)// Fill in the faction name fieldfactionField.setText(`Mario's Emblem`)// Fill the faction image field with our emblem imagefactionImageField.setImage(emblemImage)// Fill in the backstory fieldbackstoryField.setText(`Mario is a fictional character in the Mario video game franchise, owned by Nintendo and created by Japanese video game designer Shigeru Miyamoto. Serving as the company's mascot and the eponymous protagonist of the series, Mario has appeared in over 200 video games since his creation. Depicted as a short, pudgy, Italian plumber who resides in the Mushroom Kingdom, his adventures generally center upon rescuing Princess Peach from the Koopa villain Bowser. His younger brother and sidekick is Luigi.`,)// Fill in the traits fieldtraitsField.setText([`Mario can use three basic three power-ups:`,`  • the Super Mushroom, which causes Mario to grow larger`,`  • the Fire Flower, which allows Mario to throw fireballs`,`  • the Starman, which gives Mario temporary invincibility`,].join('\n'),)// Fill in the treasure fieldtreasureField.setText(['• Gold coins','• Treasure chests'].join('\n'))// Serialize the PDFDocument to bytes (a Uint8Array)constpdfBytes=awaitpdfDoc.save()// For example, `pdfBytes` can be://   • Written to a file in Node//   • Downloaded from the browser//   • Rendered in an <iframe>

Flatten Form

import{PDFDocument}from'pdf-lib'// This should be a Uint8Array or ArrayBuffer// This data can be obtained in a number of different ways// If your running in a Node environment, you could use fs.readFile()// In the browser, you could make a fetch() call and use res.arrayBuffer()constformPdfBytes= ...// Load a PDF with form fieldsconstpdfDoc=awaitPDFDocument.load(formPdfBytes)// Get the form containing all the fieldsconstform=pdfDoc.getForm()// Fill the form's fieldsform.getTextField('Text1').setText('Some Text');form.getRadioGroup('Group2').select('Choice1');form.getRadioGroup('Group3').select('Choice3');form.getRadioGroup('Group4').select('Choice1');form.getCheckBox('Check Box3').check();form.getCheckBox('Check Box4').uncheck();form.getDropdown('Dropdown7').select('Infinity');form.getOptionList('List Box6').select('Honda');// Flatten the form's fieldsform.flatten();// Serialize the PDFDocument to bytes (a Uint8Array)constpdfBytes=awaitpdfDoc.save()// For example, `pdfBytes` can be://   • Written to a file in Node//   • Downloaded from the browser//   • Rendered in an <iframe>

Copy Pages

import{PDFDocument}from'pdf-lib'// Create a new PDFDocumentconstpdfDoc=awaitPDFDocument.create()// These should be Uint8Arrays or ArrayBuffers// This data can be obtained in a number of different ways// If your running in a Node environment, you could use fs.readFile()// In the browser, you could make a fetch() call and use res.arrayBuffer()constfirstDonorPdfBytes= ...constsecondDonorPdfBytes= ...// Load a PDFDocument from each of the existing PDFsconstfirstDonorPdfDoc=awaitPDFDocument.load(firstDonorPdfBytes)constsecondDonorPdfDoc=awaitPDFDocument.load(secondDonorPdfBytes)// Copy the 1st page from the first donor document, and// the 743rd page from the second donor documentconst[firstDonorPage]=awaitpdfDoc.copyPages(firstDonorPdfDoc,[0])const[secondDonorPage]=awaitpdfDoc.copyPages(secondDonorPdfDoc,[742])// Add the first copied pagepdfDoc.addPage(firstDonorPage)// Insert the second copied page to index 0, so it will be the// first page in `pdfDoc`pdfDoc.insertPage(0,secondDonorPage)// Serialize the PDFDocument to bytes (a Uint8Array)constpdfBytes=awaitpdfDoc.save()// For example, `pdfBytes` can be://   • Written to a file in Node//   • Downloaded from the browser//   • Rendered in an <iframe>

Embed PNG and JPEG Images

import{PDFDocument}from'pdf-lib'// These should be Uint8Arrays or ArrayBuffers// This data can be obtained in a number of different ways// If your running in a Node environment, you could use fs.readFile()// In the browser, you could make a fetch() call and use res.arrayBuffer()constjpgImageBytes= ...constpngImageBytes= ...// Create a new PDFDocumentconstpdfDoc=awaitPDFDocument.create()// Embed the JPG image bytes and PNG image bytesconstjpgImage=awaitpdfDoc.embedJpg(jpgImageBytes)constpngImage=awaitpdfDoc.embedPng(pngImageBytes)// Get the width/height of the JPG image scaled down to 25% of its original sizeconstjpgDims=jpgImage.scale(0.25)// Get the width/height of the PNG image scaled down to 50% of its original sizeconstpngDims=pngImage.scale(0.5)// Add a blank page to the documentconstpage=pdfDoc.addPage()// Draw the JPG image in the center of the pagepage.drawImage(jpgImage,{x:page.getWidth()/2-jpgDims.width/2,y:page.getHeight()/2-jpgDims.height/2,width:jpgDims.width,height:jpgDims.height,})// Draw the PNG image near the lower right corner of the JPG imagepage.drawImage(pngImage,{x:page.getWidth()/2-pngDims.width/2+75,y:page.getHeight()/2-pngDims.height,width:pngDims.width,height:pngDims.height,})// Serialize the PDFDocument to bytes (a Uint8Array)constpdfBytes=awaitpdfDoc.save()// For example, `pdfBytes` can be://   • Written to a file in Node//   • Downloaded from the browser//   • Rendered in an <iframe>

Embed PDF Pages

import{PDFDocument}from'pdf-lib'// These should be Uint8Arrays or ArrayBuffers// This data can be obtained in a number of different ways// If your running in a Node environment, you could use fs.readFile()// In the browser, you could make a fetch() call and use res.arrayBuffer()constamericanFlagPdfBytes= ...constusConstitutionPdfBytes= ...// Create a new PDFDocumentconstpdfDoc=awaitPDFDocument.create()// Embed the American flag PDF bytesconst[americanFlag]=awaitpdfDoc.embedPdf(americanFlagPdfBytes)// Load the U.S. constitution PDF bytesconstusConstitutionPdf=awaitPDFDocument.load(usConstitutionPdfBytes)// Embed the second page of the constitution and clip the preambleconstpreamble=awaitpdfDoc.embedPage(usConstitutionPdf.getPages()[1],{left:55,bottom:485,right:300,top:575,})// Get the width/height of the American flag PDF scaled down to 30% of// its original sizeconstamericanFlagDims=americanFlag.scale(0.3)// Get the width/height of the preamble clipping scaled up to 225% of// its original sizeconstpreambleDims=preamble.scale(2.25)// Add a blank page to the documentconstpage=pdfDoc.addPage()// Draw the American flag image in the center top of the pagepage.drawPage(americanFlag,{  ...americanFlagDims,x:page.getWidth()/2-americanFlagDims.width/2,y:page.getHeight()-americanFlagDims.height-150,})// Draw the preamble clipping in the center bottom of the pagepage.drawPage(preamble,{  ...preambleDims,x:page.getWidth()/2-preambleDims.width/2,y:page.getHeight()/2-preambleDims.height/2-50,})// Serialize the PDFDocument to bytes (a Uint8Array)constpdfBytes=awaitpdfDoc.save()// For example, `pdfBytes` can be://   • Written to a file in Node//   • Downloaded from the browser//   • Rendered in an <iframe>

Embed Font and Measure Text

import{PDFDocument,rgb}from'pdf-lib'importfontkitfrom'@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()constfontBytes= ...// Create a new PDFDocumentconstpdfDoc=awaitPDFDocument.create()// Register the `fontkit` instancepdfDoc.registerFontkit(fontkit)// Embed our custom font in the documentconstcustomFont=awaitpdfDoc.embedFont(fontBytes)// Add a blank page to the documentconstpage=pdfDoc.addPage()// Create a string of text and measure its width and height in our custom fontconsttext='This is text in an embedded font!'consttextSize=35consttextWidth=customFont.widthOfTextAtSize(text,textSize)consttextHeight=customFont.heightAtSize(textSize)// Draw the string of text on the pagepage.drawText(text,{x:40,y:450,size:textSize,font:customFont,color:rgb(0,0.53,0.71),})// Draw a box around the string of textpage.drawRectangle({x:40,y:450,width:textWidth,height:textHeight,borderColor:rgb(1,0,0),borderWidth:1.5,})// Serialize the PDFDocument to bytes (a Uint8Array)constpdfBytes=awaitpdfDoc.save()// For example, `pdfBytes` can be://   • Written to a file in Node//   • Downloaded from the browser//   • Rendered in an <iframe>

Add Attachments

import{PDFDocument}from'pdf-lib'// These should be Uint8Arrays or ArrayBuffers// This data can be obtained in a number of different ways// If your running in a Node environment, you could use fs.readFile()// In the browser, you could make a fetch() call and use res.arrayBuffer()constjpgAttachmentBytes= ...constpdfAttachmentBytes= ...// Create a new PDFDocumentconstpdfDoc=awaitPDFDocument.create()// Add the JPG attachmentawaitpdfDoc.attach(jpgAttachmentBytes,'cat_riding_unicorn.jpg',{mimeType:'image/jpeg',description:'Cool cat riding a unicorn! 🦄🐈🕶️',creationDate:newDate('2019/12/01'),modificationDate:newDate('2020/04/19'),})// Add the PDF attachmentawaitpdfDoc.attach(pdfAttachmentBytes,'us_constitution.pdf',{mimeType:'application/pdf',description:'Constitution of the United States 🇺🇸🦅',creationDate:newDate('1787/09/17'),modificationDate:newDate('1992/05/07'),})// Add a page with some textconstpage=pdfDoc.addPage();page.drawText('This PDF has two attachments',{x:135,y:415})// Serialize the PDFDocument to bytes (a Uint8Array)constpdfBytes=awaitpdfDoc.save()// For example, `pdfBytes` can be://   • Written to a file in Node//   • Downloaded from the browser//   • Rendered in an <iframe>

Set Document Metadata

import{PDFDocument,StandardFonts}from'pdf-lib'// Create a new PDFDocumentconstpdfDoc=awaitPDFDocument.create()// Embed the Times Roman fontconsttimesRomanFont=awaitpdfDoc.embedFont(StandardFonts.TimesRoman)// Add a page and draw some text on itconstpage=pdfDoc.addPage([500,600])page.setFont(timesRomanFont)page.drawText('The Life of an Egg',{x:60,y:500,size:50})page.drawText('An Epic Tale of Woe',{x:125,y:460,size:25})// Set all available metadata fields on the PDFDocument. Note that these fields// are visible in the "Document Properties" section of most PDF readers.pdfDoc.setTitle('🥚 The Life of an Egg 🍳')pdfDoc.setAuthor('Humpty Dumpty')pdfDoc.setSubject('📘 An Epic Tale of Woe 📖')pdfDoc.setKeywords(['eggs','wall','fall','king','horses','men'])pdfDoc.setProducer('PDF App 9000 🤖')pdfDoc.setCreator('pdf-lib (https://github.com/Hopding/pdf-lib)')pdfDoc.setCreationDate(newDate('2018-06-24T01:58:37.228Z'))pdfDoc.setModificationDate(newDate('2019-12-21T07:00:11.000Z'))// Serialize the PDFDocument to bytes (a Uint8Array)constpdfBytes=awaitpdfDoc.save()// For example, `pdfBytes` can be://   • Written to a file in Node//   • Downloaded from the browser//   • Rendered in an <iframe>

Read Document Metadata

import{PDFDocument}from'pdf-lib'// This should be a Uint8Array or ArrayBuffer// This data can be obtained in a number of different ways// If your running in a Node environment, you could use fs.readFile()// In the browser, you could make a fetch() call and use res.arrayBuffer()constexistingPdfBytes= ...// Load a PDFDocument without updating its existing metadataconstpdfDoc=awaitPDFDocument.load(existingPdfBytes,{updateMetadata:false})// Print all available metadata fieldsconsole.log('Title:',pdfDoc.getTitle())console.log('Author:',pdfDoc.getAuthor())console.log('Subject:',pdfDoc.getSubject())console.log('Creator:',pdfDoc.getCreator())console.log('Keywords:',pdfDoc.getKeywords())console.log('Producer:',pdfDoc.getProducer())console.log('Creation Date:',pdfDoc.getCreationDate())console.log('Modification Date:',pdfDoc.getModificationDate())

Title: Microsoft Word - Basic Curriculum Vitae example.docAuthor: AdministratorSubject: undefinedCreator: PScript5.dll Version 5.2Keywords: undefinedProducer: Acrobat Distiller 8.1.0 (Windows)Creation Date: 2010-07-29T14:26:00.000ZModification Date: 2010-07-29T14:26:00.000Z

Set Viewer Preferences

import{PDFDocument,StandardFonts,NonFullScreenPageMode,ReadingDirection,PrintScaling,Duplex,PDFName,}from'pdf-lib'// Create a new PDFDocumentconstpdfDoc=awaitPDFDocument.create()// Embed the Times Roman fontconsttimesRomanFont=awaitpdfDoc.embedFont(StandardFonts.TimesRoman)// Add a page and draw some text on itconstpage=pdfDoc.addPage([500,600])page.setFont(timesRomanFont)page.drawText('The Life of an Egg',{x:60,y:500,size:50})page.drawText('An Epic Tale of Woe',{x:125,y:460,size:25})// Set all available viewer preferences on the PDFDocument:constviewerPrefs=pdfDoc.catalog.getOrCreateViewerPreferences()viewerPrefs.setHideToolbar(true)viewerPrefs.setHideMenubar(true)viewerPrefs.setHideWindowUI(true)viewerPrefs.setFitWindow(true)viewerPrefs.setCenterWindow(true)viewerPrefs.setDisplayDocTitle(true)// Set the PageMode (otherwise setting NonFullScreenPageMode has no meaning)pdfDoc.catalog.set(PDFName.of('PageMode'),PDFName.of('FullScreen'))// Set what happens when fullScreen is closedviewerPrefs.setNonFullScreenPageMode(NonFullScreenPageMode.UseOutlines)viewerPrefs.setReadingDirection(ReadingDirection.L2R)viewerPrefs.setPrintScaling(PrintScaling.None)viewerPrefs.setDuplex(Duplex.DuplexFlipLongEdge)viewerPrefs.setPickTrayByPDFSize(true)// We can set the default print range to only the first pageviewerPrefs.setPrintPageRange({start:0,end:0})// Or we can supply noncontiguous ranges (e.g. pages 1, 3, and 5-7)viewerPrefs.setPrintPageRange([{start:0,end:0},{start:2,end:2},{start:4,end:6},])viewerPrefs.setNumCopies(2)// Serialize the PDFDocument to bytes (a Uint8Array)constpdfBytes=awaitpdfDoc.save()// For example, `pdfBytes` can be://   • Written to a file in Node//   • Downloaded from the browser//   • Rendered in an <iframe>

Read Viewer Preferences

import{PDFDocument}from'pdf-lib'// This should be a Uint8Array or ArrayBuffer// This data can be obtained in a number of different ways// If your running in a Node environment, you could use fs.readFile()// In the browser, you could make a fetch() call and use res.arrayBuffer()constexistingPdfBytes= ...// Load a PDFDocument without updating its existing metadataconstpdfDoc=awaitPDFDocument.load(existingPdfBytes)constviewerPrefs=pdfDoc.catalog.getOrCreateViewerPreferences()// Print all available viewer preference fieldsconsole.log('HideToolbar:',viewerPrefs.getHideToolbar())console.log('HideMenubar:',viewerPrefs.getHideMenubar())console.log('HideWindowUI:',viewerPrefs.getHideWindowUI())console.log('FitWindow:',viewerPrefs.getFitWindow())console.log('CenterWindow:',viewerPrefs.getCenterWindow())console.log('DisplayDocTitle:',viewerPrefs.getDisplayDocTitle())console.log('NonFullScreenPageMode:',viewerPrefs.getNonFullScreenPageMode())console.log('ReadingDirection:',viewerPrefs.getReadingDirection())console.log('PrintScaling:',viewerPrefs.getPrintScaling())console.log('Duplex:',viewerPrefs.getDuplex())console.log('PickTrayByPDFSize:',viewerPrefs.getPickTrayByPDFSize())console.log('PrintPageRange:',viewerPrefs.getPrintPageRange())console.log('NumCopies:',viewerPrefs.getNumCopies())

HideToolbar: trueHideMenubar: trueHideWindowUI: falseFitWindow: trueCenterWindow: trueDisplayDocTitle: trueNonFullScreenPageMode: UseNoneReadingDirection: R2LPrintScaling: NoneDuplex: DuplexFlipLongEdgePickTrayByPDFSize: truePrintPageRange: [ { start: 1, end: 1 }, { start: 3, end: 4 } ]NumCopies: 2

Draw SVG Paths

import{PDFDocument,rgb}from'pdf-lib'// SVG path for a wavy lineconstsvgPath='M 0,20 L 100,160 Q 130,200 150,120 C 190,-40 200,200 300,150 L 400,90'// Create a new PDFDocumentconstpdfDoc=awaitPDFDocument.create()// Add a blank page to the documentconstpage=pdfDoc.addPage()page.moveTo(100,page.getHeight()-5)// Draw the SVG path as a black linepage.moveDown(25)page.drawSvgPath(svgPath)// Draw the SVG path as a thick green linepage.moveDown(200)page.drawSvgPath(svgPath,{borderColor:rgb(0,1,0),borderWidth:5})// Draw the SVG path and fill it with redpage.moveDown(200)page.drawSvgPath(svgPath,{color:rgb(1,0,0)})// Draw the SVG path at 50% of its original sizepage.moveDown(200)page.drawSvgPath(svgPath,{scale:0.5})// Serialize the PDFDocument to bytes (a Uint8Array)constpdfBytes=awaitpdfDoc.save()// For example, `pdfBytes` can be://   • Written to a file in Node//   • Downloaded from the browser//   • Rendered in an <iframe>

Deno Usage

Creating a Document with Deno

import{PDFDocument,StandardFonts,rgb,}from'https://cdn.skypack.dev/pdf-lib@^1.11.1?dts';constpdfDoc=awaitPDFDocument.create();consttimesRomanFont=awaitpdfDoc.embedFont(StandardFonts.TimesRoman);constpage=pdfDoc.addPage();const{ width, height}=page.getSize();constfontSize=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),});constpdfBytes=awaitpdfDoc.save();awaitDeno.writeFile('out.pdf',pdfBytes);

deno run --allow-write create-document.ts

Embedding a Font with Deno

import{degrees,PDFDocument,rgb,StandardFonts,}from'https://cdn.skypack.dev/pdf-lib@^1.11.1?dts';importfontkitfrom'https://cdn.skypack.dev/@pdf-lib/fontkit@^1.0.0?dts';consturl='https://pdf-lib.js.org/assets/ubuntu/Ubuntu-R.ttf';constfontBytes=awaitfetch(url).then((res)=>res.arrayBuffer());constpdfDoc=awaitPDFDocument.create();pdfDoc.registerFontkit(fontkit);constcustomFont=awaitpdfDoc.embedFont(fontBytes);constpage=pdfDoc.addPage();consttext='This is text in an embedded font!';consttextSize=35;consttextWidth=customFont.widthOfTextAtSize(text,textSize);consttextHeight=customFont.heightAtSize(textSize);page.drawText(text,{x:40,y:450,size:textSize,font:customFont,color:rgb(0,0.53,0.71),});page.drawRectangle({x:40,y:450,width:textWidth,height:textHeight,borderColor:rgb(1,0,0),borderWidth:1.5,});constpdfBytes=awaitpdfDoc.save();awaitDeno.writeFile('out.pdf',pdfBytes);

deno run --allow-write --allow-net custom-font.ts

Complete Examples

Installation

NPM Module

# With npmnpm install --save pdf-lib# With yarnyarn add pdf-lib

UMD Module

// NPM moduleimport{PDFDocument,rgb}from'pdf-lib';// UMD modulevarPDFDocument=PDFLib.PDFDocument;varrgb=PDFLib.rgb;

Fontkit Installation

Fontkit NPM Module

# With npmnpm install --save @pdf-lib/fontkit# With yarnyarn add @pdf-lib/fontkit

import{PDFDocument}from'pdf-lib'importfontkitfrom'@pdf-lib/fontkit'constpdfDoc=awaitPDFDocument.create()pdfDoc.registerFontkit(fontkit)

Fontkit UMD Module

varpdfDoc=awaitPDFLib.PDFDocument.create()pdfDoc.registerFontkit(fontkit)

Documentation

Fonts and Unicode

Error: WinAnsi cannot encode "Ω" (0x03a9)    at Encoding.encodeUnicodeCodePoint

Font Subsetting

constfont=awaitpdfDoc.embedFont(fontBytes,{subset:true});

Creating and Filling Forms

import{PDFDocument}from'pdf-lib';importfontkitfrom'@pdf-lib/fontkit';// Fetch the PDF with form fieldsconstformUrl='https://pdf-lib.js.org/assets/dod_character.pdf';constformBytes=awaitfetch(formUrl).then((res)=>res.arrayBuffer());// Fetch the Ubuntu fontconstfontUrl='https://pdf-lib.js.org/assets/ubuntu/Ubuntu-R.ttf';constfontBytes=awaitfetch(fontUrl).then((res)=>res.arrayBuffer());// Load the PDF with form fieldsconstpdfDoc=awaitPDFDocument.load(formBytes);// Embed the Ubuntu fontpdfDoc.registerFontkit(fontkit);constubuntuFont=awaitpdfDoc.embedFont(fontBytes);// Get two text fields from the formconstform=pdfDoc.getForm();constnameField=form.getTextField('CharacterName 2');constageField=form.getTextField('Age');// Fill the text fields with some fancy Unicode characters (outside// the WinAnsi latin character set)nameField.setText('Ӎӑȑїõ');ageField.setText('24 ŷȇȁŗš');// **Key Step:** Update the field appearances with the Ubuntu fontform.updateFieldAppearances(ubuntuFont);// Save the PDF with filled form fieldsconstpdfBytes=awaitpdfDoc.save();

Handy Methods for Filling, Creating, and Reading Form Fields

Limitations

Help and Discussion

Encryption Handling

import{PDFDocument,EncryptedPDFError}from'pdf-lib'constencryptedPdfBytes= ...// Assignment fails. Throws an `EncryptedPDFError`.constpdfDoc=PDFDocument.load(encryptedPdfBytes)

import{PDFDocument}from'pdf-lib'constencryptedPdfBytes= ...// Assignment succeeds. Does not throw an error.constpdfDoc=PDFDocument.load(encryptedPdfBytes,{ignoreEncryption:true})

Contributing

Maintainership

Tutorials and Cool Stuff

Prior Art

Git History Rewrite

Steps We Took

$ git clone git@github.com:Hopding/pdf-lib.git$ cd pdf-lib$ rm pdf_specification.pdf$ git commit -am 'Remove pdf_specification.pdf'$ bfg --delete-files pdf_specification.pdf$ git reflog expire --expire=now --all && git gc --prune=now --aggressive$ git push --force

Why Should I Care?

License