A control that allows a user to make a choice between one or several opposite options by toggling them.

Checkbox control

Related sample:  All dhxForm inputs - DHTMLX Form

Related sample:  Checkboxes - DHTMLX Form

Adding Checkbox

You can easily add a Checkbox control during initialization of a form:

var form = new dhx.Form("form_container", {
    rows: [
            type: "checkbox",
            label: "I agree",
            name: "agree",
            labelInline: true,
            id: "agree",
            value: "checkboxvalue"


You can provide the following attributes in the configuration object of a Checkbox:

  • type - (string) the type of a control, set it to "checkbox"
  • id - (string) the id of a control, auto-generated if not set
  • checked - (boolean) defines the initial state of a checkbox
  • value - (string) the value of a checkbox
  • hidden - (boolean) defines whether a checkbox is hidden

  • parent - (string) the id of the parent control
  • width - (string) the width of a control
  • height - (string) 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)
  • label - (string) specifies a label for a control
  • labelWidth - (string) 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
  • labelInline - (boolean) defines the position of a label: true - to set a label inline with a control
  • name - (string) the name of a control
  • required - (boolean) defines whether a control is required
  • help - (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
  • gravity - (boolean) arranges form controls evenly throughout the container, depending on the direction of layout ("cols" or "rows"), true by default
Back to top