Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arnaudjuracek/svg-to-pdf
pre-press oriented node.js module to transform a SVG string into printable PDF file
https://github.com/arnaudjuracek/svg-to-pdf
pdf pdf-generation print svg svg-to-pdf
Last synced: about 2 months ago
JSON representation
pre-press oriented node.js module to transform a SVG string into printable PDF file
- Host: GitHub
- URL: https://github.com/arnaudjuracek/svg-to-pdf
- Owner: arnaudjuracek
- License: mit
- Created: 2019-12-18T15:37:35.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-08T14:16:20.000Z (11 months ago)
- Last Synced: 2024-10-31T18:06:08.038Z (about 2 months ago)
- Topics: pdf, pdf-generation, print, svg, svg-to-pdf
- Language: JavaScript
- Homepage:
- Size: 245 KB
- Stars: 14
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# svg-to-pdf
_pre-press oriented node.js module to transform a SVG string into printable PDF file_
* [Features](#features)
+ [Limited support](#limited-support)
+ [Not supported (yet)](#not-supported-yet)
+ [Not supported, won't be supported](#not-supported-wont-be-supported)
* [Installation](#installation)
* [Usage](#usage)
* [Development](#development)
* [Credits](#credits)
* [Related](#related)
* [License](#license)
## Features
- Support for this SVG elements:
+ ``
+ ``
+ ``
+ ``
+ ``
+ ``
+ ``
+ ``
+ ``
+ ``
+ ``
+ ``
+ ``
+ ``
+ ``
- **Group inheritance** (ie: `` will pass its `color=green` attribute to its children)
- All [`PDFKit`](http://pdfkit.org/) vector graphics supported operations
- PDF **file permissions** and limitations w/ password support
- PDF file **metadatas edition** (author, subject, keywords, etc…)
- Length units support and implicit conversion to PDF points
- Support for **uncalibrated CMYK colors** using [`device-cmyk()`](https://www.w3.org/TR/2014/WD-SVG2-20140211/color.html#devicecmyk), as described in the [SVG 2 Working draft 11](https://www.w3.org/TR/2014/WD-SVG2-20140211/Overview.html)
- [Pre-press inspired **pre-flight process**](https://en.wikipedia.org/wiki/Pre-flight_(printing)), which gives insight and warnings after generating a PDF file
- **Pre-press** related features such as bleed area and printers marks:
+ crop marks
+ colors marks
+ registration marks
### Limited support
- `viewBox` attribute is parsed only on the `` root element, so all system coordinates must be absolute
- The [`preserveAspectRatio`](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio) attribute is fully supported, **but only on the `` element**
- `` elements are rendered only if they do not have complex structure (such as nested element)
- Supported `` specific presentation attributes are:
+ `dominant-baseline`
+ `font-family`
+ `font-size`
+ `letter-spacing`
+ `text-anchor`
+ `word-spacing`
- `%` unit _should_ work as intended, but some bugs can occur when working in complex coordinates systems (like viewports deep nest)
### Not supported, won't be supported
#### CSS styling
Use [`svgo`](https://github.com/svg/svgo) beforehand to apply CSS styling as element attributes:
```yaml
full: false
plugins:
- inlineStyles:
useMqs:
- ''
- screen
- print
- removeStyleElement
- converStyleToAttrs
```
**NOTE:** see [`svgo` guide](https://github.com/svg/svgo/blob/master/docs/how-it-works/en.md#1-config) to read more about `svgo` config.
## Installation
```console
$ npm install --save svg-to-pdf
```
## Usage
```js
const SVG2PDF = require('svg-to-pdf')
const options = {
docPath: '/tmp/file.pdf',
// All attributes refering to an external file path will be resolved from
// this root path
rootPath: process.cwd(),
// color space can be either 'rgb' or 'cmyk'
colorSpace: 'rgb',
// SVG specification specifies that all unitless lengths are expressed in a
// so-called "user unit", usually defaulting to pixel
userUnit: 'px', // 'px', 'mm', 'cm', 'pt', 'in'…
// Pre-press related features
bleed: 0, // '10mm', '100px', 10
marks: {
colors: true,
crop: true,
registration: true
},
// Attach an additional [...files] array to the output, providing further
// insights on PDF generation.
// Be warned that files analysis can be perf heavy.
createFilesReport = true,
// PDF file options, see PDFKit
pdfVersion: 1.3,
userPassword: undefined,
ownerPassword: undefined,
permissions: undefined,
title: '',
subject: '',
author: '',
producer: 'arnaudjuracek/svg-to-pdf@semver',
keywords: ''
}
// using Promises
SVG2PDF(svgString, options)
.then(({ warnings, files }) => console.log(warnings))
.catch(error => console.error(error))
// using async/await
;(async () => {
const { warnings, files } = await SVG2PDF(svgString, options)
console.log(warnings)
})()
```
**Note:** for PDF file related options, see [`PDFKit` options](http://pdfkit.org/docs/getting_started.html#setting_document_metadata).
## Development
```console
$ npm test # run svg-to-pdf against test/sample.svg
$ npm test -- --input=path/to/file.svg --output=path/to/output.svg --color-space=rgb|cmyk
```
## Credits
- SVG initial parsing is done thanks to [`svg-parser`](https://github.com/Rich-Harris/svg-parser/).
- PDF file is generated with [`PDFKit`](http://pdfkit.org/).
## Related
- [`SVG-to-PDFKit`](https://github.com/alafr/SVG-to-PDFKit/)
## License
[MIT.](https://tldrlegal.com/license/mit-license)