The Single Checkbox component presents one toggle checkbox for binary yes/no input. It can be pre-checked by default and supports standard display, data storage, and validation settings.
How to read settings tables
The tables below describe each configurable option as it displays in the UnqorkAI platform. Values are formatted as follows:
inline code— a value to type exactly as shown | Bold — a value selected from a drop-down, radio button, tab, or choice chip | ON/OFF — toggle state | ✓ — checkbox checked | ☐ — checkbox unchecked
General Settings
Setting | Field | Type | Default | Description |
|---|---|---|---|---|
Property ID |
| Text input |
| The unique identifier for this component instance. |
Display Settings
Field Text
Setting | Field | Type | Default | Description |
|---|---|---|---|---|
Label Text |
| Text input | — | Identifies the component on the canvas and informs end-users what information is requested. |
Contextual Help
Setting | Field | Type | Default | Description |
|---|---|---|---|---|
Tooltip |
| Text input | — | A brief description that displays when a cursor is positioned over the tooltip icon. |
Helper Text |
| Text input | — | A single line of guidance text that always displays below the checkbox. |
Default State Options
Setting | Field | Type | Default | Description |
|---|---|---|---|---|
Hide Label |
| Toggle | OFF | Hides the label. The label remains visible in the Module Builder. |
Hide Field |
| Toggle | OFF | Hides the component from end-users but always displays in the Module Builder. |
Formatting
Setting | Field | Type | Default | Description |
|---|---|---|---|---|
Set Default Value to Checked |
| Toggle | OFF | Pre-checks the checkbox when the module loads. |
Input Behavior
Setting | Field | Type | Default | Description |
|---|---|---|---|---|
Behavior | — | Drop-down | Enable User Input | Sets how end-users can interact with the checkbox. |
Enable User Input (default): End-users can check or uncheck the checkbox.
Display as Text (
readOnlyView): Displays the stored value as plain text without the checkbox element. ShowsNonewhen empty.Disable User Input (
disabled): Prevents end-users from changing the checkbox state. The checkbox displays with an altered appearance to indicate it is not editable.
Data Settings
Data Storage
Setting | Field | Type | Default | Description |
|---|---|---|---|---|
Store Data in Database |
| Toggle | ON | When set to ON, this setting this setting stores field values to the database when the module saves, end-users navigate between Panel components, or end-users navigate between workflow screens. Set to OFF to exclude this field from server-side submissions. |
Fields with Store Data in Database set to OFF are excluded from Plug-In component's API responses and Unqork's built-in tracker. When using a Plug-In component to remote-execute a module, any component whose value must be included in the API response requires Store Data in Database set to ON.
Actions Settings
Triggers
Setting | Field | Type | Default | Description |
|---|---|---|---|---|
Trigger |
| Property ID | — | Triggers another component when the checkbox state changes. |
Validation Settings
User Input
Setting | Field | Type | Default | Description |
|---|---|---|---|---|
Required |
| Toggle | OFF | Requires the checkbox to be checked before the module can be submitted. |
Required Error Message |
| Text input |
| Displays when the required checkbox is unchecked. |
Advanced Settings
Additional Styling
Setting | Field | Type | Default | Description |
|---|---|---|---|---|
Custom CSS Class |
| Text input | — | A CSS class applied to the component for custom styling. |
Changelog
Date | Change |
|---|---|
— | Initial publication. |