Edit on GitHub
Jump to docs navigation

Field Types / Text field

Note: You are currently reading the documentation for Bolt 3.6. Looking for the documentation for Bolt 3.5 instead?

Simple text-input, for single-line fields.

Basic Configuration:

        name:
            type: text

Example usage in templates:

{{ record.name }}

Options:

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

  • class Can be set to either of the:
    • narrow to make the field more narrow
    • large to make both the field and the font larger
  • allowtwig can be set to true or false to control if twig may be used in the field
  • variant set to inline to show the label next to the field instead of above it.
  • pattern Use this to validate the field against a certain pattern.
  • placeholder Placeholder text inside the input control.

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.yml:

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, …, … ]

By design, you can not disable the sanitation entirely. If you need to allow the editors to insert unfiltered HTML or javascript, use a type: textarea field instead.

Edit this page on GitHub
Couldn't find what you were looking for? We are happy to help you in the forum, on Slack or on IRC.