jspdf vs pdf-lib vs react-pdf vs pdfkit vs pdfmake vs pdfjs
PDF Generation and Manipulation
jspdfpdf-libreact-pdfpdfkitpdfmakepdfjsSimilar Packages:
PDF Generation and Manipulation

PDF Generation and Manipulation libraries in JavaScript provide developers with tools to create, edit, and manipulate PDF documents programmatically. These libraries offer a range of functionalities, including generating PDFs from HTML content, adding text and images, creating forms, and manipulating existing PDF files (such as merging, splitting, or extracting content). They are widely used in web applications, server-side environments, and desktop applications to automate PDF-related tasks, enhance document workflows, and provide users with dynamic and interactive PDF content. Each library has its strengths and use cases, catering to different needs such as client-side generation, server-side processing, or advanced PDF manipulation.

Npm Package Weekly Downloads Trend
3 Years
Github Stars Ranking
Stat Detail
Package
Downloads
Stars
Size
Issues
Publish
License
jspdf4,456,96730,85630.1 MB10719 days agoMIT
pdf-lib2,443,9338,127-3094 years agoMIT
react-pdf2,261,54710,705416 kB202 months agoMIT
pdfkit1,425,98510,5126.09 MB4083 months agoMIT
pdfmake1,165,94712,17513.6 MB3097 months agoMIT
pdfjs49,322811355 kB735 months agoMIT
Feature Comparison: jspdf vs pdf-lib vs react-pdf vs pdfkit vs pdfmake vs pdfjs

PDF Creation

  • jspdf:

    jspdf allows for basic PDF creation directly in the browser. You can add text, images, and shapes, and it supports simple HTML to PDF conversion. However, the HTML rendering is limited, and complex layouts may not be accurately reproduced.

  • pdf-lib:

    pdf-lib provides robust PDF creation capabilities, allowing you to create documents from scratch or modify existing ones. It supports adding text, images, and shapes, as well as more advanced features like creating forms and annotations.

  • pdfkit:

    pdfkit is a powerful library for creating PDFs programmatically in Node.js. It supports complex layouts, vector graphics, and advanced typography, making it suitable for generating high-quality PDFs with detailed customization.

  • pdfmake:

    pdfmake allows for PDF creation using a declarative approach. You define the document structure using a JSON object, which makes it easy to create complex layouts, tables, and styled text.

  • pdfjs:

    pdfjs is primarily focused on rendering and interacting with existing PDF documents rather than creating them. It does not provide PDF creation features.

PDF Manipulation

  • jspdf:

    jspdf offers limited PDF manipulation capabilities, such as adding content to existing PDFs and merging multiple PDFs. However, it is not designed for extensive editing or manipulation of existing PDF files.

  • pdf-lib:

    pdf-lib excels in PDF manipulation, allowing you to modify existing PDF documents, merge multiple files, fill out forms, and add annotations. It provides a comprehensive set of features for both creation and manipulation.

  • pdfkit:

    pdfkit does not provide built-in PDF manipulation features. It is primarily focused on creating PDFs from scratch rather than editing existing ones.

  • pdfmake:

    pdfmake does not support PDF manipulation features such as editing existing PDFs or merging files. It is focused on creating PDFs from defined document structures.

  • pdfjs:

    pdfjs does not provide PDF manipulation features. It is focused on rendering and interacting with PDF documents, making it suitable for viewing and annotating PDFs but not for editing them.

Rendering HTML to PDF

  • jspdf:

    jspdf supports basic HTML to PDF conversion using the html method, which allows you to render HTML elements as PDF content. However, the rendering quality and accuracy may vary, especially with complex layouts and CSS.

  • pdf-lib:

    pdf-lib does not provide built-in HTML to PDF conversion. It focuses on PDF creation and manipulation using JavaScript, allowing you to add text, images, and other elements programmatically.

  • pdfkit:

    pdfkit does not support HTML to PDF conversion. It is a programmatic PDF creation library that requires you to define the content and layout using JavaScript code.

  • pdfmake:

    pdfmake does not support HTML to PDF conversion. It uses a declarative approach where you define the document structure using a JSON object.

  • pdfjs:

    pdfjs does not support HTML to PDF conversion. It is designed for rendering and displaying existing PDF documents in the browser.

