Unqork documentation is available in two workspaces: UnqorkAI for the latest AI-first platform, and legacy Unqork for previous versions. Use the drop-down near the logo to switch.

Radio Buttons Component

Prev Next

The Radio component presents a group of mutually exclusive options for end-users to select from. Options can be defined manually or loaded from another field using a Data Reference Key.

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

key

Text input

radioField

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

description

Text input

—

A brief description that displays when a cursor is positioned over the tooltip icon.

Formatting

Setting

Field

Type

Default

Description

Horizontal Layout

inline

Toggle

OFF

Displays the radio buttons in a horizontal row instead of a vertical list.

Show as Button Group

buttonGroup

Toggle

OFF

Renders the options as styled button groups instead of traditional radio buttons.

Default State Options

Setting

Field

Type

Default

Description

Display as Text

readOnlyView

Toggle

OFF

Displays the stored value as plain text without the input element. Shows None when empty.

Disable User Input

disabled

Toggle

OFF

Prevents end-users from selecting an option. The component displays with an altered appearance to indicate it is not editable.

Hide Field

hidden

Toggle

OFF

Hides the component from end-users but always displays in the Module Builder.

Data Settings

Data Source Type

Setting

Field

Type

Default

Description

Data Source Type

dataSrc

Choice chip

Values

Sets how options are loaded.


Values — Manually define a list of options.

Column

Field

Type

Description

Option Label

label

Text input

The display text shown to end-users for each option.

Value to Store in Submission Data

value

Text input

The value stored in the database when the option is selected.


Data Reference Key — Load options from another module field.

Setting

Field

Type

Default

Description

Data Reference Key

data.dataReferenceKey

Property ID

—

The Property ID of a field that returns a JSON array to use as the option source.

Value Property

valueProperty

Property ID

—

The property in each array item to use as the stored value.

Label Path

labelProperty

Text input

—

The property in each array item to use as the display label (for example, label, name).

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.

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 selection changes.

Validation Settings

User Input

Setting

Field

Type

Default

Description

Required

validate.required

Toggle

OFF

Requires an option to be selected before the module can be submitted.

Required Error Message

errors.required

Text input

is required

Displays when the required field has no selection.

Advanced Settings

Setting

Field

Type

Default

Description

Require Unique Submission Data

unique

Toggle

OFF

Ensures the selected value has not been submitted before in another submission.

Custom CSS Class

customClass

Text input

—

A CSS class applied to the component for custom styling.