Checkbox interface

Hierarchy

Properties

Classes: string[]

Additional CSS classes to add to the control.

Enabled: boolean

Enabled state of the UI element. When the type supports this, the UI element will be disabled when set to false.

Id: string

The id of the UI element.

Label: string

The label of the checkbox. Can use full HTML.

Name: string

Name of the UI element. For form fields that would be the name otherwise used for reference only.

OnChange: ((checkbox) => void)

Type declaration

    • (checkbox): void
    • Change event when the checkbox value is changed.

      Parameters

      Returns void

ParentClasses: string[]

Additional CSS classes to add to the parent control when supported.

StandardClasses: string[]

The standard classes of the control. Modify this property only if you know what you are doing.

Tags: string[]

Tags for the UI element. Used for reference only.

TextDirection: TextFieldTextDirection

The text direction of the UI element. Defaults to Inherit, meaning it will use the editor default.

ToolTip?: string

Tooltip text of the UI element.

Type: "CheckBox"

The type of the UI element. Always "CheckBox".

Value: boolean

The current value of the checkbox.

Visible: boolean

Visibility flag of the UI element. When not visible it will be hidden from the UI.

Generated using TypeDoc