List

Lists are a convenience wrapper around text fields, splitting input into lines for input and joining them together as output.

Example

{
  type: "list",
  label: "List",
  placeholder: "Enter your text here...",
}

Options

Input

Use these options when using the field with take.

value?
Array<string>
The initial value of the field.
key?
string
A key to access the value. If provided, each field must have a unique key. See make for more information about accessing values.
label?
string
A label describing the purpose of the field.
detail?
string
Additional information about the field, disclosed in a tooltip.
placeholder?
string
Add placeholder text to prompt the user when the field is empty.
spellcheck?
boolean
Enable or disable the browser’s spellchecking feature.
pattern?
string
A regular expression that the input value must match in order for the value to pass validation.
maxlength?
number
The maximum number of characters the user can enter into the input.

Output

Use these options when using the field with make.

value?
Array<string>
The output value of the field.
label?
string
A label describing the purpose of the field.
detail?
string
Additional information about the field, disclosed in a tooltip.

Data

A list field will always return an array. If the value is null or undefined, an empty array is returned.