typedef DropdownOptions

package shared.component.field

import shared.component.field.Dropdown

A dropdown list of multiple options that can be set hardcoded or can be generated.

{
  "key": "align",
  "label": "Align",
  "type": "Dropdown",
  "options": {
    "options": {
      "left": "Left",
      "right": "Right"
    }
  }
}

Properties

@:optionalas_string:Null<Bool>

Save value as string instead of array, can not be used for multiple.

     * "as_string": true
     * ```

@:optionalautocomplete_url:Null<Bool>

Use in conjuction with options_from_url to make options function as autocomplete

@:optionaldefault_value:Null<String>

Deprecated, use 'value'

@:optionalempty_label:Null<String>

Deprecated

@:optionalfixed:Null<Array<String>>

These options are selected and cannot be unselected

@: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

@:optionalminimal:Null<Bool>

Hide the label of the textfield.

"minimal": true

@:optionalmultiple:Null<Bool>

Choose more than one option.

"multiple": true

@:optionaloptions:Null<Dynamic>

All options in object notation: {'key': 'Label'}

@:optionaloptions_from_parent:Null<{project:String, key:Null<String>, id:Null<Int>}>

Entries as options

@:optionaloptions_from_url:Null<String>

Load options using an ajax request

@:optionaloverview:Null<Bool>

@:optionaloverview_editable:Null<Bool>

@:optionaloverview_filter:Null<Bool>

@:optionaloverview_searchable:Null<Bool>

@:optionalplaceholder:Null<Dynamic>

Choose a custom label (eg. 'Select an author')

@:optionalreadonly:Null<Bool>

Field is read only.

"readonly": true

@:optionalrequired:Null<Bool>

This field can't be empty.

"required": true

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

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

@:optionalvalue:Null<Any>

@:optionalwidth:Null<Float>

Width percentpoint 0-1.

"width": 0.5"