Docs
Reports
Cover page

Cover page

This feature requires a paid subscription to be used. For more details, see Plans and pricing.

You can add a cover page to your PDF report using the cover_page key in your report JSON. You can specify a background color or image, and also provide a selection of components to display on the cover page (limited to Row, Image, Text and VerticalSpacer).

Example JSON

 
{
    "type": "Report",
    "cover_page": {
        "bg_color": "accent",
        "components": [
            {
                "type": "Text",
                "options": {
                    "colour": "background-default",
                    "size": "4xl",
                    "align": "left",
                    "text": "# Some text is here"
                }
            },
            {
                "type": "Text",
                "options": {
                    "colour": "background-default",
                    "size": "2xl",
                    "align": "right",
                    "text": "Lorem ipsum odor amet, consectetuer adipiscing elit. Mi parturient nascetur egestas luctus suscipit. Pharetra ullamcorper tellus tortor tortor per dis nostra."
                }
            }
        ]
    },
    ...
}

Options
KeyDescription
bg_colorOptional. Sets the background colour using one of the named color theme variables. Refer to themes for more details.
bg_imageOptional. Publicly accessible URL to an image to use as background. If set, this overrides bg_color.
componentsOptional. An array of components to display on the cover page. Only Row, Image, Text and VerticalSpacer are supported. Defaults to [].
alignOptional. The alignment of the components on the cover page. Can be start, center or end. Defaults to center if not set.
vertical_marginOptional. The vertical margin of the cover page. Any integer between 0 and 32. Defaults to 12.
horizontal_marginOptional. The horizontal margin of the cover page. Any integer between 0 and 32. Defaults to 12.

Example

Below is an example of a cover page you can achieve with the various components.

Missing something?

Hybiscus is continuously improving and adding new features. If you think we are missing a critical feature, please do not hesitate to contact us and offer your feedback at support@hybiscus.dev