Skip to main content
CYPEX Documentation
Support
v2.0.0 Latest stable release View changelog ->
Inputs Referencegenerated

Text Input

Unformatted text input

Technical id
default_text_input
Translation keys
labelhelperText

An interactive single-line or multiline text entry box featuring optional start/end adornments (icons/text), a helper text tooltip ‘?’ button, and direct form validation state indicators.

When to use

  • Capturing standard short or multiline text entries (e.g. names, notes, addresses) inside forms.
  • Binding form fields to backend schema paths to handle automatic validation errors, touch states, and value change tracking.
  • Providing text inputs with regex validation patterns, helper tooltips, or prefix/suffix adornments.

What you need

Requires a valid Data Source object containing an elementId (matching the target Form ID) and a fieldPath array mapping to a specific field name. The target Form must have view fields available.

  • Form-bound text fields, single string schema attributes, or multiline text properties.

  • Data Source section attributes remain locked until at least one default_form exists on the page. Auto-suggests the nearest parent form if nested inside one.

Examples

  • A standard ‘First Name’ input bound to a parent user profile form field (['firstName']).
  • A multiline ‘Comments’ box configured with 4 visible lines and a helper tooltip explaining character limits.
  • A postal code text input with a custom Regex Pattern enforcing valid local postal code formats.

Avoid

  • Using for long-form prose requiring rich toolbar controls (bold, headers, links) — use the markdown_input component instead.
  • Configuring a static Default Value or custom Regex Pattern while Data Source form-binding is active, as form context overrides local defaults and clears regex pattern editors.
  • Attempting to add a Data Source binding when no parent or sibling default_form exists on the page canvas.

Use instead

  • Markdown Input — The user needs a rich text editor toolbar with markdown formatting capabilities.
  • Number Input — The entry requires numeric mask formatting, decimal precision, or number incrementing controls.

Pairs well with

  • Form — Provides form context, validation handling, touched states, and write-back change handlers.

Editor properties

Configure these in the Application Designer property panel. Group headings mirror the editor where possible. Data Source is where the element gets its rows or field binding (a view/query, a connector operation, or a parent form field). References appear only for view-backed sources and map foreign-key ID columns to readable labels from another view.

Data Source

Binds this input to a parent form field. Choose the form element and the field path; local default-value and pattern rules are disabled once a binding is set.

Element IDrequiredNumber or TextInside `dataSource`
Another element on the page whose data backs this field.
Default: none
Field PathrequiredList of Text or NumberInside `dataSource`
Path into the source element’s data (property segments).
Default: none
Setup
MultilineoptionalNumber
Boolean switch enabling multiline text box entry and vertical scrolling.
Default: none
Translation
Tooltip PlacementoptionalOne of: top, end, start, bottom
Controls the position placement of the helper text tooltip relative to the input element.
Choices
  • top
  • end
  • start
  • bottom
Default: none
Input
Default ValueoptionalNot set (null)
Initial text value preloaded into local state. Automatically disabled when Data Source is connected.
Default: none
Regex PatternoptionalText
Regular expression pattern enforcing text format rules in local state mode. If validation fails, displays ‘Value does not match the required pattern’. Hidden/cleared when Data Source is connected.
Default: none
DisabledoptionalYes / no or Custom expression (yes/no)
When true, the control cannot be edited.
Example false
Default: none
NullableoptionalYes / no or Custom expression (yes/no)
Whether the field may be left empty.
Example false
Default: none
Styling
Start AdornmentoptionalText
Static text string or icon key placed on the left side of the input field.
Default: none
End AdornmentoptionalText
Static text string or icon key placed on the right side of the input field.
Default: none

Sizing

  • No size of its own: dropped at the platform default of 1 × 1 grid cells and resized on the page.

Translatable labels

  • label — Visible text label positioned directly above the input box.
  • helperText — Tooltip content shown when hovering over the ‘?’ helper button.

Accessibility

Renders standard semantic input (<input type='text'> or <textarea>). ARIA attributes convey validation error states, label linkage (aria-labelledby), and helper tooltip content (aria-describedby).

  • Tab moves focus into and out of the text entry field.
  • Standard text navigation and editing keyboard shortcuts apply.

Values you can read in expressions

Other parts of your app can read live values from this element in custom expressions:

elements.myTextInput.<property>

value string | number Current input value of this control. elements.myTextInput.value

When What the user has typed so far, updating on every keystroke and before the form is saved. Use it to filter a table live, or to build a preview elsewhere on the page.

errors any The data validation errors. elements.myTextInput.errors
touched boolean Indicates whether the user has typed anything in the input. elements.myTextInput.touched
disabled boolean True while the control is locked and cannot be edited. elements.myTextInput.disabled

To use one of these, open the property you want to drive on the other element, switch it to expression mode in the Expression Editor, and enter:

1
elements.myTextInput.value

Replace myTextInput with this element’s unique id. Select the element in Application Designer and copy the id chip at the top of the right-hand property panel.

Where you can place it

Drag this element into one of these containers:

Placement notes

  • Form — Automatically detects and auto-suggests nearest parent default_form container. When connected, local Default Value becomes disabled and Regex Pattern editor is hidden/cleared.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
{
  "config": {
    "dataSource": {
      "elementId": "myElement",
      "fieldPath": [
        "fieldPath"
      ]
    },
    "defaultValue": "defaultValue",
    "disabled": false,
    "nullable": false,
    "startAdornment": "startAdornment",
    "endAdornment": "endAdornment",
    "startAdornmentIcon": "startAdornmentIcon",
    "endAdornmentIcon": "endAdornmentIcon",
    "multiline": 0,
    "regexPattern": "regexPattern",
    "tooltipPlacement": "top"
  }
}

Ready-made setups

A text input bound to a parent form field with helper text tooltip, start icon adornment, and automatic form state validation.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  "config": {
    "data_source": {
      "elementId": "userRegistrationForm",
      "fieldPath": [
        "firstName"
      ]
    },
    "translation": {
      "label": "First Name",
      "helperText": "Enter your legal first name as it appears on official identity documents.",
      "tooltipPlacement": "top"
    },
    "input": {
      "disabled": "@@expression: false",
      "nullable": false
    },
    "styling": {
      "startAdornmentType": "icon",
      "startAdornmentValue": "person"
    }
  }
}

Notes

Description

The TextInput is used to display a text box.

config

propertytypedescriptionrequired
startAdornmentstringThe helper name to display at the start
endAdornmentstringThe helper name to display at the end
startAdornmentIconstringThe icon name to display at the start
endAdornmentIconstringThe icon name to display at the end
multilinestringNumber of multiline rows