Skip to main content

CheckboxGroup properties

CheckboxGroup properties#

type(string) the type of a control, set it to "checkboxGroup"
name(string) the name of a control
id(string) the id of a control, auto-generated if not set
options(object) an object with options of a CheckboxGroup. The object can contain the following attributes:
  • width - (string, number, "content") the width of a CheckboxGroup
  • height - (string, number, "content") the height of a CheckboxGroup
  • padding - (string, number) sets padding between a cell and a border of a CheckboxGroup
  • css - (string) adds style classes to a CheckboxGroup
  • rows - (array) arranges checkboxes inside the CheckboxGroup control vertically
  • cols - (array) arranges checkboxes inside the CheckboxGroup control horizontally
value(object) the initial value of a CheckboxGroup. The value contain a set of key:value pairs where key is the id of a checkbox and value defines the initial state of the checkbox. The option has a higher priority than the checked attribute of a checkbox.
width(string, number, "content") the width of a control
height(string, number, "content") the height of a control
css(string) adds style classes to a control
disabled(boolean) defines whether a control is enabled (false) or disabled (true)
hidden(boolean) defines whether a CheckboxGroup is hidden
required(boolean) defines whether a control is required
padding(string, number) sets padding between a cell and a border of a CheckboxGroup control
label(string) specifies a label for 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"
labelWidth(string, number) sets the width of the label of a control
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

Properties of a Checkbox of CheckboxGroup#

type(string) the type of a control, set it to "checkbox"
id(string) the id of a control, auto-generated if not set
value(string) the value of a checkbox
checked(boolean) defines the initial state of a checkbox
text(string) the text label of a checkbox
width(string|number|"content") the width of a checkbox
height(string|number|"content") the height of a checkbox
padding(string|number) sets padding between a cell and a border of a checkbox
css(string) adds style classes to a a checkbox
hidden(boolean) defines whether a checkbox is hidden