Client-side vs Server-side

  • jspdf:

    jspdf is primarily a client-side library that runs in the browser, making it suitable for generating PDFs directly from web applications without server interaction.

  • pdf-lib:

    pdf-lib can be used both client-side and server-side, making it versatile for applications that require PDF creation and manipulation in different environments.

  • pdfkit:

    pdfkit is designed for server-side PDF creation in Node.js. It is not suitable for client-side use due to its reliance on Node.js streams.

  • pdfmake:

    pdfmake can be used both client-side and server-side, allowing for PDF generation in a variety of environments.

  • pdfjs:

    pdfjs is a client-side library for rendering PDF documents in the browser. It is not designed for server-side use.

Ease of Use: Code Examples

  • jspdf:

    Simple PDF Creation with jspdf

    import jsPDF from 'jspdf';
    const doc = new jsPDF();
    doc.text('Hello, world!', 10, 10);
    doc.save('example.pdf');
    
  • pdf-lib:

    PDF Creation and Manipulation with pdf-lib

    import { PDFDocument } from 'pdf-lib';
    const pdfDoc = await PDFDocument.create();
    const page = pdfDoc.addPage([600, 400]);
    page.drawText('Hello, PDF!', { x: 50, y: 350 });
    const pdfBytes = await pdfDoc.save();
    
  • pdfkit:

    PDF Creation with pdfkit

    const PDFDocument = require('pdfkit');
    const doc = new PDFDocument();
    doc.pipe(fs.createWriteStream('output.pdf'));
    doc.text('Hello, PDFKit!');
    doc.end();
    
  • pdfmake:

    PDF Creation with pdfmake

    const docDefinition = { content: 'This is a sample PDF document.' };
    pdfMake.createPdf(docDefinition).download('sample.pdf');
    
  • pdfjs:

    Rendering PDF with pdfjs

    import { pdfjsLib } from 'pdfjs-dist';
    const loadingTask = pdfjsLib.getDocument('path/to/document.pdf');
    loadingTask.promise.then(pdf => {
      console.log('PDF loaded:', pdf);
    });
    
How to Choose: jspdf vs pdf-lib vs react-pdf vs pdfkit vs pdfmake vs pdfjs
  • jspdf:

    Choose jspdf if you need a simple and lightweight solution for generating PDF documents directly from the browser. It is ideal for projects that require basic PDF creation with text, images, and shapes, and it supports HTML to PDF conversion with some limitations.

  • pdf-lib:

    Select pdf-lib if you need to create, modify, and manipulate PDF documents entirely in JavaScript, both in the browser and on the server. It allows for more advanced PDF editing, such as merging documents, adding annotations, and filling out forms, all while maintaining a focus on performance and memory efficiency.

  • react-pdf:

    Choose react-pdf if you are building a React application and need to render PDF documents or create PDF files using React components. It provides a set of React components for displaying PDFs, as well as tools for generating PDFs from React components, making it a great choice for projects that leverage the React ecosystem.

  • pdfkit:

    Choose pdfkit if you are working in a Node.js environment and need a feature-rich library for programmatically creating complex PDF documents. It offers a high level of customization, including support for streams, vector graphics, and advanced typography, making it suitable for generating dynamic and high-quality PDFs on the server.

  • pdfmake:

    Select pdfmake if you need a flexible and easy-to-use library for creating PDF documents with a declarative approach. It allows you to define the document structure using a JSON object, making it simple to generate complex layouts, tables, and styled text. It also supports client-side and server-side rendering.

  • pdfjs:

    Use pdfjs (PDF.js) if you need to render PDF documents in a web application. It is a powerful library for displaying PDF files in the browser using HTML5 and JavaScript, making it suitable for applications that require PDF viewing, annotation, and interaction without modifying the original files.

