Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vivliostyle/vivliostyle-print
🖨 Use Vivliostyle for printing
https://github.com/vivliostyle/vivliostyle-print
vivliostyle
Last synced: 17 days ago
JSON representation
🖨 Use Vivliostyle for printing
- Host: GitHub
- URL: https://github.com/vivliostyle/vivliostyle-print
- Owner: vivliostyle
- License: agpl-3.0
- Created: 2018-09-30T14:33:14.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-20T15:28:52.000Z (22 days ago)
- Last Synced: 2024-11-20T15:41:52.476Z (22 days ago)
- Topics: vivliostyle
- Language: JavaScript
- Homepage:
- Size: 20.7 MB
- Stars: 35
- Watchers: 11
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-vivliostyle - @vivliostyle/print - page-layouting using Vivliostyle Core for printing within a website without destroying the original layout. (Official)
- awesome-vivliostyle - @vivliostyle/print - page-layouting using Vivliostyle Core for printing within a website without destroying the original layout. (Official)
README
# vivliostyle-print
Allows page-layouting using the vivliostyle for printing within a website without destroying the original layout
How do I use it?
======
1. Install vivliostyle-print like this within your browser-based JavaScript project:
```
npm install @vivliostyle/print --save
```
2. Use it within your project like this:
```js
import {printHTML} from '@vivliostyle/print'
const htmlDoc = `
... Add your CSS code here ...
... Add your HTML code here ...
`,
config = {
title: 'my printed page',
printCallback: iframeWin => iframeWin.print() // optional: only needed if calling something other than window.print() for printing.
errorCallback: message => alert(message) // optional: only needed if you want to handle errors.
}
printHTML(htmlDoc, config)
```
You can also take a look at the [demo](https://vivliostyle.github.io/vivliostyle-print/) ([sourcecode](/demo)) .
How do I build and run the demo?
======
1. Download the repo to your local machine, for example using::
```
git clone https://github.com/vivliostyle/vivliostyle-print.git
```
2. Enter the folder::
```
cd vivliostyle-print
```
3. Install and build it::
```
npm install
npm run build_demo
```
4. Serve the demo folder, for example using the simple PHP webserver::
```
php -S localhost:8000 -t demo/
```
5. Access the demo from a web browser by navigating to http://localhost:8000
Why would I use this rather than regular Vivliostyle?
======
On larger projects, it can be difficult to ensure that no developer is accidentally
breaking the terms of the Vivliostyle AGPL license. Vivliostyle-print only exposes
one of the functions of Vivliostyle that does not allow the sharing of complex data
structures between surrounding code and Vivliostyle, which is the most important
requirements to follow when using VIvliostyle in combination with a non-open source
project. For more information cocnerning the license, read
[this](https://vivliostyle.org/faq/#Vivliostyle%20License%20FAQ).
Please report any bugs and open pull requests on the
[Vivliostyle main repo](https://github.com/vivliostyle/vivliostyle.js).