Skip to content
Moritz Tim W. edited this page Nov 7, 2023 · 17 revisions

Quick Start

Get a form up and running in 10 steps.

Installing the plugin

  1. Install the plugin from the Asset Library tab in Godot. Or by following the Installation instructions.

Creating the structure

  1. Add a FormContainer to your scene.
  2. Add a Container of your choice as a child of the FormContainer to hold the form elements.
  3. For each form element, add a FormLabel and any input Control.
  4. Finally, add a Submit button.

Hooking everything up

  1. In the inspector of your FormContainer, set the Submit Button property to your Submit button.
  2. In the inspector of each element, set the input property to the corresponding Control node.

Configuring the form

  1. In the inspector of your FormContainer, choose and set up a Protocol. Currently supported protocols are:

Of course, you can also implement your own protocol by extending the Protocol class or any of its descendants.

  1. In the inspector of each FormLabel, set the input_required property if needed.
  2. In the inspector of each input Control, set and configure the Validator property with rules.
Clone this wiki locally