Checkbox

A checkbox input component that provides a three-state toggle functionality. Supports true/false/null states with configurable null state support, custom styling, and keyboard accessibility. Ideal for boolean inputs or multi-state selections.

Extends: fieldComponent

Fields

Name

Code

Data Type

Description

Label

label

multi-locale

Display label for the checkbox

ID

resourceId

text

Unique identifier for the component

Style Classes

styleClasses

text

CSS classes for styling

Width

widthClass

text

Controls component width

Value

value

text

Current checkbox state

Visible

isVisible

boolean

Controls component visibility

Enabled

enabled

boolean

Controls whether component is enabled

Field Style

fieldStyle

text

Additional field styling options

Allow Null

allowNull

boolean

Allows a third indeterminate state (null) in addition to checked and unchecked when enabled

Methods

Name

Description

fromValue

Converts the input value to the checkbox's internal state representation

toValue

Converts the checkbox's internal state to the output value format

onCheckboxChange

Handles checkbox state changes and updates the model value

Events

Name

Description

onChange

Triggered when the checkbox state is changed

onBlur

Triggered when the checkbox loses focus

onFocus

Triggered when the checkbox gains focus