Skip to content

Commit

Permalink
add migration guide
Browse files Browse the repository at this point in the history
  • Loading branch information
liborm85 committed Dec 31, 2021
1 parent c740b1e commit 1e571c1
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 2 deletions.
8 changes: 6 additions & 2 deletions content/document-definition-object/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,12 @@ var dd = {
{text: '3 Headline', headlineLevel: 1},
'Some long text of variable length ...',
],
pageBreakBefore: function(currentNode, followingNodesOnPage, nodesOnNextPage, previousNodesOnPage) {
return currentNode.headlineLevel === 1 && followingNodesOnPage.length === 0;
pageBreakBefore: function(currentNode, nodeContainer) {
// nodeContainer.getFollowingNodesOnPage();
// nodeContainer.getNodesOnNextPage();
// nodeContainer.getPreviousNodesOnPage();

return currentNode.headlineLevel === 1 && nodeContainer.getFollowingNodesOnPage().length === 0;
}
}
```
Expand Down
38 changes: 38 additions & 0 deletions content/migration-from-0.1/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
+++
title = "Migration from 0.1"
description = ""
weight = 9
alwaysopen = true
+++

#### Unified interfaces and all methods return promise

[See Methods for client-side](/docs/0.3/getting-started/client-side/methods/).

[See Methods for server-side](/docs/0.3/getting-started/server-side/methods/).


#### Changed including virtual font storage in client-side

Regenerate virtual file system (VFS) is required.


#### Changed parameters of pageBreakBefore function

Version 0.1 or 0.2:
```js
pageBreakBefore: function(currentNode, followingNodesOnPage, nodesOnNextPage, previousNodesOnPage) {

}
```

Version 0.3:
```js
pageBreakBefore: function(currentNode, nodeContainer) {
// nodeContainer.getFollowingNodesOnPage();
// nodeContainer.getNodesOnNextPage();
// nodeContainer.getPreviousNodesOnPage();
}
```

[See documentation](/docs/0.3/document-definition-object/page/#dynamically-control-page-breaks-for-instance-to-avoid-orphan-children).

0 comments on commit 1e571c1

Please sign in to comment.