The Form component for Retool Apps

A form to group and submit input fields.

Form can automatically generate input fields from a database or Table component, and populate nested input field values using default data.

Settings

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

DataDisabledExpand contents to fitEvent handlersHeightHiddenShow on desktopShow on mobileLoadingMaintain space when hiddenMarginOverflowShow borderFooterShow borderHeaderShow borderAlways show in edit modeStylesHelper text

Properties

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

data

any[]

The source data.

disabled

boolean

Whether input, interaction, selection, or triggering is disabled.

disableSubmit

boolean

Whether to disable form submission.

enableFullBleed

boolean

Whether the container is in full bleed mode, where it can only contain a single component which expands to fit the available space.

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).

footerPadding

string

The amount of padding used within the footer.

headerPadding

string

The amount of padding used within the header.

heightType

enum

Whether the height automatically resizes to fit content or is a fixed size.

Values

fixed	Fixed height.
auto	Expand to fit content.

hidden

boolean

Whether the component is visible.

hoistFetching

boolean[]

Whether to display a loading indicator whenever nested components are fetching data.

id

string

The unique identifier.

initialData

formDataProvider

The data used as default values for input fields.

invalid

boolean

Whether the value has failed any validation rules.

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

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.

overflowType

enum

The overflow behavior when the contents exceeds the height.

Values

scroll	Display a scrollbar.
pagination	Use pagination.

padding

number

The amount of padding to render inside.

pluginType

string

The plugin type.

requireValidation

boolean

Whether all input fields must be valid for the form to submit. If valid is false for any input field, the Invalid event handler is triggered.

resetAfterSubmit

boolean

Whether to reset input field values using initialData after form submission.

showBorder

boolean

Whether to show a border.

showFooter

boolean

Whether to show a footer area.

showFooterBorder

boolean

Whether to show a border above the footer.

showHeader

boolean

Whether to show a header area.

showHeaderBorder

boolean

Whether to show a border under the header.

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.

submitting

boolean

Whether the Submit event handler is running.

tooltipText

string

The tooltip text to display.

Methods

JavaScript API methods for interacting with 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.

form.clear()

clearValidation

Clear the validation message from the input field.

form.clearValidation()

reset

Reset all child inputs to default values or clears them if no default values are set.

form.reset()

scrollIntoView

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

form.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.

form.setData(data)

Parameters

data

any[]

The source data.

setDisabled

Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.

form.setDisabled(disabled)

Parameters

disabled

boolean

Whether input, interaction, selection, or triggering is disabled.

setHidden

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

form.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.

setShowBody

Set the showBody value to toggle whether the component body is visible.

form.setShowBody(showBody)

Parameters

showBody

boolean

Whether to show the body.

setShowFooter

Set the showFooter value to toggle whether the component footer is visible.

form.setShowFooter(showFooter)

Parameters

showFooter

boolean

Whether to show a footer area.

setShowHeader

Set the showHeader value to toggle whether the component header is visible.

form.setShowHeader(showHeader)

Parameters

showHeader

boolean

Whether to show a header area.

showBody

Set the showBody value to toggle whether the component body is visible.

form.showBody(showBody)

Parameters

showBody

boolean

Whether to show the body.

submit

Submit the form.

form.submit()

validate

Validates the value of the input field.

form.validate()

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.

invalid

The value is invalid.

submit

Input values are submitted.