Checkbox

To insert a checkbox in a task, use the {{field type= "checkbox" name= " <field ID>"}} component. Field ID must match the field name in the output data description. For example, a set of three checkboxes:

{{field type="checkbox" name="red" label="red" hotkey="1"}}
{{field type="checkbox" name="green" label="green" hotkey="2"}}
{{field type="checkbox" name="yellow" label="yellow" hotkey="3"}}
Full list of parameters

Parameter

Description

Required

Default value

type

Field type: checkbox.

yes

no

name

Field ID. Must match the field name in the output data description.

yes

no

label

Signature. For example, label="Yes".

no

no

hotkey

The shortcut for selecting a value.

no

no

value

The value to pass (written to the output file).

Supported values: true, false.

no

false

validation-show

The position of popup hints (displayed if the response didn't pass validation). The position is relative to the input field.

Supported values:

  • Above the input field: "top-left", "top-center", "top-right".

  • Below the input field: "bottom-left", "bottom-center", "bottom-right".

  • To the left of the input field: "left-top", "left-center", "left-bottom".

  • To the right of the input field: "right-top", "right-center", "right-bottom".

  • Don't display the message ("false").

no

"top-left"

checked

The state of a checkbox when the page is displayed:

  • checked=true — Checked.

  • checked=false — Unchecked.

no

false

size

Size of the field.

Supported values: "M", "L".

no

"L"

width

Width of the field. Set in the following units:

  • Pixels. For example, width="100px".

  • Percentage of the size of the parent element. For example, width="100%".

You can also use a formula for setting the width. For example, width="calc(100%-30px)".

no

depends on the length of the signature

disabled

Whether data can be edited:

  • disabled=true — The field can't be edited.

  • disabled=false — The field can be edited.

no

false

class

The CSS class for the field. For example, class="annotation".

no

".field" ".field_type_checkbox"

Add a field of boolean type to the output data description. For example:
{
  "red": {
    "type": "boolean",
    "required": true
  }
}