Page break

The PageBreak component is used to force a page break.

Schema

Below is an example of the schema required to define a PageBreak component:

{
    "type": "PageBreak",
    "options": {}
}

There are no options required to define a PageBreak component.

The PageBreak component cannot be used inside a Section component, as a Section is defined to prevent a page break.

The PageBreak component is used to split content over multi-page PDF reports, which is only supported in the paid plans. See here for more details.

Page breaks only work with multi-page PDF reports, which means you must have configured your schema to create multi-page reports using the config.n_pages option. Please refer to the documentation here for more details.