Client-side JavaScript PDF generation for everyone.
JavaScript ActionScript HTML
Permalink
Failed to load latest commit information.
dist Compiled assets for getTextColor modifications Jan 5, 2018
docs getTextColor now works for grayscale values (#1586) Feb 18, 2018
examples Update basic.js Feb 14, 2018
libs Merge branch 'master' into feature/custom-fonts Feb 19, 2018
plugins Update acroform.js Feb 20, 2018
tests Update standard.spec.js Feb 20, 2018
.codeclimate.yml Add codeclimate configs Oct 8, 2016
.csslintrc Add codeclimate configs Oct 8, 2016
.eslintignore Add codeclimate configs Oct 8, 2016
.eslintrc Add codeclimate configs Oct 8, 2016
.gitignore Add npm-debug to gitignore Oct 9, 2016
.sauce.yml Add travis and sauce configs Oct 3, 2016
.travis.yml Update .travis.yml Feb 20, 2018
CNAME Add jspdf.com domain Jan 7, 2013
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md (#1430) Sep 11, 2017
HOTFIX_README.md Hotfix : Correct px unit scaling factor (#1179) Apr 14, 2017
ISSUE_TEMPLATE.md Update ISSUE_TEMPLATE.md Mar 1, 2016
MIT-LICENSE.txt Update deps, update copyright notice Feb 29, 2016
README.md Recommend Yarn, remove bower. Nov 3, 2017
RELEASE.md Add warning about NPM access Apr 11, 2017
bower.json Merge pull request #523 from kkirsche/patch-1 Feb 29, 2016
build.js Merge pull request #1433 from MrRio/feature/custom-fonts Feb 20, 2018
index.html Merge and update docs Sep 14, 2017
jsdoc.json Update documentation (#1357) Jul 29, 2017
jspdf.js Merge pull request #1433 from MrRio/feature/custom-fonts Feb 20, 2018
karma.conf.js Merge branch 'master' into feature/custom-fonts Feb 15, 2018
main.js Merge branch 'master' into feature/custom-fonts Feb 19, 2018
package.json chore(package): update uglify-js to version 3.3.12 (#1642) Feb 22, 2018
saucelabs.karma.conf.js Update saucelabs.karma.conf.js Feb 20, 2018
yarn.lock Update documentation (#1357) Jul 29, 2017

README.md

jsPDF

Greenkeeper badge

Build Status

Code Climate Test Coverage

A library to generate PDFs in client-side JavaScript.

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

Live Demo | Documentation

Creating your first document

The easiest way to get started is to drop the CDN hosted library into your page:

<script src="https://cdnjs.cloudflare.com/ajax/libs/jspdf/1.3.5/jspdf.debug.js"></script>

or can always get latest version via unpkg

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

Using yarn:

yarn add jspdf

Using npm:

npm install jspdf --save

Then you're ready to start making your document:

// Default export is a4 paper, portrait, using milimeters for units
var 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
var doc = new jsPDF({
  orientation: 'landscape',
  unit: 'in',
  format: [4, 2]
})

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

Great! Now give us a Star :)

Contributing

Build the library with npm run build. This will fetch all dependencies and then compile the dist files. To see the examples locally you can start a web server with npm start and go to localhost:8000.

Credits

License (MIT)

Copyright (c) 2010-2017 James Hall, https://github.com/MrRio/jsPDF

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.