Repository files navigation

A library to generate PDFs in JavaScript.

You cancatch me on twitter:@MrRio or head over tomy company's website for consultancy.

jsPDF is now co-maintained byyWorks - the diagramming experts.

Recommended: get jsPDF from npm:

npm install jspdf --save# oryarn add jspdf

Alternatively, load it from a CDN:

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

Or always get latest version viaunpkg

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

Thedist 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 allrequired polyfills fromcore-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 figureout the right file, so importing "jspdf" is enough.

Then you're ready to start making your document:

import{jsPDF}from"jspdf";// Default export is a4 paper, portrait, using millimeters for unitsconstdoc=newjsPDF();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 inchesconstdoc=newjsPDF({orientation:"landscape",unit:"in",format:[4,2]});doc.text("Hello world!",1,1);doc.save("two-by-four.pdf");

const{ jsPDF}=require("jspdf");// will automatically load the node versionconstdoc=newjsPDF();doc.text("Hello world!",10,10);doc.save("a4.pdf");// will save the file in the current working directory

require(["jspdf"],({ jsPDF})=>{constdoc=newjsPDF();doc.text("Hello world!",10,10);doc.save("a4.pdf");});

const{ jsPDF}=window.jspdf;constdoc=newjsPDF();doc.text("Hello world!",10,10);doc.save("a4.pdf");

Some functions of jsPDF require optional dependencies. E.g. thehtml method, which depends onhtml2canvas 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 separatechunks for each of the optional dependencies. If your application does not use any of the optional dependencies, youcan prevent Webpack from generating the chunks by defining them as external dependencies:

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

InVue CLI projects, externals can be defined via theconfigureWebpackorchainWebpack properties of thevue.config.js file(needs to be created, first, in fresh projects).

InAngular projects, externals can be defined usingcustom webpack builders.

InReact (create-react-app) projects, externals can be defined by either usingreact-app-rewired or ejecting.

jsPDF can be imported just like any other 3rd party library. This works with all major toolkits and frameworks. jsPDFalso 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

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 uploading polyfills multiple times. Might still be nifty for small applications or quick POCs.

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

The 14 standard fonts in PDF are limited to the ASCII-codepage. If you want to use UTF-8 you have to integrate acustom font, which provides the needed glyphs. jsPDF supports .ttf-files. So if you want to have for exampleChinese text in your pdf, your font has to have the necessary Chinese glyphs. So, check if your font supportsthe 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 stringand 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 usingfetch orXMLHttpRequest andadd the font to the PDF file:

constdoc=newjsPDF();constmyFont= ...// load the *.ttf font file as binary string// add the font to jsPDFdoc.addFileToVFS("MyFont.ttf",myFont);doc.addFont("MyFont.ttf","MyFont","normal");doc.setFont("MyFont");

Since the merge with theyWorks fork there are a lot of new features. However, someof 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 ofall advanced features like patterns, FormObjects, and transformation matrices.

You can switch between the two modes by calling

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

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

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

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

• A bug should be reported as anmcve
• Make sure code is properly indented andformatted (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.

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

You can find information about building and testing jsPDF in thecontribution guide

• Big thanks to Daniel Dotsenko fromWillow Systems Corporation for making huge contributions to the codebase.
• Thanks to Ajaxian.com forfeaturing 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.

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

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

The above copyright notice and this permission notice shall beincluded 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 OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE ANDNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BELIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTIONOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTIONWITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.