https://github.com/random-guys/pdfmills
https://github.com/random-guys/pdfmills
library pdf-generation pdfkit
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/random-guys/pdfmills
- Owner: random-guys
- Created: 2019-11-01T03:12:58.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-04T23:53:27.000Z (over 3 years ago)
- Last Synced: 2025-05-11T21:16:52.070Z (about 1 year ago)
- Topics: library, pdf-generation, pdfkit
- Language: TypeScript
- Size: 1.9 MB
- Stars: 7
- Watchers: 0
- Forks: 6
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# pdfmills
A simple DSL wrapper around [pdfkit](https://github.com/foliojs/pdfkit)
## What's inside
- Elements:
- `Text` or `Paragraph`s
- `Image`s
- Layouts:
- `Block`
- `Flex`
- `RatioFlex`
- `EqualFlex`
- Spacing:
- `LineBreaks` for vertical spaces
- `Margin`
- `Padding`
- Automatic page management
## How to install
```sh
yarn add @random-guys/pdfmills
```
or
```sh
npm i @random-guys/pdfmills
```
## Get Started
```ts
import { block, Text } from "@random-guys/pdfmills";
// arrange elements vertically
const divStyle: BlockStyle = {
display: "block",
margin: 0
};
const flexStyle: FlexStyle = {
display: "flex"
};
div(
{ ...divStyle, margin: 4 },
row({
style: flexStyle,
elements: [
col(p("START DATE"), ["right"], 60),
col(p("ACCOUNT NUMBER", alignRight), ["right", "left"], 100),
col(p("INCOME", alignRight), ["left"], 60)
]
}),
row({
style: flexStyle,
elements: [
col(p("12/03/07", { ...headerFont, align: "left" }), ["right"], 60),
col(p("0087567843", headerFont), ["right", "left"], 100),
col(p("₦250,000", headerFont), ["left"], 60)
]
}),
br(20),
row({
style: flexStyle,
elements: [
col(p("END DATE"), ["right"], 60),
col(p("BALANCE", alignRight), ["right", "left"], 100),
col(p("INCOME", alignRight), ["left"], 60)
]
}),
row({
style: flexStyle,
elements: [
col(p("12/03/07", { ...headerFont, align: "left" }), ["right"], 60),
col(p("₦560,000", headerFont), ["right", "left"], 100),
col(p("₦25,000", headerFont), ["left"], 60)
]
})
);
// arrange elements horizontally
const headerFont: FontStyle = { ...alignRight, fontColor: [130, 134, 145] };
row({
style: flexStyle,
elements: [
col(p("12/03/07", { ...headerFont, align: "left" }), ["right"], 60),
col(p("0087567843", headerFont), ["right", "left"], 100),
col(p("₦250,000", headerFont), ["left"], 60)
]
});
// load the element
const elements = [firstRow, br(50), secondRow, br(40), thirdRow];
// write the elements to the buffer
render(context, elements);
// you can write the buffer to the file stream
save(context.raw, "output.pdf");
// you can also upload the file to Azure blob storage
import { Blobber } from "@random-guys/blobber";
import uuid from "uuid/v4";
const tempName = `${uuid()}.pdf`;
const uploader = new Blobber("reports");
context.raw.end();
return await uploader.streamLocalFile(tempName, this.context.raw);
```
Checkout the [examples](https://github.com/random-guys/pdfmills/tree/develop/examples) folder for real life examples.