Field Types / HTML field

Note: You are currently reading the documentation for Bolt 5.0. Looking for the documentation for Bolt 5.2 instead?

A WYSIWYG HTML field. You can supply extra options to it to customize the behaviour and appearance.

Basic Configuration:¶

        content:
            type: html

Example usage in templates:¶

To print out the HTML field you just need to do in your templates:

{{ record.content }}

Options:¶

The field has a few options to change the appearance and functionality of the field.

• allow_twig can be set to true or false to control if twig may be used in the field.
• height can be set to a number, e.g. 10 rows, or to a CSS length unit, e.g. 150px or 50vh.

Input Sanitisation¶

All content in this field type will be sanitised before it gets inserted into the database. This means that only 'whitelisted' HTML like <b> and <img src="…"> is kept, while things like <embed> and <script> are scrubbed from the field before being stored. As a site-implementor you can control the whitelisted tags and attributes using the following section in config.yaml:

htmlcleaner:
    allowed_tags: [ div, span, p, br, hr, s, u, strong, em, i, b, li, ul, ol, …, … ]
    allowed_attributes: [ id, class, style, name, value, href, src, alt, title, …, … ]

To disable sanitisation for this field, you can add sanitise: false to the field config, like so:

        title:
            type: html
            sanitise: false