Skip to main content

createPageDivider

Creates a new page divider, appended to the document's list of children. A page divider is a PageNode with isPageDivider true.

Signature​

createPageDivider(dividerName?: string): PageNode

Parameters​

dividerName​

An optional argument to specify the name of the page divider node. It won't change how the page divider appears in the UI, but it specifies the name of the underlying node. The dividerName must be a page divider name (all asterisks, all en dashes, all em dashes, or all spaces). If no dividerName is specified, the default name for the created page divider node is "---".

Remarks​

A page divider is always the child of the document node and cannot have any children.