README for jspdf

jsPDF

Continous Integration Code Climate Test Coverage GitHub license Total alerts Language grade: JavaScript Gitpod ready-to-code

A library to generate PDFs in JavaScript.

You can catch me on twitter: @MrRio or head over to my company's website for consultancy.

jsPDF is now co-maintained by yWorks - the diagramming experts.

Live Demo | Documentation

Install

Recommended: get jsPDF from npm:

npm install jspdf --save
# or
yarn add jspdf

Alternatively, load it from a CDN:

<script src="https://cdnjs.cloudflare.com/ajax/libs/jspdf/3.0.4/jspdf.umd.min.js"></script>

Or always get latest version via unpkg

<script src="https://unpkg.com/jspdf@latest/dist/jspdf.umd.min.js"></script>

The dist folder of this package contains different kinds of files:

  • jspdf.es.*.js: Modern ES2015 module format.
  • jspdf.node.*.js: For running in Node. Uses file operations for loading/saving files instead of browser APIs.
  • jspdf.umd.*.js: UMD module format. For AMD or script-tag loading.
  • polyfills*.js: Required polyfills for older browsers like Internet Explorer. The es variant simply imports all required polyfills from core-js, the umd variant is self-contained.

Usually it is not necessary to specify the exact file in the import statement. Build tools or Node automatically figure out the right file, so importing "jspdf" is enough.

Usage

Then you're ready to start making your document:

import { jsPDF } from "jspdf";

// Default export is a4 paper, portrait, using millimeters for units
const doc = new jsPDF();

doc.text("Hello world!", 10, 10);
doc.save("a4.pdf");

If you want to change the paper size, orientation, or units, you can do:

// Landscape export, 2×4 inches
const doc = new jsPDF({
  orientation: "landscape",
  unit: "in",
  format: [4, 2]
});

doc.text("Hello world!", 1, 1);
doc.save("two-by-four.pdf");

Running in Node.js

const { jsPDF } = require("jspdf"); // will automatically load the node version

const doc = new jsPDF();
doc.text("Hello world!", 10, 10);
doc.save("a4.pdf"); // will save the file in the current working directory

Other Module Formats

AMD
require(["jspdf"], ({ jsPDF }) => {
  const doc = new jsPDF();
  doc.text("Hello world!", 10, 10);
  doc.save("a4.pdf");
});
Globals
const { jsPDF } = window.jspdf;

const doc = new jsPDF();
doc.text("Hello world!", 10, 10);
doc.save("a4.pdf");

Optional dependencies

Some functions of jsPDF require optional dependencies. E.g. the html method, which depends on html2canvas and, when supplied with a string HTML document, dompurify. JsPDF loads them dynamically when required (using the respective module format, e.g. dynamic imports). Build tools like Webpack will automatically create separate chunks for each of the optional dependencies. If your application does not use any of the optional dependencies, you can prevent Webpack from generating the chunks by defining them as external dependencies:

// webpack.config.js
module.exports = {
  // ...
  externals: {
    // only define the dependencies you are NOT using as externals!
    canvg: "canvg",
    html2canvas: "html2canvas",
    dompurify: "dompurify"
  }
};

In Vue CLI projects, externals can be defined via the configureWebpack or chainWebpack properties of the vue.config.js file (needs to be created, first, in fresh projects).

In Angular projects, externals can be defined using custom webpack builders.

In React (create-react-app) projects, externals can be defined by either using react-app-rewired or ejecting.

TypeScript/Angular/Webpack/React/etc. Configuration:

jsPDF can be imported just like any other 3rd party library. This works with all major toolkits and frameworks. jsPDF also offers a typings file for TypeScript projects.

