List
Lists are a convenience wrapper around text fields, splitting lines of text into an array of strings 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? | The initial value of the field. |
key? | A key to access the value. If provided, each field must have a unique key. See make for more information about accessing values. |
label? | A label describing the purpose of the field. |
detail? | Additional information about the field, disclosed in a tooltip. |
placeholder? | Add placeholder text to prompt the user when the field is empty. |
spellcheck? | Enable or disable the browser’s spellchecking feature. |
pattern? | A regular expression that the input value must match in order for the value to pass validation. |
maxlength? | The maximum number of characters the user can enter into the input. |
Output
Use these options when using the field with make
.
value? | The output value of the field. |
label? | A label describing the purpose of the field. |
detail? | 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.