Dropdown
Displays a dropdown.
Interface
interface IDropdownField extends IBaseField {
options?: IDropdownOption[];
optionsColumnName?: string;
communityFieldName?: string;
value?: string | number;
filterProperty?: string;
filterField?: string;
multiSelect?: boolean;
selectDefaultFirstValue?: boolean;
}
Example
{
"name": "pageDesign",
"type": "Dropdown",
"label": {
"en-US": "Page design",
"es-ES": "Diseño de página"
},
"description": {
"en-US": "Select a page design to create the article",
"es-ES": "Seleccione el diseño de páginapara crear el artículo"
},
"validation": {
"required": false
},
"options": "{pageDesigns}"
}
Properties
type
Must be “Dropdown”.
-
Type:
"Dropdown"
-
Required: Yes
options
Options for the dropdown.
-
Type:
IDropdownOption[]
-
Required: No
optionsColumnName
Column name with field options. If this property is reported, it is not necessary to report the options property.
-
Type:
string
-
Required: No
communityFieldName
Name property of the communityPicker of the form that indicates the selected community. It is required if property optionsColumnName is reported.
-
Type:
string
-
Required: No
value
Default value of dropdown.
-
Type:
string | number
-
Required: No
filterProperty
Indicates the option array property by which you want to filter the option set.
-
Type:
string
-
Required: No
filterField
Indicates the value of the form field by which you want to filter the set of options.
-
Type:
string
-
Required: No
multiSelect
Allows to select more than 1 option.
-
Type:
boolean
-
Required: No
selectDefaultFirstValue
If the value is true
, it will mark by default the first option.
-
Type:
boolean
-
Required: No
-
Default value:
false