String #

The string field generates a field for entering strings. Multiline string values are allowed by enableing this property.

Single line string

Single line string

Multi line string

Multi line string

Properties #

propertyvalue typeoptionaldescription
keystringmandatoryKeys are for internal use and must be unique
titlestringmandatoryThe title of the element
tipstringoptional (default: null)Text entered here with markdown formatting is displayed as context help in an overlay box
defaultstringoptional (default: null)default value when the key is not set yet
multiLinebooleanoptional (default: false)Enable multi line value

Sample #

Configuration #

key: sample_field
multiLine: true
title: Sample field
type: string
key = "sample_field"
multiLine = true
title = "Sample field"
type = "string"
   "key": "sample_field",
   "multiLine": true,
   "title": "Sample field",
   "type": "string"

Output #

sample_field: |-
  Some multiline
  string value