Skip to main content

Combo properties

type(string) the type of a control, set it to "combo"
name(string) the name of a control
id(string) the id of a control, auto-generated if not set
value(string, array) specifies the id(s) of Combo items from data collection which values should appear in the input:
  • if multiselection:true is set for a combo, the property takes an array of string values as: value: ["id_1","id_2","id_3"],
  • if multiselection:false is set or the multiselection config is not defined, the property gets either of the two values: value:"id_1" or value: ["id_1"]
data(array) an array of Combo options. Each option is an object with a set of key:value pairs - attributes of options and their values.
  • The id attribute is returned and goes to form data. This attribute should always be fulfilled to avoid unexpected behavior
  • The value attribute is displayed in the input field
newOptions(boolean) allows end users to add new values into the list of combobox options. To add a new value, the user needs to type it into the input field and either press "Enter" or click on the appeared Create "newValue" option in the drop-down list.
validation(function) the validation function, takes as a parameter the value to validate and returns true/false to indicate the result of validation
width(string, number, "content") the width of a control
height(string, number, "content") the height of a control
padding(string, number) sets padding between a cell and a border of the Combo control
css(string) adds style classes to a control
placeholder(string) sets a placeholder in the input of Combo
disabled(boolean) defines whether a control is enabled (false) or disabled (true)
required(boolean) defines whether the field with Combo is required (for a form)
hidden(boolean) defines whether a control is hidden
readonly(boolean) makes Combo readonly (it is only possible to select options from the list, without entering words in the input)
label(string) specifies a label for a control
labelWidth(string, number) sets the width of the label of a control
hiddenLabel(boolean) invisible label that will be used to identify the input on the server side
labelPosition(string) defines the position of a label: "left"|"top"
helpMessage(string) adds a help message to a control
preMessage(string) a message that contains instructions for interacting with the control
successMessage(string) a message that appears in case of successful validation of the control value
errorMessage(string) a message that appears in case of error during validation of the control value
itemHeight(number) sets the height of a cell in the list of options
listHeight(number) sets the height of the list of options
template(function) sets a template of displaying options in the popup list
filter(function) sets a custom function for filtering Combo options. Check the details.
multiselection(boolean) enables selection of multiple options in Combo
selectAllButton(boolean) defines whether the Select All button should be shown
itemsCount(boolean, function) shows the total number of selected options
virtual(boolean) enables dynamic loading of data on scrolling the list of options