Home > Web Front-end > JS Tutorial > How to Create PDFs in React from JSON Data with jsPDF

How to Create PDFs in React from JSON Data with jsPDF

Barbara Streisand
Release: 2024-11-05 13:07:02
Original
502 people have browsed it

How to Create PDFs in React from JSON Data with jsPDF

This article will show how to create PDF in JS/React from JSON data.

As developers, we must integrate PDF generation within the application. So, in this article, we will discuss creating PDFs using jspdf.

So, Let’s get started.

We will use a React environment specifically for this article. I assume you’re familiar with JavaScript/React and have already set up the React environment

Before diving in, we need some sample data to generate the PDF. We’ll create a method to generate this data.

const generateUsers = (count) => {
    const users = [];

    for (let i = 1; i <= count; i++) {
      const user = {
        id: i,
        firstName: `firstName_${i}`,
        lastName: `lastName_${i}`,
        email: `email_${i}@example.com`,
        address: [
          `Street ${i + 1}, Address Line 1`,
          `District ${(i % 7) + 1}, City_${i}`,
        ],
      };
      users.push(user);
    }
    return users;
  };
Copy after login
Copy after login

Now, we need to install some npm packages jspdf and jspdf-autotable.

jsPDF is responsible for creating PDFs, while jsPDF-AutoTable is used to display data in a table format within the PDF.

You can use the following command to install both packages.

npm i jspdf-autotable jspdf
Copy after login
Copy after login

Now, we are going to develop a method to handle PDF creation. I’ll create a generic generatePDF method, so you can use it anywhere you need.

1. Function Definition

The function generatePDF takes data as an argument, which is expected to be an array of objects (the JSON data to include in the PDF).

export const generatePDF = (data) => {
Copy after login
Copy after login

2. PDF Document Setup
A new jsPDF instance is created with the following options:

  • "l" for landscape orientation.
  • "pt" as the unit of measurement (points).
  • "a3" as the paper size.
const doc = new jsPDF("l", "pt", "a3");

// if you want to use custom dimensions
// width,height

const doc = new jsPDF("l", "pt", [3000,1000]);
Copy after login
Copy after login

3. Adding Title to the PDF

  • Sets the font size to 16 points.
  • Adds a centered title, "JSON Data PDF", at the top of the page (y-position of 30).
doc.setFontSize(16);
doc.text("JSON Data PDF", doc.internal.pageSize.getWidth() / 2, 30, {
    align: "center",
});
Copy after login

4. Extracting Table Headers

  • Extracts the keys from the first object in data to use as column headers for the table.
  • Assumes data has at least one object, and all objects have similar keys.
const tableColumnHeaders = Object.keys(data[0]);
Copy after login

5. Formatting Table Rows

Iterates over each object in data, creating a new array (tableRows) where:

  • Each entry corresponds to a row of the table.
  • For each cell, if the value is an array, it joins elements with a comma; otherwise, it adds the value as is.
const tableRows = data.map((row) =>
    Object.keys(row).map((key) => {
        const value = row[key];
        if (Array.isArray(value)) {
            return value.join(", ");
        }
        return value;
    })
);
Copy after login

6. Adding the Table to the PDF

Configures the table with the following options:

  • startY: 50 positions the table 50 points below the top of the page.
  • head uses tableColumnHeaders as the table’s header row.
  • body is populated with tableRows, displaying data row-by-row.
  • margin specifies spacing around the table.
  • styles adjusts the cell font size, padding, and vertical alignment.
  • headStyles sets header row styles: blue background, white text, and 12-point font.
  • alternateRowStyles adds a light gray background for alternating rows.
  • columnStyles attempts to set column width automatically.
  • theme: "striped" applies a striped theme to the table.
const generateUsers = (count) => {
    const users = [];

    for (let i = 1; i <= count; i++) {
      const user = {
        id: i,
        firstName: `firstName_${i}`,
        lastName: `lastName_${i}`,
        email: `email_${i}@example.com`,
        address: [
          `Street ${i + 1}, Address Line 1`,
          `District ${(i % 7) + 1}, City_${i}`,
        ],
      };
      users.push(user);
    }
    return users;
  };
Copy after login
Copy after login

7. Saving the PDF
Saves the PDF file with the filename "JS-pdf.pdf".

npm i jspdf-autotable jspdf
Copy after login
Copy after login

Here is the full version of this code.

export const generatePDF = (data) => {
Copy after login
Copy after login
const doc = new jsPDF("l", "pt", "a3");

// if you want to use custom dimensions
// width,height

const doc = new jsPDF("l", "pt", [3000,1000]);
Copy after login
Copy after login

This is done for now. Hopefully, you enjoyed it. Have a nice day !!!

The above is the detailed content of How to Create PDFs in React from JSON Data with jsPDF. For more information, please follow other related articles on the PHP Chinese website!

source:dev.to
Statement of this Website
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn
Latest Articles by Author
Popular Tutorials
More>
Latest Downloads
More>
Web Effects
Website Source Code
Website Materials
Front End Template