The Matrix component captures data across rows and columns simultaneously, in a spreadsheet-style input grid. Each row represents a collection (question or item) and each column represents a property (choice or attribute). The component supports table and inline display modes.
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
survey
The unique identifier for this component instance.
Display Settings
Field Text
Setting
Field
Type
Default
Description
Canvas Label Text
label
Text input
—
Identifies the component on the Module Builder canvas. Does not display.
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
Display Type
verticalDisplay
Choice chip
Table
Sets how the matrix displays to end-users. • Table: A grid with column headers. • Inline: A vertical series of radio-button groups.
Table
Setting
Field
Type
Default
Description
Header for Optional Text Field Column
detailsText
Text input
—
Adds a text field column to the matrix with this heading.
Display Text Fields When Triggered by
detailsCondition
Text input
—
A value from the Columns/Properties table that, when selected, triggers a required text field.
Inline
Setting
Field
Type
Default
Description
Tooltip
description
Text input
—
A brief description that displays when a cursor is positioned over the tooltip icon.
Input Behavior
Setting
Field
Type
Default
Description
Input Behavior
—
Drop-down
Enable User Input
Sets how end-users can interact with the field.
Enable User Input (default): End-users can make selections in the matrix.
Disable User Input (disabled): Prevents end-users from making selections. The matrix displays with an altered appearance to indicate it is not editable.
Read Only - Legacy (htmlReadOnly): Makes the matrix non-editable using the legacy implementation. End-users can view and copy the content.
Rows/Collections
Defines the rows of the matrix. Each row represents one item or question.
Column
Field
Description
Label
label
The display label for this row.
Value
value
The stored value identifier for this row.
Columns/Properties
Defines the columns of the matrix. Each column represents one selectable property or choice.
Column
Field
Description
Label
label
The display label for this column header.
Value
value
The stored value identifier for this column.
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.
Validation Settings
User Input
Setting
Field
Type
Default
Description
Required
validate.required
Toggle
OFF
Requires selections across all rows before the module can be submitted.
Required Error Message
errors.required
Text input
is required
Displays when the required matrix has incomplete selections.
Advanced Settings
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.
Canvas Label Text indicates the purpose of the corresponding field or component. For non-input components, the Canvas Label Text isn't end-user facing, and only appears in the .
The Unqork tool used to build individual modules by placing and configuring components on a canvas.
Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field.
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.
