Skip to main content

Form

Type: form

Form container that submits child values together.

Supports children: Yes

A form container that collects child input values and submits them on button click. If `param` is provided, all child values are broadcast as one JSON object to that parameter. If omitted, each child field is broadcast individually. Children use their own `param` prop to register with the form. Supported child types: text-input, text-area, number-input, datetime-input, camera-input, color-input, dropdown, slider, and text.

Example

{
"type": "form",
"props": {
"param": "form_data",
"submitLabel": "Submit"
},
"children": [
{ "type": "text-input", "props": { "label": "Name", "param": "user_name" } },
{
"type": "dropdown",
"props": {
"label": "City",
"param": "city",
"sql": "SELECT DISTINCT city AS value, city AS label FROM {{my_udf}} ORDER BY city"
}
}
]
}

Every widget is defined as { "type": "form", "props": { ... } }. The properties below describe the props object.

Props

Loading ....

Raw schema

Download the full schema file: /widget-schema/form.json