Skip to main content

Submit Form

The submit form component allows you to create a submit form linked to a runnable. It has a submit button that triggers a runnable when clicked.

The runnable parameters are defined:

  • Static: the parameter is defined in the component configuration.
  • User input: the parameter is defined by the user input.
  • Eval: the parameter is connected to an output.

Only user inputs are displayed in the form.

The following section details Submit Form component's specific settings. For more details on the App Editor, check the dedicated documentation or the App Editor Quickstart:


This component can be controlled by frontend scripts using these functions:


The setValue function is meant to set or force the value of a component. This can be convenient in cases where connection is not the easiest pattern. Note that it's a bad idea to mix dynamic default value and setValue together.

setValue(id: string, value: any)


Make a specific field of a form in a Validate state.

validate(id: string, key: string)


Make all fields of a form in a Validate state.

validateAll(id: string, key: string)


Invalidate a specific field of a form

invalidate(id: string, key: string, error: string)

Form configuration

labelstringtruefalseSubmitThe button label.
colorblue, red, dark, light, green, graytruefalsedarkThe button color.
sizexs, sm, md , lg, xltruefalsesmThe button size.

The form component has a special parameters called On Success and On Error.

The options for On Success are:

The options for On Error are:


resultanyThe result of the runnable.
loadingbooleanThe loading state of the button.
jobIdstringThe job id of the runnable.