Skip to main content
Version: Next

Overview

Fields​

nameConditionTypeMandatoryDefault value
componentThe id of the component to use for renderingstringtrueN/A
idThe unique id for this input. Useful for setting default values and recuperating the value on submissionstringtrueN/A
labelThe label to display on top of the input componentstringfalse
dataTypeThe type of data this input accepts. Read morestringfalsestring
paramsPass-through parameters used for customizations. Read moreobjectfalse{}
validationsArray of validation payloads. Read morearrayfalse[]
classNameCSS ClassName. Read morestringfalse
isMultiValidates the value as a valid URL via a regex. Read morebooleanfalsefalse
disabledWhether the field is disabled. Note that Formulaik handled the disable state by itself when there is a submission for example. By setting the value here the Formulaik value will be overriden.booleanfalsefalse

Format​

We recommend to make your inputs serializable unless you don't plan to host them remotely. It's a good practice to make them as declarative as possible. In other words, treat them like JSON data that can be shared, commited, tested and audited independently.

Special inputs​

Some component ids are reserved for inputs Formulaik engines need for running properly.