Address field

Use address_input to collect an address as free text in one input. It does not split the address into structured parts.

Configuration

Every address field accepts the shared field properties. See shared properties.

Name	Type	Required	Default	Description
`type`	string	yes	n/a	Set to `address_input`.
`name`	string	yes	n/a	Field name and submission key. Use at least one letter, digit, or underscore; start with a letter.
`label`	string	no	No question text shown	Main question text.
`subtext`	string	no	none	Smaller text under the label.
`input_label`	string	no	none	Small text above the input.
`required`	boolean	no	`false`	Require an answer before the respondent leaves the page.
`visible_if`	condition array	no	Always shown	Show the field only when the condition is true.
`hide_if`	condition array	no	Never hidden	Hide the field when the condition is true.
`placeholder`	string	no	none	Hint text inside the empty input. Supports `{{field}}` piping.

Validation

If the field is required, an empty answer or an answer containing only spaces blocks the page. The address is free text; its format is not checked.

Submission value

The answer is stored as a string under the field’s name key.

{
  "shipping_address": "123 Main St, Springfield, IL 62701"
}

Complete configuration example

{
  "type": "address_input",
  "name": "shipping_address",
  "label": "Where should we ship your order?",
  "subtext": "Include the apartment or unit number, if applicable.",
  "input_label": "Shipping address",
  "placeholder": "123 Main St, Springfield, IL 62701",
  "required": true
}