The Form web component
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.
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.
disableSubmit
Whether to disable form submission.
enableFullBleed
Whether the container is in full bleed mode, where it can only contain a single component which expands to fit the available space.
Properties
event
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 |
false | A user sets the value to |
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
The JavaScript method to perform when type is datasource, widget, state, or localStorage.
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). |
global
Whether the object is globally scoped for use in all app pages.
headerPadding
The amount of padding used within the header.
heightType
Whether the height automatically resizes to fit content or is a fixed size.
Values
fixed | Fixed height. |
auto | Expand to fit content. |
hoistFetching
Whether to display a loading indicator whenever nested components are fetching data.
id
The unique identifier.
initialData
The data used as default values for input fields.
invalid
Whether the value has failed any validation rules.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden is true.
overflowType
The overflow behavior when the contents exceeds the height.
Values
scroll | Display a scrollbar. |
pagination | Use pagination. |
padding
The amount of padding to render inside.
pluginType
The plugin type.
requireValidation
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
Whether to reset input field values using initialData after form submission.
showBorder
Whether to show a border.
showHeader
Whether to show a header area.
showHeaderBorder
Whether to show a border under the header.
showInEditor
Whether to remain visible in the editor if hidden is true.
submitting
Whether the Submit event handler is running.
tooltipText
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
The scroll options.
Properties
behavior
The scroll behavior.
Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block
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. |
setDisabled
Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.
setHidden
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
form.setHidden(hidden)
Parameters
setShowBody
Set the showBody value to toggle whether the component body is visible.
form.setShowBody(showBody)
Parameters
showBody
Whether to show the body.
setShowFooter
Set the showFooter value to toggle whether the component footer is visible.
form.setShowFooter(showFooter)
Parameters
setShowHeader
Set the showHeader value to toggle whether the component header is visible.
form.setShowHeader(showHeader)
Parameters
showHeader
Whether to show a header area.
showBody
Set the showBody value to toggle whether the component body is visible.
form.showBody(showBody)
Parameters
showBody
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.