Protected Field Component

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, codes, and other confidential data.

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	`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.