typedef TextOptions

package shared.component.field

import shared.component.field.Text

Text fields can hold single or multiline text and can be content restricted by using ruleset.

{
  "key": "intro_title",
  "label": "Intro title",
  "type": "Text"
}

Properties

@:optionalautogrow:Null<Bool>

Text field will expand if its content doesn't fit on a single line.

"autogrow": true

@:optionalhelp:Null<Dynamic>

Adding help or instructional text to a field.

"help": "This field can only contain letters."

@:optionalhidden:Null<Bool>

Hide this field in the interface.

"hidden": true

@:optionalmax_length:Null<Int>

Can limit the length of the text field. There will be a counter to see how many characters you already have.

"max_length": 160

@:optionalminimal:Null<Bool>

Hide the label of the textfield.

"minimal": true

@:optionalmonospace:Null<Bool>

Layout field in monospace font, can be used for scripts

@:optionalmultiline:Null<Bool>

Allow line breaks.

"multiline": true

@:optionaloverview:Null<Bool>

@:optionaloverview_editable:Null<Bool>

@:optionaloverview_filter:Null<Bool>

@:optionaloverview_searchable:Null<Bool>

@:optionalprefix:Null<String>

Add a visual prefix to the field

@:optionalprovides_metadata:Null<String>

Can prefill metadata like the title or the description.

"provides_metadata": "title"
"provides_metadata": "description"

@:optionalreadonly:Null<Bool>

Field is read only.

"readonly": true

@:optionalrequired:Null<Bool>

This field can't be empty.

"required": true

@:optionalruleset:Null<String>

Restrict content to a certain ruleset.

"ruleset": "email"
"ruleset": "number"
"ruleset": "url"

@:optionalshow_when:Null<EitherType<ShowOptions, Array<ShowOptions>>>

The "value" can be set to "null" of "!null" to check if something is empty.

@:optionalsuffix:Null<String>

Add a visual suffix to the field

@:optionalvalue:Null<Any>

@:optionalwidth:Null<Float>

Width percentpoint 0-1.

"width": 0.5"