The JSON Schema Form component for Retool Apps

A JSON-defined form to group and submit input fields.

JSON Schema Form is based on the react-jsonschema-form library. You define which input fields to include and how they are rendered using JSON and UI schemas.

The component can also populate nested input field values using default data.

Settings

JSON Schema Form includes the following configurable options when building apps in the IDE.

DataEvent handlersHiddenShow on desktopShow on mobileLoadingMaintain space when hiddenMarginAlways show in edit modeStyles

Properties

All properties for JSON Schema Form with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

clearFormAfterSubmit

boolean

Whether to clear the form after submission.

data

any[]

The source data.

events

object[]

A list of configured event handlers that trigger actions or queries.

Properties

event

enum

The event type.

Values

change	A user changes the value.
click	A user clicks or taps the component.
submit	A user submits the value.
focus	A user selects the input field.
blur	A user deselects the input field.
scan	A user scans a barcode.
open	A user opens the component.
close	A user closes the component.
true	A user sets the value to true.
false	A user sets the value to false.
select	A user selects a value.
clear	A user clears the value.
upload	A user uploads a file.
parse	An uploaded file is parsed.
inputValueChange	A user changes the value of the input field.

method

enum

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

type

enum

The type of action to perform.

Values

datasource	Control query.
widget	Control component.
script	Run script.
state	Set variable.
localStorage	Set localStorage.
util	Perform utility action (e.g., Open URL or Confetti).

hidden

boolean

Whether the component is visible.

hideSubmit

boolean

Whether to hide the submit button.

id

string

The unique identifier.

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

jsonSchema

object

The schema that describes the data for the form.

liveValidate

boolean

Whether live validation is enabled.

loading

boolean

Whether to display a loading indicator.

maintainSpaceWhenHidden

boolean

Whether the component takes up space on the canvas if hidden is true.

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

onSubmit

pluginId

The query that's triggered when the form is submitted.

pluginType

string

The plugin type.

showInEditor

boolean

Whether to remain visible in the editor if hidden is true.

style

object

Custom style options in use. Not all style options may be available for all components.

submitButtonFullWidth

boolean

Whether to set the submit button to full width.

submitButtonText

string

The text displayed on the submit button.

submitDisabled

string

Whether to disable the submit button.

uiSchema

object

The schema that only describes UI elements within the form.

Methods

JavaScript API methods for interacting with JSON Schema Form. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

clear

Clear all values. The initial value must be an empty object (e.g., { }). Returns a void Promise when the method resolves.

jsonSchemaForm.clear()

scrollIntoView

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

jsonSchemaForm.scrollIntoView(scrollIntoViewOptions)

Parameters

scrollIntoViewOptions

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

block

enum

The scroll position relative to the component.

Values

nearest	Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view.
start	Scrolls to position the component at the top of the visible area.
center	Scrolls to position the component in the middle of the visible area.
end	Scrolls to position the component at the bottom of the visible area.

setData

Set child input values.

jsonSchemaForm.setData(data)

Parameters

data

any[]

The source data.

submit

Submit the form.

jsonSchemaForm.submit()

Events

Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.

submit

Input values are submitted.