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 Unqork IDE. 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
key
Text input
checkboxv2
The unique identifier for this component instance.
Display Settings
Field Text
Setting
Field
Type
Default
Description
Label Text
label
Text input
—
Identifies the component on the canvas and informs end-users what information is requested.
Contextual Help
Setting
Field
Type
Default
Description
Tooltip
tooltip
Text input
—
A brief description that displays when a cursor is positioned over the tooltip icon.
Helper Text
helperText
Text input
—
A single line of guidance text that always displays below the checkbox.
Default State Options
Setting
Field
Type
Default
Description
Hide Label
hideLabel
Toggle
OFF
Hides the label. The label remains visible in the Module Builder.
Hide Field
hidden
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
defaultChecked
Toggle
OFF
Pre-checks the checkbox when the module loads.
Input Behavior
Setting
Field
Type
Default
Description
Input 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. Shows None when 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
persistent
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.
Note: 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
trigger
Property ID
—
Triggers another component when the checkbox state changes.
Validation Settings
User Input
Setting
Field
Type
Default
Description
Required
validate.required
Toggle
OFF
Requires the checkbox to be checked before the module can be submitted.
Required Error Message
errors.required
Text input
is required
Displays when the required checkbox is unchecked.
Advanced Settings
Additional Styling
Setting
Field
Type
Default
Description
custom CSS class
customClass
Text input
—
A CSS class applied to the component for custom styling.
Changelog
Date
Change
—
Initial publication.
The browser-based workspace where Creators build, edit, review, and manage Unqork applications. Also referred to as the Unqork platform. The IDE replaces what was previously referred to as UDesigner and Classic Designer, which are considered legacy.
A Property ID is the unique field ID used by Unqork to track and link components in your module.
Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field.
Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field.
The Unqork tool used to build individual modules by placing and configuring components on a canvas.
The VCS (version control system) Contributor role has permissions to edit modules in a branch. Set contributors during the VCS Create a Branch process.
APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services.
Cumulative Layout Shift (CLS) measures how much elements in a webpage shift while using it. Some search engines use the CLS metric to rate a website's accessibility in their search rankings.
Cascading Style Sheets (CSS) is a style sheet language used for presenting how a HTML or XML document looks to end-users.
