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.

Component General Settings

Prev Next

Every component in the Module Builder shares a common set of settings and actions, regardless of type. This guide covers the Properties panel header, the Tags, Notes, and Permissions dialogs, and the actions available on each component in the canvas.

For component-specific settings, see the Component Reference.

Properties Panel Header

Selecting a component in the canvas opens the Properties panel on the right with that component's settings. The header displays the component's Property ID. Below the Property ID, the Component line names the component.

Control Description
Component Names the component. For a Smart Component, this is the Smart Component's name. For a platform component, it is the component's name, like Text Field or Number. On a Smart Component, the name is a link marked with a full-screen icon. Selecting it opens that component's focused view over the module.
Tags Opens the Field Tags dialog to manage labels for the component. A count displays how many tags the component has.
Notes Opens the Notes dialog to add internal documentation. A count displays when the component has a note.
EllipsisVertical (ellipsis) Opens the More options menu.

The More options menu contains the following actions:

Action Description
Copy Settings Copies the component's settings, including unsaved changes, to the clipboard ().
Paste Settings Pastes copied settings onto the selected component (). The copied settings must come from a single component of the same type. Creators save the component to apply the pasted settings.
Pin Pins the component as a tab at the top of the Properties panel, so Creators can switch between pinned components while they work. Select Unpin to remove the tab. Not available for a new component until it is saved.
Collapse All Collapses every settings section in the panel. Select Expand All to open the sections again.
Permissions Opens the Permissions dialog to configure per-role access.
Documentation Opens the component's documentation in a new browser tab. Available only for components that have a documentation page.

When more than one component is pinned,  and  move between pinned tabs. Select Unpin All to clear every pinned tab.

To resize the Properties panel, drag its left edge.

Tags

Tags group and identify components across a module, so logic can reference them together. Selecting Tags in the panel header opens the Field Tags dialog. Creators enter a tag, then press Enter or select Add.

  • Each tag must be at least three characters.
  • Spaces are converted to hyphens. Several spaces in a row become a single hyphen.
  • Duplicate tags are not allowed. The check ignores case, so Address and address count as the same tag.

Select Done to keep the changes, or Cancel to discard them. Tags are stored when the component is saved.

Some tags have functional significance. UDLC tools like the API Docs Dashboard and Schema Docs Dashboard tool query components by tag to filter and document specific modules. Common examples include:

  • api: Marks components used in API-facing modules queried by the API Docs Dashboard tool.
  • schema: Marks components used in schema modules queried by the Schema Docs Dashboard tool.

Notes

Selecting Notes in the panel header opens the Notes dialog. Notes are a rich text field for internal documentation about the component, like its purpose, logic, or any context useful for other Creators. Notes are not visible to end-users. A character counter tracks length against a suggested maximum of 1,000 characters.

Select Done to keep the changes, or Cancel to discard them. Notes are stored when the component is saved.

Tags and notes are stored as plain text in the module definition. Do not enter personal data, protected health information, credentials, or other sensitive values in tags or notes.

Permissions

The Permissions dialog controls what each Express role can do with the component. Permissions are set per role and can be inherited from parent components, the module, or role defaults.

Component permissions are editable only when Customize RBAC for This Module is turned on in Module Settings. Otherwise, the dialog displays a notice instead of the permissions table.

Permission Description
Inherit Inherits the permission from the parent component, module, or role default.
No Access Hides the component from end-users in that role.
Read-Only Displays the component but prevents end-users from editing it.
Write Grants full access to view and edit the component.
Obfuscate Masks the component's value with asterisks. End-users cannot see the real value or edit it.

The Effective Permission and Inherited From columns display the permission each role receives and the source of that permission.

Canvas Actions

Selecting a component in the canvas opens its settings in the Properties panel. Pressing Enter on a focused component does the same.

The EllipsisVertical (ellipsis) on each component row opens a menu with the following actions:

Action Description
Copy Copies the component to the clipboard ().
Paste Above Pastes a copied component above the selected component.
Paste Below Pastes a copied component below the selected component ().
Move Activates keyboard-based repositioning (). Move up () or down (), confirm (), or cancel ().
Delete Removes the component from the module (). If the component contains other components, a confirmation dialog lists how many will also be deleted.

To cut a component, use . To restore a deleted or cut component, use .

On a Smart Component, the menu also includes View, which opens the component's focused view. For a public Smart Component, Edit Base or View Base opens the base component, depending on the Creator's access.

When the module is not in edit mode, only Copy and the Smart Component actions (View, Edit Base, and View Base) are available.

When the Properties panel is in focus, use keyboard shortcuts to save (), undo (), redo (), or cancel () without leaving the keyboard.


Changelog

Date Change
2026-10-16 Updated the Properties panel header, dialogs, and canvas actions to match the current Module Builder. Added guidance on keeping sensitive data out of tags and notes.
2026-09-01 Documented the Component row in the settings panel header. It names the component, and on a Smart Component it links to that component's focused view.
2026-04-13 Initial publication.