03.01. Field Types

Type Value Options Description Example
static None None This field type is only used to display static text such as instructions. 
"static": {
    "label": "Static",
    "tooltip": "This is a static field",
    "type": "static",
    "default": "Lorem Ipsum is simply dummy text.",
    "required": true
}
text String None This field type is a regular text input. This is also the default field type if the type used does not exist. 
"text": {
    "label": "Text",
    "tooltip": "This is a text field",
    "type": "text",
    "default": "My default value",
    "required": true
}
password String None This field type is a regular text input that will hide the text by displaying *. 
"password": {
    "label": "Password",
    "tooltip": "This is a password field",
    "type": "password",
    "default": "MyPassword",
    "required": true
}
number Integer None or Object(Keys: min, max) This field type is a number input. 
"number": {
    "label": "Number",
    "tooltip": "This is a number field",
    "type": "number",
    "default": 1234,
    "options": {
        "min": 0,
        "max": 2000
    },
    "required": true
}
raw String/None None This field type is used to output a particular string in the configuration file. When checked, the default value is added in the related section of the .ini file. 
"raw": {
    "label": "Raw",
    "tooltip": "This is a raw field",
    "type": "raw",
    "default": "string",
    "required": false
}
checkbox Boolean None This field type is a regular checkbox. 
"checkbox": {
    "label": "Checkbox",
    "tooltip": "This is a checkbox field",
    "type": "checkbox",
    "default": false,
    "required": true
}
path String None This field type can be used to retrieve paths. You may edit the text input or press the … button to select a path. 
"path": {
    "label": "Path",
    "tooltip": "This is a path field",
    "type": "path",
    "default": "path/",
    "required": true
}
select String Array(Possible Values) This field type is a regular select input. 
"select": {
    "label": "Select",
    "tooltip": "This is a select field",
    "type": "select",
    "default": "Option 2",
    "options": [
        "Option 1",
        "Option 2",
        "Option 3"
    ],
    "required": true
}
multi-select String Array(Possible Values) This field type is a multi-select input. It is used to allow the selection of multiple preset values. The selected values will be converted to CSV 
"multi-select": {
    "label": "Multi-Select",
    "tooltip": "This is a multi-select field",
    "type": "multi-select",
    "default": "Option 1,Option 3",
    "options": [
        "Option 1",
        "Option 2",
        "Option 3"
    ],
    "required": true
}
range Integer None or Object(Keys: min, max) This field type is a range input. 
"range": {
    "label": "Range",
    "tooltip": "This is a range field",
    "type": "range",
    "default": 50,
    "options": {
        "min": 0,
        "max": 100
    },
    "required": true
}
filesize String None or Object(Keys: min, max) This field type is a range input. But it will convert the number of bytes to a human-readable format. 
"filesize": {
    "label": "FileSize",
    "tooltip": "This is a filesize field",
    "type": "filesize",
    "default": 67108864,
    "options": {
        "min": 1048576,
        "max": 134217728
    },
    "required": true
}

To improve the quality of our site, we track visitors anonymously. It doesn't hurt you, but helps us tremendously. We'd be grateful if you'd give us your consent.