printpreview

0.1.20 • Public • Published

printpreview

A library for rendering print previews. Built to aid server-side pdf generation. Helps creates a scalable section representing a collection of printable pages.

Provides

  • CSS rules
  • JavaScript API for defining the abstraction, checking values and the production of styling

JS Classes

Preview

get document() Return a Document instance.

get medium() Return a Medium instance.

get stylesheet() Return CSS styling.

toJSON() Returns a JSON representation of the preview.

Medium

static get orientations() Returns ['Portrait', 'Landscape'].

static get sizes() Returns ['A5','A4','A3','B5','B4','JIS-B5','JIS-B4','Letter','Legal','Ledger'];.

static get widths() Returns ['148mm','210mm','297mm','176mm','250mm','182mm','257mm','216mm','216mm','279mm'].

static get heights() Returns ['210mm','297mm','420mm','250mm','353mm','257mm','364mm','279mm','356mm','432mm'].

set orientation(name) Sets the orientation to one of the defined values.

get orientation() Returns the currently set orientation.

set size(name) Sets the sizes to one of the defined values.

get size() Returns the currently set size.

get width() Returns the width of the currently set size.

get height() Returns the height of the currently set size.

get classes() Returns the medium class names for the specified size and orientation.

toJSON() Returns a JSON representation of the medium.

Document

get Page() Returns the Page class.

createPage(options) Creates and appends a new Page instance to the pages array.

get pages() Returns an array of Page instances.

toJSON() Returns a JSON representation of the document.

Page

static get orientations() Returns ['Portrait', 'Landscape'].

set orientation(name) Sets the orientation to one of the defined values.

get orientation() Returns the currently set orientation.

set data(value) Set the data for this page.

get data() Returns the data for this page.

get classes() Returns the class name for the specified orientation.

toJSON() Returns a JSON represetation of the page.

CSS Classes

.print__preview Defines the print preview container and its font size.

.print__medium .print__medium-portrait .print__medium-landscape .print__medium-a5 .print__medium-a4 .print__medium-a3 .print__medium-b5 .print__medium-b4 .print__medium-jis-b5 .print__medium-jis-b4 .print__medium-letter .print__medium-legal .print__medium-ledger Defines the document medium size. CSS @page size. US paper sizes.

.print__page .print__page-portrait .print__page-landscape Defines the page dimensions and orientation.

.print__page__size Defines the page margins.

print__page__size__inner Defines the page content section.

Readme

Keywords

none

Package Sidebar

Install

npm i printpreview

Weekly Downloads

0

Version

0.1.20

License

ISC

Unpacked Size

248 kB

Total Files

15

Last publish

Collaborators

  • oliverfoster