Long text field

Use long_text_input to collect a respondent’s multi-line text answer.

Configuration

The table includes the field’s shared properties and its long text properties. See shared field properties for more details on shared properties.

Name	Type	Required	Default	Description
`type`	string	Yes	—	Set to `long_text_input`.
`name`	string	Yes	—	Field name and key in submission data. Use letters, digits, and underscores; start with a letter.
`label`	string	No	No question text is shown	Main question text. Supports `{{field}}` piping.
`subtext`	string	No	None	Smaller text under the label. Supports `{{field}}` piping.
`input_label`	string	No	None	Small text above the input. Supports `{{field}}` piping.
`required`	boolean	No	`false`	Requires an answer before the respondent can leave the page. A required field shows `*` after its label.
`visible_if`	condition array	No	Always shown	Show the field only when the condition is true. An empty array hides it.
`hide_if`	condition array	No	Never hidden	Hide the field when the condition is true.
`placeholder`	string	No	None	Grey hint text inside the empty box. Supports `{{field}}` piping.
`defaultValue`	string	No	None	Prefills the box. May contain a `{{hidden_name}}` reference.
`initialRows`	integer	No	Standard starting height	Starting height in text rows, from 1 to 10. The box grows as the respondent types.

Validation

When a required field is empty or contains only spaces, the respondent cannot leave the page. A field hidden by visible_if or hide_if is not validated.

Submission value

The answer is stored as a string under the field’s name in the submission data:

{
  "project_details": "We are planning a spring launch and need help with the timeline."
}

Example

{
  "type": "long_text_input",
  "name": "project_details",
  "label": "Tell us about your project",
  "subtext": "Include your goals, timeline, and anything else we should know.",
  "input_label": "Project details",
  "placeholder": "We are planning to...",
  "initialRows": 5,
  "required": true
}