Represents a check box control.
Use a CheckBox to give the user an option, such as true/false or yes/no. The CheckBox control can display an image or text or both.
CheckBox and RadioButton controls have a similar function: they allow the user to choose from a list of options. CheckBox controls let the user pick a combination of options. In contrast, RadioButton controls allow a user to choose from mutually exclusive options.
The Appearance property determines whether the CheckBox appears as a typical CheckBox, a button, or as a switch.
The ThreeState property determines whether the control supports two or three states. Use the Checked property to get or set the value of a two-state CheckBox control and use the CheckState property to get or set the value of a three-state CheckBox control.
For a full list of properties, methods and events see the API documentation.
The Checkbox features three preset check states: Checked, Unchecked, and Indeterminate. These can be toggled using the CheckState property.
The Checkbox icon can be configured to show on the left or right side of the text.
Icons can be placed in various places around the checkbox including above, below, beside, and more.
Item | Description |
---|---|
Class name
"wisej.web.CheckBox"
Theme appearance
"checkbox", see Themes.
Child components
"icon" is the checkbox icon, "label" is the text. See JavaScript.
Source code