JSON

This field can be used to enter and display JSON data. The value is parsed using JSON.parse before it is returned, and stringified before it is displayed.

Example

({
  type: "json",
  label: "JSON",
  placeholder: "Enter your text here...",
})

Options

Input

Use these options when using the field with take.

value?
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?
string
The output value of the field.
replacer?
function |‌ array
Alter the behavior of the stringification process. See MDN for more details.
space?
number |‌ string
Control the way white space is inserted into the JSON text. See MDN for more details.
label?
string
A label describing the purpose of the field.
detail?
string
Additional information about the field, disclosed in a tooltip.

Data

A JSON field will always return an object or array. If the value is null or undefined, an empty object is returned. If the value cannot be parsed, an empty object is returned. Values must conform to the JSON specification, meaning object keys must use quotes.