Overview
Fields​
name | Condition | Type | Mandatory | Default value |
---|---|---|---|---|
component | The id of the component to use for rendering | string | true | N/A |
id | The unique id for this input. Useful for setting default values and recuperating the value on submission | string | true | N/A |
label | The label to display on top of the input component | string | false | |
dataType | The type of data this input accepts. Read more | string | false | string |
params | Pass-through parameters used for customizations. Read more | object | false | {} |
validations | Array of validation payloads. Read more | array | false | [] |
className | CSS ClassName. Read more | string | false | |
isMulti | Validates the value as a valid URL via a regex. Read more | boolean | false | false |
disabled | Whether 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. | boolean | false | false |
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.