Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/harvestprofit/docflux-pdfs
pdfMake PDF parser for DocFlux
https://github.com/harvestprofit/docflux-pdfs
Last synced: about 1 month ago
JSON representation
pdfMake PDF parser for DocFlux
- Host: GitHub
- URL: https://github.com/harvestprofit/docflux-pdfs
- Owner: HarvestProfit
- License: mit
- Created: 2019-01-04T19:38:08.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-27T21:47:03.000Z (over 1 year ago)
- Last Synced: 2024-11-16T03:26:02.688Z (about 2 months ago)
- Language: JavaScript
- Size: 2.3 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DocFlux PDFs
[](https://www.npmjs.com/package/@harvest-profit/doc-flux-pdfs) [](https://travis-ci.org/HarvestProfit/DocFlux-PDFs) [](https://coveralls.io/github/HarvestProfit/DocFlux-PDFs?branch=master) [](https://github.com/HarvestProfit/DocFlux-PDFs/blob/master/LICENSE)
Allows you to create pdfMake pdfs using [DocFlux](https://github.com/HarvestProfit/DocFlux).
## Example
This will generate a table with 2 rows in it.
```jsx
import { DocFlux } from '@harvest-profit/doc-flux';
/** @jsx DocFlux.createElement */
export default ExampleComponent = () => (
Name
Age
John
24
Jill
25
);
```
## Document Example
```jsx
const style = {
fonts: {
Roboto: {
normal: 'https://cdnjs.cloudflare.com/ajax/libs/pdfmake/0.1.66/fonts/Roboto/Roboto-Regular.ttf',
bold: 'https://cdnjs.cloudflare.com/ajax/libs/pdfmake/0.1.66/fonts/Roboto/Roboto-Medium.ttf',
italics: 'https://cdnjs.cloudflare.com/ajax/libs/pdfmake/0.1.66/fonts/Roboto/Roboto-Italic.ttf',
bolditalics: 'https://cdnjs.cloudflare.com/ajax/libs/pdfmake/0.1.66/fonts/Roboto/Roboto-MediumItalic.ttf',
},
OtherFont: {
normal: 'urltootherfont',
},
},
css: {
differentFont: {
color: 'blue',
font: 'OtherFont',
bold: false
},
'font-weight-bold': {
bold: true,
},
},
default: {
font: 'Roboto',
fontSize: 10,
color: '#333333',
},
};
class ExampleDoc extends PDFDocument {
static propTypes = {
name: PropTypes.string.isRequired,
}
static documentStyling = style;
static documentSettings(props) {
return {
name: props.name,
pageMargins: [30, 55, 30, 40],
info: {
title: 'Sample Document',
author: 'john doe',
subject: 'Sampling Document Building',
keywords: 'sample',
creator: 'Harvest Profit',
producer: 'Harvest Profit',
},
};
}
// Override this method to log document definition for debugging
// static createDocument(docDefinition) {
// console.log(docDefinition);
// }
static component = ExampleComponent;
}
const doc = ExampleDoc.create({
name: 'sample.pdf',
names: ['John', 'Jill'],
ages: [24, 25],
});
doc.download();
// You can also just open this in the browser via
// doc.open();
```
## Styling and Configuration
Styling can be a bit tricky (mostly layout stuff like columns). You can use [pdfmake playground](http://pdfmake.org/playground.html) to try out the styling.
Be sure to check out the documentation for PDFMake on what other styling and font
things you can do. You can always use a `` component
to gain access to the PDFmake api.
## Development
[Clone](https://help.github.com/articles/cloning-a-repository/) this repo, and begin committing changes. PRs are preferred over committing directly to master.
To run tests locally on your machine, run the following:
```bash
yarn run test
```
To preview documentation locally on your machine, run the following:
```bash
yarn run build-docs
```
After merging your pull request, consider updating the documentation with the following command:
```bash
yarn run publish-docs
```
To deploy a new version to NPM, bump the version number, commit/merge to `master`, and run the following:
```bash
yarn run clean
yarn run build
# Either NPM
npm publish
# Or Yarn, they do the same thing
yarn publish
```
## License
This project is [MIT licensed](https://github.com/HarvestProfit/DocFlux-PDFs/blob/master/LICENSE)