Skip to main content

Text

The text field is used for capturing single-line text inputs. It is versatile and suitable for names, titles, or any short textual data.

Example

fields:
  full_name:
    type: text
    label: Full Name
    placeholder: Enter your full name
    minlength: 3
    maxlength: 50

Field Properties

Name Type Default Description
aria string –

Optional aria label for better accessibility.
autofocus bool false

Set autofocus on field.
error string | array –

Costum error message for translation or customization.
help string | array –

Optional help text below the field
label string | array –

The field label can be set as string or associative array with translations
maxlength int –

Specifies the maximum number of characters allowed for the input.
minlength int –

Defines the minimum number of characters required for the input.
placeholder string | array –

Optional placeholder value that will be shown when the field is empty.
required bool –

Defines whether the field is mandatory for form submission.
title string | array –

Tooltip displayed when the user hovers over the field (supports multilingual configurations).
username bool false

Boolean. If set to true, this field is used to mark a username and will be used in confirmation emails or as the sender name in the receiver emails.
width string 1/1

The width of the field in the 12 columns field grid.

Validation Logic

The text field automatically enforces:

  • Minimum Length minlength: Ensures the input contains at least the specified number of characters.
  • Maximum Length maxlength: Ensures the input does not exceed the defined character limit.