Generate modular PDFs via pdfmake using JSX.
import PDFMake from 'pdfmake';
import JsxPdf from 'jsx-pdf';
import { OpenSans } from './font-descriptors';
const pdfMake = new PDFMake({
OpenSans,
});
const stream = pdfMake.createPdfKitDocument(
JsxPdf.renderPdf(
<document defaultStyle={{ font: 'OpenSans', fontSize: 12 }}>
<content>This will appear in my PDF!</content>
</document>,
),
);
// write the stream to a file; this could also be streamed to an HTTP connection, stdout etc
stream.on('finish', () => console.log('PDF generated'));
stream.pipe(fs.createWriteStream('~/Desktop/test.pdf'));
stream.end();
yarn add jsx-pdf babel-plugin-transform-react-jsx@^6.0.0
- Ensure babel is set up for your project and your .babelrc or equivalent contains
{ "plugins": [ [ "transform-react-jsx", { "pragma": "JsxPdf.createElement" } ] ] }
- Code away! See the examples below.
You can also run our example script by running yarn demo
and opening the generated pdf at example/example.pdf
. Check the console logs for additional information.
Similar to modern front-end frameworks, you can define your own components using declarative syntax.
import JsxPdf from 'jsx-pdf';
const Greeting = ({ name }) => <text>Hello, {name}!</text>;
const doc = (
<document>
<content>
<Greeting name="Bob" />
</content>
</document>
);
import JsxPdf from 'jsx-pdf';
const GroupGreeting = ({ names }) => (
<stack>{names.map(name => <Greeting name={name} />)}</stack>
);
const doc = (
<document>
<content>
<GroupGreeting names={['Bob', 'Alice']} />
</content>
</document>
);
import JsxPdf from 'jsx-pdf';
const Signature = () => <text>JSX-PDF, Inc.</text>;
const SignedGreeting = ({ name }) => (
<stack>
{name && <Greeting name={name} />}
<Signature />
</stack>
);
const doc = (
<document>
<content>
<SignedGreeting />
</content>
</document>
);
import JsxPdf from 'jsx-pdf';
const AnonymousGreeting = () => <text>We don't know you.</text>;
const SignedGreeting = ({ name }) => (
<stack>
{name ? <Greeting name={name} /> : <AnonymousGreeting />}
<Signature />
</stack>
);
const doc = (
<document>
<content>
<SignedGreeting />
</content>
</document>
);
import JsxPdf from 'jsx-pdf';
const SignedGreeting = ({ name }) => {
let greeting;
if (name) {
greeting = <Greeting name={name} />;
} else {
greeting = <AnonymousGreeting />;
}
return (
<stack>
{greeting}
<Signature />
</stack>
);
};
const doc = (
<document>
<content>
<SignedGreeting />
</content>
</document>
);
Styling can be done by adding appropriate attributes to tags. It's often helpful for readability to group style-related attributes together and use the spread syntax.
import JsxPdf from 'jsx-pdf';
const Greeting = ({ name }) => {
const styles = {
italics: true,
fontSize: 10,
};
return <text {...styles}>Hello, {name}!</text>;
};
const doc = (
<document>
<content>
<Greeting name="Bob" />
</content>
</document>
);
Each component has access to global context and can update it if necessary.
import JsxPdf from 'jsx-pdf';
const AllowedUsersProvider = (attributes, context, updateContext) => {
updateContext({
allowedUsers: ['Alice'],
});
return attributes.children[0];
};
const SecureGreeting = ({ name }, { allowedUsers }) =>
allowedUsers.includes(name) ? (
<text>Hello, {name}!</text>
) : (
<text>You are not allowed.</text>
);
const doc = (
<AllowedUsersProvider>
<document>
<content>
<SecureGreeting name="Bob" />
</content>
</document>
</AllowedUsersProvider>
);
This section describes basic elements provided by the library. More information about supported attributes and advanced examples can be found here.
Each document has to be enclosed within document
tag with nested content
, and optional header
and footer
. The document is the place for configuration that affects the whole PDF, such as page margins, page size, default style, and metadata.
import JsxPdf from 'jsx-pdf';
const doc = (
<document
pageMargins={[20, 20, 20, 20]}
pageSize="A4"
defaultStyle={{
font: 'OpenSans',
}}
info={{
author: 'Buzz Lightyear',
}}
>
<header>Greeting</header>
<content>Hello, Bob!</content>
<footer>JSX-PDF, Inc.</footer>
</document>
);
Paragraphs are defined using text
tag.
import JsxPdf from 'jsx-pdf';
const doc = (
<document>
<content>
<text>
This sentence will be rendered as one paragraph,
even though there are
line
breaks.
</text>
<text>This is another paragraph.</text>
</content>
</document>
);
In order to apply styling to a group of paragraphs, they can be wrapped with a stack
tag.
import JsxPdf from 'jsx-pdf';
const doc = (
<document>
<content>
<stack color="red">
<text>First red parahraph.</text>
<text>Second red parahraph.</text>
</stack>
<text color="blue">Blue parahraph.</text>
</content>
</document>
);
Elements nested in columns
tag will be stacked horizontally.
import JsxPdf from 'jsx-pdf';
const doc = (
<document>
<content>
<columns columnGap={10}>
<column width={100}>Fixed width column</column>
<column width="10%">Percentage width column</column>
<column width="auto">
Column that adjusts width based on the content
</column>
<column width="*">Column that fills the remaining space</column>
</columns>
</content>
</document>
);
Both ordered and unordered lists are supported.
import JsxPdf from 'jsx-pdf';
const docWithOrderedList = (
<document>
<content>
<ol reversed start={10} separator={['(', ')']} type="lower-roman">
<text>Item 1</text>
<text>Item 2</text>
<text>Item 3</text>
</ol>
</content>
</document>
);
const docWithUnorderedList = (
<document>
<content>
<ul color="blue" markerColor="red" type="square">
<text>Item 1</text>
<text>Item 2</text>
<text>Item 3</text>
</ul>
</content>
</document>
);
table
tag provides a simple way of creating table layouts.
const leftCellStyle = {
color: 'grey',
};
const doc = (
<document>
<content>
<table widths={[100, '*', 'auto']} headerRows={1} layout="headerLineOnly">
<row>
<cell>Fixed width column</cell>
<cell>Column that fills the remaining space</cell>
<cell>Column that adjusts width based on the content</cell>
</row>
<row>
<cell {...leftCellStyle}>Cell 1.1</cell>
<cell>Cell 1.2</cell>
<cell>Cell 1.3</cell>
</row>
<row>
<cell {...leftCellStyle}>Cell 2.1</cell>
<cell>Cell 2.2</cell>
<cell>Cell 2.3</cell>
</row>
</table>
</content>
</document>
);
image
supports JPEG and PNG formats.
import JsxPdf from 'jsx-pdf';
const doc = (
<document>
<content>
<image src="/home/bob/photos/Bob.png" width={150} height={150} />
</content>
</document>
);
Accepts JSX and returns a PDF JSON representation in the format expected by pdfmake.
This function converts JSX to object representation. Every time JSX syntax is used, the function has to be made available. The functionality depends the babel plugin babel-plugin-transform-react-jsx
(or equivalent), and Babel must be set up in the project in order to transpile the JSX correctly.
Example .babelrc
file:
{
"presets": [
[
"env",
{
"targets": {
"node": "6"
}
}
]
],
"plugins": [
[
"transform-react-jsx",
{
"pragma": "JsxPdf.createElement"
}
]
]
}
Copyright 2018 Schibsted
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
By contributing to this project, you agree that your contributions will be licensed under its MIT license.