Generate PDF Document In Spfx

Introduction

 

JSPDF is a powerful plugin to play with pdf in Clientside. html2canvas is a plugin to take screenshots of web pages of users' browsers. The screenshot is based on the element of html provided .

 

Here we are using a combination of both to achieve our goal .

 

Intially we want to construct an html dom element and take a snapshot as a image format with the help of html2canvas plugin and next convert the image into base64 format using,

canvas.toDataURL('image/png');

Once canvas part is completed, we have  to intiate jspdf plugin to generate  and download pdf.

new jsPDF('p', 'mm', 'a4');

 As  I mentioned earlier here we are using canvas screenshot to save as pdf, for that jspdf provides a method name as follows:

addImage(imageData, format, x, y, width, height, alias, compression, rotation)

  And finally save method in jspdf plugin used to download the generated pdf file in our local machine

save(filename, options)

eg. save("mypdf.pdf");

 

Let's make its practical.

 

Open a command prompt. Create a directory for the SPFx solution.

 

md spfx-Pdf

 

Navigate to the above-created directory.

 

cd spfx-Pdf

 

Run the Yeoman SharePoint Generator to create the solution.

 

yo @microsoft/sharepoint

 

Solution Name

 

Hit Enter to have the default name (spfx-Pdf in this case) or type in any other name for your solution.

Selected choice - Hit Enter

 

Target for the component

 

Here, we can select the target environment where we are planning to deploy the client web part, i.e., SharePoint Online or SharePoint OnPremise (SharePoint 2016 onwards).

Selected choice - SharePoint Online only (latest).

 

Place of files

 

We may choose to use the same folder or create a subfolder for our solution.

Selected choice - Same folder

 

Deployment option

 

Selecting Y will allow the app to be deployed instantly to all sites and be accessible everywhere.

Selected choice - N (install on each site explicitly)

 

Permissions to access web APIs

 

Choose if the components in the solution require permission to access web APIs that are unique and not shared with other components in the tenant.

Selected choice - N (solution contains unique permissions)

 

Type of client-side component to create

 

We can choose to create a client-side web part or an extension. Choose the web part option.

Selected choice - WebPart

 

Web part name

 

Hit Enter to select the default name or type in any other name.

Selected choice - SpfxPdf

 

Web part description

 

Hit Enter to select the default description or type in any other value.

 

Framework to use

 

Select any JavaScript framework to develop the component. Available choices are - No JavaScript Framework, React, and Knockout.

Selected choice - React

 

The Yeoman generator will perform a scaffolding process to generate the solution. The scaffolding process will take a significant amount of time.

 

Once the scaffolding process is completed, lock down the version of project dependencies by running the below command,

 

npm shrinkwrap

 

In the command prompt, type the below command to open the solution in the code editor of your choice.

 

 

NPM Packages Used,

 

On the command prompt, run the below commands

npm i jspdf --save
npm i  html2canvas --save
npm i @types/jspdf --save

in SpfxPdf.tsx,

import * as React from 'react';
import { ISpfxPdfProps } from './ISpfxPdfProps';
import * as jsPDF from 'jspdf';
import html2canvas from 'html2canvas';
require('./tablestyle.css');
export default class SpfxPdf extends React.Component<ISpfxPdfProps, {}> {
  public documentprint = (e) => {
    e.preventDefault();
    const myinput = document.getElementById('mypdf');
    html2canvas(myinput)
      .then((canvas) => {
        var imgWidth = 200;
        var pageHeight = 290;
        var imgHeight = canvas.height * imgWidth / canvas.width;
        var heightLeft = imgHeight;
        const imgData = canvas.toDataURL('image/png');
        const mynewpdf = new jsPDF('p', 'mm', 'a4');
        var position = 0;
        mynewpdf.addImage(imgData, 'JPEG', 5, position, imgWidth, imgHeight);
        mynewpdf.save("mypdf.pdf");
      });
  }
  public render(): React.ReactElement<ISpfxPdfProps> {
    return (
      <div>
        <div id="mypdf">
          <br />
          <table>
            <tbody>
              <tr>
                <th>Name</th>
                <th>City</th>
                <th>Country</th>
              </tr>
              <tr>
                <td>Madhan Thurai</td>
                <td>Chennai</td>
                <td>India</td>
              </tr>
              <tr>
                <td>Reghu</td>
                <td>Madurai</td>
                <td>India</td>
              </tr>
              <tr>
                <td>Ananth</td>
                <td>Nagercoil</td>
                <td>India</td>
              </tr>
              <tr>
                <td>Vanitha</td>
                <td>Cuddalore</td>
                <td>India</td>
              </tr>
              <tr>
                <td>Boopathi</td>
                <td>Dindigul</td>
                <td>India</td>
              </tr>
              <tr>
                <td>Risha</td>
                <td>Tirunelveli</td>
                <td>India</td>
              </tr>
            </tbody>
          </table>

        </div>
        <button onClick={this.documentprint} >
          Generate Pdf  </button>
      </div>
    );
  }
}

in tablestyle.css,

table {
    font-family: arial, sans-serif;
    border-collapse: collapse;
    width: 100%;
}

th {
    border: 1px solid #dddddd;
    text-align: left;
    padding: 8px;
    background: red;
    color: white;
}
td {
    border: 1px solid #dddddd;
    text-align: left;
    padding: 8px;

}
tr:nth-child(even) {
    background-color: #dddddd;
}

Dom Output

 

 

Generated Pdf output

 

 

Conclusion

 

From this article we have learned about generating pdf documents in spfx using jspdf and html2canvas plugin. I hope this helps someone. Happy coding :)