JSON Schema Form

A form with input fields that are dynamically generated using JSON Schema and UI Schema. It supports live validation of input changes, default form data, and can display a loading indicator.

JSON Schema Form can automatically generate the necessary Schema for a specified resource database table.

Properties

Available properties for JSON Schema Form. You can write JavaScript almost anywhere in Retool to manipulate or read information about components.

NameDescriptiondata

The data currently entered into the form.

jsonSchema

A schema that describes the data for this form.
The format of the JSON schema is described here.

uiSchema
onSubmit

The name of query configured to run on form submit

clearFormAfterSubmit

True if the clear after submission setting is toggled on

submitDisabled

The value of the disable form submission setting. Set to true to disable form submission

loading

The value of the show loading indicator setting. Set to true to show a loading indicator

submitButtonText

The text on the form submit button

submitButtonFullWidth

True if the make submit button full width setting is toggled on

liveValidate

True if the live validation setting is toggled on

hideSubmit

Hides the submit button of the form

Events

Events are triggered by user interactions with JSON Schema Form. Use event handling to trigger queries or other actions in response to events.

NameDescriptionSubmit

A user submits the current value.

Methods

Methods for interacting with JSON Schema Form. You can write JavaScript almost anywhere in Retool and use methods to manipulate data or components.

NameDescriptionscrollIntoView(options: any)

Scrolls the canvas or parent container so that the selected component appears in the visible area.

submit()

Submit the form.

clear()

Reset and clear the form

setData(data: object)

Set the JSON Schema to generate the form