The Protected Field component captures sensitive text input and masks the entered value so it is not visible to the end-user or others viewing the screen. Use it for passwords, secret codes, and other confidential data.
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
protected
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.
Placeholder Text
placeholder
Text input
—
Hint text displayed inside the input field to guide end-users on what to enter.
Prefix
prefix
Text input
—
Text or symbol displayed before the input.
Suffix
suffix
Text input
—
Text or symbol displayed after the input.
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.
Default State Options
Setting
Field
Type
Default
Description
Hide Field
hidden
Toggle
OFF
Hides the component from end-users but always displays in the Module Builder.
Disable User Input
disabled
Toggle
OFF
Prevents end-users from editing or interacting with the field. The field displays with an altered appearance to indicate it is not editable.
Validation Settings
User Input
Setting
Field
Type
Default
Description
Required
validate.required
Toggle
OFF
Requires a value before the module can be submitted.
Required Error Message
errors.required
Text input
is required
Displays when the required field is left empty.
Advanced Settings
Additional Validation Options
Setting
Field
Type
Default
Description
Min Length
validate.minLength
Number input
—
Minimum number of characters required.
Min Length Error Message
errors.minlength
Text input
Must be longer than
Displays when the entered value is shorter than the minimum.
Max Length
validate.maxLength
Number input
—
Maximum number of characters allowed.
Max Length Error Message
errors.maxlength
Text input
Must be shorter than
Displays when the entered value exceeds the maximum.
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.
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.
The Number data type accepts integer or floating point values. The number data type does not use quotes around numerical values.
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.
