FormSchema

The form schema object.

PropertyTypeDescription
namestringThe name of the form
typestringAction of the form - create new or edit existing data
fieldsFormFieldList of fields

FormField

The form field object.

PropertyTypeDescription
keystringThe unique key of the field
labelstringTextual label for a field
disabledbooleanFlag if field is editable
placeholderstringText displayed when field value is empty
hintstringTextual hint for a field
requiredbooleanFlag that inidcates is the field value required or not
loadingbooleanFlag displaying a loading state for a field in case of dynamic data
valueanyContains starting value, in case of editing existing data
fieldFormFieldFieldType of the field
typeFormFieldTypeType of an a native input field to be displayed
buttonsarraySpecial case for displaying control buttons, like 'Submit'
settingsanyFurther extension of field behaviour

FormFieldField

Types of fields that are available to be used on the form:

;(INPUT = 'input'),
(DROPDOWN = 'dropdown'),
(BUTTON = 'button'),
(TOGGLE = 'toggle'),
(DATE = 'date'),
(TAGS = 'tags'),
(PLUGIN = 'plugin') //used for custom plugins

FormFieldType

Available values

text
password
number
email

Docs v.0.14.0 Copyright © 2024