page-wrapping

1.1.0 • Public • Published

page-wrapping

npm Travis

Generic page wrapping algorithm proposal.

How it works

import wrapPage from 'page-wrapping'
 
// Create node instance.
// It can be whatever type of construction you want, but should always if support Node interface (see below).
const node = Node({ left: 20, top: 20, width: 100, height: 100 })
 
// Start page wrapping process.
// You should pass as first argument the page children (in this case only one node),
// and as second argument the page height used to wrap the elements.
await wrapPage([node], 40)
 
// [
//   { left: 20, top: 20, width: 100, height: 20 },
//   { left: 20, top: 0, width: 100, height: 40 },
//   { left: 20, top: 0, width: 100, height: 40 }
// ]

Node interface

Property Description Type
left Node x coordinate Number
top Node y coordinate Number
width Node width Number
height Node height Number
minPresenceAhead Presence ahead of element to not to break Number
wrap Whether a node should be able to split in two or more Boolean
break Whether a node should create a page break Boolean
fixed Whether a node should repeat throughout all pages Boolean
parent Node pointer to parent Node
children Children nodes Array
appendChild Add node as children Function
remove Detach node from paren Function
clone Returns a copy of target node Function
nodeWillWrap Callback before element wrap. Can return promise Function
onNodeSplit Callback after element is split in two Function
isEmpty Returns if node is empty or not Function

Dependents (19)

Package Sidebar

Install

npm i page-wrapping

Weekly Downloads

10,576

Version

1.1.0

License

MIT

Unpacked Size

22.7 kB

Total Files

6

Last publish

Collaborators

  • diegomura