Skip to main content

Checkbox properties

Usage​

{
    type: "checkbox",
    name?: string,
    id?: string,
    value?: string,
    checked?: boolean, // false by default
    text?: string,

    css?: string,
    disabled?: boolean, // false by default
    height?: string | number | "content", // "content" by default
    hidden?: boolean, // false by default
    padding?: string | number, // "8px" by default
    required?: boolean, // false by default
    width?: string | number | "content", // "content" by default

    hiddenLabel?: boolean, // false by default
    label?: string,
    labelPosition?: "left" | "top", // "top" by default
    labelWidth?: string | number,

    helpMessage?: string,
    preMessage?: string,
    successMessage?: string,
    errorMessage?: string,
}

Description​

type(required) the type of a control, set it to "checkbox"
name(optional) the name of a control
id(optional) the id of a control, auto-generated if not set
value(optional) the value of a checkbox
checked(optional) defines the initial state of a checkbox, false (unchecked) by default
text(optional) optional, the text value of a control. It's placed to the right of the control.
css(optional) adds style classes to a control
disabled(optional) defines whether a control is enabled (false) or disabled (true), false by default
height(optional) the height of a control, "content" by default
hidden(optional) defines whether a checkbox is hidden, false by default
padding(optional) sets padding between a cell and a border of a Checkbox control, "8px" by default
required(optional) defines whether a control is required, false by default
width(optional) the width of a control, "content" by default
hiddenLabel(optional) makes the label invisible, false by default
label(optional) specifies a label for a control
labelPosition(optional) defines the position of a label: "left" | "top", "top" by default
labelWidth(optional) sets the width of the label of a control
helpMessage(optional) adds a help message to a control
preMessage(optional) a message that contains instructions for interacting with the control
successMessage(optional) a message that appears in case of successful validation of the control value
errorMessage(optional) a message that appears in case of error during validation of the control value

Example​

Related article: Checkboxes