From 1e571c18ba8a3aeba39c04ec7140903a978b385a Mon Sep 17 00:00:00 2001 From: Libor M Date: Fri, 31 Dec 2021 16:15:26 +0100 Subject: [PATCH] add migration guide --- content/document-definition-object/page.md | 8 +++-- content/migration-from-0.1/_index.md | 38 ++++++++++++++++++++++ 2 files changed, 44 insertions(+), 2 deletions(-) create mode 100644 content/migration-from-0.1/_index.md diff --git a/content/document-definition-object/page.md b/content/document-definition-object/page.md index b1a62cb..0172664 100644 --- a/content/document-definition-object/page.md +++ b/content/document-definition-object/page.md @@ -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; } } ``` diff --git a/content/migration-from-0.1/_index.md b/content/migration-from-0.1/_index.md new file mode 100644 index 0000000..befe943 --- /dev/null +++ b/content/migration-from-0.1/_index.md @@ -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).