parallax/jsPDF

Modernize Source Code Examples

Open

#2930 opened on Sep 24, 2020

View on GitHub
 (13 comments) (3 reactions) (0 assignees)JavaScript (28,280 stars) (4,596 forks)batch import
difficulty:beginnerhacktoberfesthelp wantedpersistent

Description

JsPDF has a lot of code examples that haven't been looked at for quite some time and some of them are outdated.

Have a look at the examples and modernize them:

  • Use recent ES6 code
  • Add one or two TypeScript examples
  • Use jsPDF@2.x.x API
  • delete unused files
  • delete the examples/css folder and load required CSS libraries from a CDN
  • delete jquery (examples/js/jquery) and replace it with modern browser APIs
  • reduce code duplication in html files (styles)

Bonus: Add small examples for the three major UI frameworks: VueJs, Angular, and React. Setup the initial applications with @vue/cli, create-react-app, and @angular/cli then add jsPDF.

Contributor guide

Tech stack
javascripttypescriptreactvueangularhtmlcss
Domain
documentationfrontend
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScript ES6TypeScript basicsReact, Vue, or Angular experiencenpm/CLI tools
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Review the examples directory (https://github.com/MrRio/jsPDF/tree/master/examples) and update code to modern ES6 and jsPDF 2.x API. Create TypeScript examples. Remove jQuery and replace with native DOM APIs. Optionally set up new example apps using Vue CLI, Create React App, and Angular CLI, integrating jsPDF. Ensure CSS is loaded from CDN and reduce duplication.