Skip to main content

ConfigFieldDescriptor

Mirrors the plugin SDK's ConfigField: enough for a console to render the settings form with no per-plugin code

Attributes (17)
AttributeTypeRequiredDescription
keystringYes
labelstringYes
typeConfigFieldTypeYes
requiredbooleanNo
defaultstring | number | booleanNo
unitConfigFieldUnitNonumber only, and ignored elsewhere
controlConfigFieldControlNoslider for a number with both min and max, tags for a string holding a comma-separated set
stepnumberNoHow coarsely a control moves, in the field's own unit. Ignored without one, and defaults to 1
minnumberNonumber only: the smallest value that will be accepted, inclusive
maxnumberNonumber only: the largest value that will be accepted, inclusive
placeholderstringNo
helpstringNo
optionsConfigFieldOption[]No
optionsFromConfigFieldOptionSourceNoChoices only the console can enumerate. Merged where a plugin's own suggestions are, and outranked by them
columnsConfigFieldColumn[]Nolist only, and ignored elsewhere
dependsOnstringNoKey of the field this one is only relevant to
rangeWithstringNoKey of the number field that is the upper end of the range this one opens, declared on the lower end only. Still two settings, each validated by name; the console draws them as one control whose handles cannot cross