import { jsPDF } from "jspdf";

You can add jsPDF to your meteor-project as follows:

meteor add jspdf:core

Polyfills

jsPDF requires modern browser APIs in order to function. To use jsPDF in older browsers like Internet Explorer, polyfills are required. You can load all required polyfills as follows:

import "jspdf/dist/polyfills.es.js";

Alternatively, you can load the prebundled polyfill file. This is not recommended, since you might end up loading polyfills multiple times. Might still be nifty for small applications or quick POCs.

<script src="https://cdnjs.cloudflare.com/ajax/libs/jspdf/3.0.4/polyfills.umd.js"></script>

Use of Unicode Characters / UTF-8:

The 14 standard fonts in PDF are limited to the ASCII-codepage. If you want to use UTF-8 you have to integrate a custom font, which provides the needed glyphs. jsPDF supports .ttf-files. So if you want to have for example Chinese text in your pdf, your font has to have the necessary Chinese glyphs. So, check if your font supports the wanted glyphs or else it will show garbled characters instead of the right text.

To add the font to jsPDF use our fontconverter in /fontconverter/fontconverter.html. The fontconverter will create a js-file with the content of the provided ttf-file as base64 encoded string and additional code for jsPDF. You just have to add this generated js-File to your project. You are then ready to go to use setFont-method in your code and write your UTF-8 encoded text.

Alternatively you can just load the content of the *.ttf file as a binary string using fetch or XMLHttpRequest and add the font to the PDF file:

const doc = new jsPDF();

const myFont = ... // load the *.ttf font file as binary string

// add the font to jsPDF
doc.addFileToVFS("MyFont.ttf", myFont);
doc.addFont("MyFont.ttf", "MyFont", "normal");
doc.setFont("MyFont");

Advanced Functionality

Since the merge with the yWorks fork there are a lot of new features. However, some of them are API breaking, which is why there is an API-switch between two API modes:

  • In "compat" API mode, jsPDF has the same API as MrRio's original version, which means full compatibility with plugins. However, some advanced features like transformation matrices and patterns won't work. This is the default mode.
  • In "advanced" API mode, jsPDF has the API you're used from the yWorks-fork version. This means the availability of all advanced features like patterns, FormObjects, and transformation matrices.

You can switch between the two modes by calling

doc.advancedAPI(doc => {
  // your code
});
// or
doc.compatAPI(doc => {
  // your code
});

JsPDF will automatically switch back to the original API mode after the callback has run.

Support

Please check if your question is already handled at Stackoverflow https://stackoverflow.com/questions/tagged/jspdf. Feel free to ask a question there with the tag jspdf.

Feature requests, bug reports, etc. are very welcome as issues. Note that bug reports should follow these guidelines:

  • A bug should be reported as an mcve
  • Make sure code is properly indented and formatted (Use ``` around code blocks)
  • Provide a runnable example.
  • Try to make sure and show in your issue that the issue is actually related to jspdf and not your framework of choice.

Contributing

jsPDF cannot live without help from the community! If you think a feature is missing or you found a bug, please consider if you can spare one or two hours and prepare a pull request. If you're simply interested in this project and want to help, have a look at the open issues, especially those labeled with "bug".

You can find information about building and testing jsPDF in the contribution guide

Credits

  • Big thanks to Daniel Dotsenko from Willow Systems Corporation for making huge contributions to the codebase.
  • Thanks to Ajaxian.com for featuring us back in 2009. (Internet Archive Wayback Machine reference)
  • Our special thanks to GH Lee (sphilee) for programming the ttf-file-support and providing a large and long sought after feature
  • Everyone else that's contributed patches or bug reports. You rock.

License (MIT)

Copyright (c) 2010-2025 James Hall, https://github.com/MrRio/jsPDF (c) 2015-2025 yWorks GmbH, https://www.yworks.com/

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.