A quick description of the field. If omitted, the name will be used as label.
The name uniquely identifies the input field and is used to store the value in the output
structure, i.e. if
field.name === 'myFieldName', then the value chosen by the user
is available in the output stucture in
output['myFieldName']. Note that the section
structure is irrelevant for the output structure, just the name uniquely identifies the
If this is set to true, the form cannot be submitted if this fields value is empty or undefined.
The type uniquely identifies which kind of form field is used, e.g. 'string', 'integer'. This tells the library which form field manager should be used to handle this form field.
A description for either a field or a section. If undefined or false, it will not be shown. If its a JSX.Element, it will be rendered as description. If its a string, the string will be rendered. If its an array of strings, they will be rendered as distinctive paragraphs.
A form field describes a type of input, i.e. text input, number input etc.
You can add your own form field by extending
AbstractFormField and implementing
Generated using TypeDoc
An optional verbose description which will only be shown when the field is expanded.