Textfield

A text field allowing the user to read and edit textual data.

Configurable properties

• Field label: Label displayed on top of the text field.
• Field description: Description provided below the text field.
• Key: Binds the field to a form variable, see data binding docs.
• Default value: Provides a default value for the text field in case no input data exists for the given key.
• Disabled: Disables the text field, for use during development.
• Hide if: Expression to hide the text field.
• Columns: Space the field will use inside its row. Auto means it will automatically adjust to available space in the row. Read more about the underlying grid layout in the Carbon Grid documentation.
• Validation: Given that one of the following properties is set, the form will only submit when the respective condition is fulfilled. Otherwise, a validation error will be displayed.
  • Required: Text field must contain a value.
  • Regular expression validation: Use predefined validation patterns. Available options are: Email, Phone, and Custom.
  • Minimum length: Text field must have at least n characters.
  • Maximum length: Text field must not have more than n characters.
  • Regular expression pattern: Text field value must match the provided RegEx pattern.
• Appearance: Changes the visual appearance of the text field.
  • Prefix: Adds an appendage before the input.
  • Suffix: Adds an appendage after the input.

info

The phone pattern adheres to the international E.164 standard, omitting spaces; for example, +491234567890.

For custom formats, use the Custom validation option.

Datatypes

Text Fields can be bound to boolean, string, and number data, but will cohere the data into a string, which will lead the data to be written back to the process as a string when the form is submitted.