{"id":2289,"date":"2022-01-26T09:22:09","date_gmt":"2022-01-26T09:22:09","guid":{"rendered":"https:\/\/lvboard.infostore.in.ua\/?p=2289"},"modified":"2022-01-26T09:22:09","modified_gmt":"2022-01-26T09:22:09","slug":"react-pdf-rendering","status":"publish","type":"post","link":"https:\/\/lvboard.infostore.in.ua\/?p=2289","title":{"rendered":"React & PDF Rendering"},"content":{"rendered":"\n

Portable Document Format (PDF)<\/strong> – developed 30 years ago still exists and is one of the most widely-used documents formats. There are many reasons why people still prefer to use them such as the widely supported document format which works is compatible with many devices and apps, and the content always remains the same format.<\/p>\n\n\n\n\n\n\n\n

<\/a> What is React-PDF ?<\/h3>\n\n\n\n

React-pdf lets us render documents on server and web.
It exports a set of React primitives that can be used to render things into documents easily and we can use CSS properties for styling and flexbox for layout. A list of supported primitives can be found here<\/a> It supports rendering text, images, SVGs and many more.<\/p>\n\n\n\n

<\/a> What we going to build ?<\/h3>\n\n\n\n

Today we will be looking at how we can create and style PDF with react-pdf renderer. React-pdf package lets us create awesome looking PDFs using React. Its simple to use and the documentation is developer-friendly. We will create a simple application that dynamically updates our PDF-styled template which we render in DOM.<\/p>\n\n\n\n

This example will show how you can render the document in DOM and how directly save the document into the file without the need of displaying it.<\/p>\n\n\n\n

\n\n\n\n
\"Demo\"\/<\/a><\/figure>\n\n\n\n
\n\n\n\n

<\/a> 1. Setup<\/h3>\n\n\n\n
npx create-react-app app && cd app && yarn add @react-pdf\/renderer\n<\/code><\/pre>\n\n\n\n
As in the time of writing tutorial react-pdf render need some extra dependencies and craco configuration.
<\/p>\n\n\n\n
yarn add process browserify-zlib stream-browserify util buffer assert @craco\/craco\n<\/code><\/pre>\n\n\n\n
Change the scripts section in package.json as below:
<\/p>\n\n\n\n
  \"scripts\": {\n    \"start\": \"craco start\",\n    \"build\": \"craco build\",\n    \"test\": \"craco test\",\n    \"eject\": \"react-scripts eject\"\n  },\n<\/code><\/pre>\n\n\n\n
Next, create a new file in the root of the project
craco.config.js with
<\/p>\n\n\n\n
const webpack = require(\"webpack\");\n\nmodule.exports = {\n  webpack: {\n    configure: {\n      resolve: {\n        fallback: {\n          process: require.resolve(\"process\/browser\"),\n          zlib: require.resolve(\"browserify-zlib\"),\n          stream: require.resolve(\"stream-browserify\"),\n          util: require.resolve(\"util\"),\n          buffer: require.resolve(\"buffer\"),\n          asset: require.resolve(\"assert\"),\n        },\n      },\n      plugins: [\n        new webpack.ProvidePlugin({\n          Buffer: [\"buffer\", \"Buffer\"],\n          process: \"process\/browser\",\n        }),\n      ],\n    },\n  },\n};\n\n<\/code><\/pre>\n\n\n\n
mkdir Components && cd Components && mkdir PDF && cd PDF && touch Preview.js && touch LeftSection.js && touch RightSection.js\n<\/code><\/pre>\n\n\n\n
\u251c\u2500\u2500 App.css\n\u251c\u2500\u2500 App.js\n\u251c\u2500\u2500 index.js\n\u251c\u2500\u2500 PDF\n\u2502   \u251c\u2500\u2500 LeftSection.js\n\u2502   \u251c\u2500\u2500 Preview.js\n\u2502   \u2514\u2500\u2500 RightSection.js\n\u2514\u2500\u2500 styles\n    \u2514\u2500\u2500 index.js\n<\/code><\/pre>\n\n\n\n
In our App.js<\/code> we will create a state that updates on user input when changes are detected we will re-render our page.
<\/p>\n\n\n\n
import Preview from '.\/PDF\/Preview'\nimport React, { useState } from 'react'\nfunction App() {\n  const [profile, setProfile] = useState({\n    type: 'Profile',\n    name: 'John Doe',\n    profession: 'Junior Developer',\n    profileImageURL: 'https:\/\/i.imgur.com\/f6L6Y57.png',\n    display: true,\n    about: 'About...',\n  })\n\n  const handleChange = (name, value) => {\n    setProfile({ ...profile, [name]: value })\n  }\n\n  return (\n    <div\n      style={{\n        width: '100%',\n        height: '100vh',\n        display: 'flex',\n      }}\n    >\n      <div style={{ width: '50%' }}>\n        <div>\n          <label>Name<\/label>\n          <input\n            name='name'\n            defaultValue={profile.name}\n            onChange={(e) => {\n              handleChange(e.target.name, e.target.value)\n            }}\n          \/>\n        <\/div>\n        <div>\n          <label>Profession<\/label>\n          <input\n            name='profession'\n            defaultValue={profile.profession}\n            onChange={(e) => {\n              handleChange(e.target.name, e.target.value)\n            }}\n          \/>\n        <\/div>\n        <div>\n          <label>ImageURL<\/label>\n          <input\n            name='profileImageURL'\n            defaultValue={profile.profileImageURL}\n            onChange={(e) => {\n              handleChange(e.target.name, e.target.value)\n            }}\n          \/>\n        <\/div>\n        <div>\n          <label>About<\/label>\n          <input\n            name='about'\n            defaultValue={profile.about}\n            onChange={(e) => {\n              handleChange(e.target.name, e.target.value)\n            }}\n          \/>\n        <\/div>\n      <\/div>\n      <Preview profile={profile} \/>\n    <\/div>\n  )\n}\n\nexport default App\n\n<\/code><\/pre>\n\n\n\n
Preview.js<\/code>
This will let us render a preview on half of the page and embed the Template document that we are about to create.
We also have PDFDownloadLink which can be used to download pdf without the need of rendering it in the DOM.
<\/p>\n\n\n\n
import React from 'react'\nimport { Document, Page, PDFViewer, PDFDownloadLink } from '@react-pdf\/renderer'\nimport LeftSection from '.\/LeftSection'\nimport { RightSection } from '.\/RightSection'\nimport styles from '..\/styles'\n\nconst Preview = ({ profile }) => {\n  return (\n    <div style={{ flexGrow: 1 }}>\n      <PDFViewer\n        showToolbar={false}\n        style={{\n          width: '100%',\n          height: '95%',\n        }}\n      >\n        <Template profile={profile} \/>\n      <\/PDFViewer>\n      <PDFDownloadLink\n        document={<Template profile={profile} \/>}\n        fileName='somename.pdf'\n      >\n        {({ loading }) => (loading ? 'Loading document...' : 'Download now!')}\n      <\/PDFDownloadLink>\n    <\/div>\n  )\n}\n\/\/ Create Document Component\nconst Template = ({ profile }) => {\n  return (\n    <Document>\n      <Page size='A4' style={styles.page}>\n        \/\/ We will divide our document into 2 columns\n        <LeftSection profile={profile} \/>\n        <RightSection about={profile.about} \/>\n      <\/Page>\n    <\/Document>\n  )\n}\n\nexport default Preview\n\n\n\n<\/code><\/pre>\n\n\n\n
We will also create folder with styles where we will keep stylesSheet for react-render primitives.
<\/p>\n\n\n\n
mkdir styles && cd styles && mkdir index.js\n<\/code><\/pre>\n\n\n\n
styles
<\/p>\n\n\n\n
import { StyleSheet } from '@react-pdf\/renderer'\n\nexport default StyleSheet.create({\n  page: {\n    display: 'flex',\n    flexDirection: 'row',\n  },\n  section_right: {\n    margin: 10,\n    padding: 10,\n    paddingTop: 20,\n    width: '75%',\n  },\n  section_left: {\n    width: '25%',\n    height: '100%',\n    backgroundColor: '#084c41',\n  },\n  profile_container: {\n    display: 'flex',\n    flexDirection: 'column',\n    alignItems: 'center',\n    marginTop: '20',\n    marginBottom: '20px',\n    height: '150',\n    fontFamily: 'Helvetica-Bold',\n  },\n  name_text: {\n    paddingTop: '10px',\n    paddingBottom: '5px',\n    fontSize: '14px',\n    fontWeight: '900',\n    color: 'white',\n  },\n  profession_text: {\n    color: '#d1d5db',\n    fontSize: '11px',\n  },\n  profile_img: {\n    width: '60px',\n    height: '60px',\n    borderRadius: '90',\n  },\n  profile_line: {\n    marginTop: '10px',\n    width: '10%',\n    height: '1px',\n    backgroundColor: '#FFF',\n    textAlign: 'center',\n  },\n})\n<\/code><\/pre>\n\n\n\n
LeftSection.js<\/code>
<\/p>\n\n\n\n
import { View, Text, Image } from '@react-pdf\/renderer'\nimport styles from '..\/styles'\n\nexport const Profile = ({ profile }) => {\n  return (\n    <View style={styles.profile_container}>\n      <Image style={styles.profile_img} src={profile.profileImageURL} \/>\n\n      <View\n        style={{\n          justifyContent: 'center',\n        }}\n      >\n        <Text style={styles.name_text}>{profile.name}<\/Text>\n      <\/View>\n      <Text style={styles.profession_text}>{profile.profession}<\/Text>\n      <View style={styles.profile_line} \/>\n    <\/View>\n  )\n}\n\nconst LeftSection = ({ profile }) => {\n  return (\n    <View style={styles.section_left}>\n      <Profile profile={profile} \/>\n    <\/View>\n  )\n}\n\nexport default LeftSection\n\n<\/code><\/pre>\n\n\n\n
RightSection.js<\/code>
<\/p>\n\n\n\n
import styles from '..\/styles'\nimport { View, Text } from '@react-pdf\/renderer'\n\nexport const RightSection = ({ about }) => {\n  return (\n    <View style={styles.section_right}>\n      <Text>{about}<\/Text>\n    <\/View>\n  )\n}\n<\/code><\/pre>\n\n\n\n
Now you know it works you could create something yourself.<\/p>\n\n\n\n
More functional example of a resume builder that I built is here.
Resume builder<\/a><\/p>\n\n\n\n
To sum up, this is only a simple demo to demonstrate how the pdf renderer can be used with react. React pdf package very cool tool that could be used to create things like resume builders, invoicing templates or tickets or receipts, etc. These could be either generated based on the existing data or dynamically updated on user input like in the case of our simple demo.<\/p>\n\n\n\n
I hope this article was helpful to some of you guys. Thanks for reading!
Github repo<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
Portable Document Format (PDF) – developed 30 years ago still exists and is one of the most widely-used documents formats. There are many reasons why people still prefer to use them such as the widely supported document format which works is compatible with many devices and apps, and the content always remains the same format.<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[30],"tags":[65],"_links":{"self":[{"href":"https:\/\/lvboard.infostore.in.ua\/index.php?rest_route=\/wp\/v2\/posts\/2289"}],"collection":[{"href":"https:\/\/lvboard.infostore.in.ua\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/lvboard.infostore.in.ua\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/lvboard.infostore.in.ua\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/lvboard.infostore.in.ua\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=2289"}],"version-history":[{"count":1,"href":"https:\/\/lvboard.infostore.in.ua\/index.php?rest_route=\/wp\/v2\/posts\/2289\/revisions"}],"predecessor-version":[{"id":2290,"href":"https:\/\/lvboard.infostore.in.ua\/index.php?rest_route=\/wp\/v2\/posts\/2289\/revisions\/2290"}],"wp:attachment":[{"href":"https:\/\/lvboard.infostore.in.ua\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=2289"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/lvboard.infostore.in.ua\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=2289"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/lvboard.infostore.in.ua\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=2289"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}