Skip to main content

The Form component for Retool Mobile

A form to group and submit input fields.

Demo

Settings​

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

AlignDataDisabledExpand contents to fitEvent handlersGapHeightShow on desktopShow on mobileAlignDirectionLoadingMaintain 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.

The horizontal alignment of the contents.

Values
left

Left alignment.

center

Center alignment.

right

Right alignment.

data​

any[]

The source data.

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

disableSubmit​

boolean

Whether to disable form submission.

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. Refer to the events section for a list of supported events.

method​

enum

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

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.

gap​

enum

The gap between components.

Values
0
4
8
12
16
24
32
48
64
128
256

global​

boolean

Whether the object is globally scoped for use in all app pages.

headerPadding​

string

The amount of padding used within the header.

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

Values
fixed

Fixed height.

auto

Expand to fit content.

​

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.

Whether the component is visible in the desktop layout.

Whether the component is visible in the mobile layout.

The horizontal alignment of the contents.

Values
left

Left alignment.

center

Center alignment.

right

Right alignment.

stretched

Justified alignment

The layout of content.

Values
row

Horizontal row layout.

column

Vertical column layout.

loading​

boolean

Whether to display a loading indicator.

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

The amount of margin to render outside.

Values
4px 8px

Normal margin.

0

No margin.

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.

showBody​

boolean

Whether to show the body.

Whether to show a border.

Whether to show a footer area.

Whether to show a border above the footer.

Whether to show a header area.

Whether to show a border under the header.

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.

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

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

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

​

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

Whether to show a footer area.

setShowHeader​

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

form.setShowHeader(showHeader)
Parameters

Whether to show a header area.

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.