Documentation Index

Fetch the complete documentation index at: https://docs.unqork.io/llms.txt

Use this file to discover all available pages before exploring further.

Smart Component Editor

Prev Next

The Smart Component Editor is where Creators write, preview, configure, and test Smart Components. The editor uses the same shell as the Module Builder and Workflow Builder: a toolbar, area tabs, and a content area. The areas and views available depend on the component type.

To open the Smart Component Editor, select LibraryBig Library in the global header, then select Puzzle Smart Components Hub. Select a component from the Explorer panel, or use Open in Editor from the Hub's row actions menu, to open it in the editor.

Editor Layout

The Smart Component Editor has the following areas:

Area Description
Toolbar The top bar. Displays the component name, an unsaved changes indicator, the Save button, and the EllipsisVertical (ellipsis) actions menu.
View tabs Below the toolbar. Switch between available views for the component. The tabs available depend on the component type.
Editing toolbar Below the view tabs. Provides the Properties toggle, Viewport selector, and Highlight control for the active view.
Content area The main editing surface. Displays the active view.

Editor Areas

The editor organizes content into three areas. Select an area in the area tabs to switch between them.

Area Description
Definition The main editing surface. Displays the component's UI preview or logic tree for editing. The views available in this area depend on the component type.
Tests Runs the component's automated test suite. Tests verify that the component behaves as expected across defined input and output combinations. Not available for Query Smart Components.
History Lists previous saved versions of the component. Select a revision to preview it or restore the component to that state. Available for all component types.

Views by Component Type

Within the Definition area, the views available depend on the component type.

UI Smart Components

View Description
UI Renders the component live in a preview canvas. Use the editing toolbar to set the canvas width and toggle input highlighting.
Logic Displays the component's logic as an editable visual tree.

Logic Smart Components

View Description
Logic Displays the component's logic as an editable visual tree.

Query Smart Components

View Description
Logic View Displays the component's compiled query pipeline as an ordered chain canvas. Read-only. See Smart Component Logic View.
Tests Runs the component's automated tests.

Editing Toolbar

The editing toolbar sits below the view tabs and provides controls for the active view.

Control Description
Properties Toggles the Properties panel. When expanded, displays input controls and the Viewport selector. See Properties Panel below.
Viewport Sets the canvas width to simulate different device sizes. Visible when Properties is expanded.
Highlight Highlights interactive input areas in the canvas preview.

Properties Panel

The Properties panel, available in the UI view, opens when Properties is selected in the editing toolbar and has two tabs.

Tab Description
Controls Displays fields for each input defined in the component's interface. Set values here to test how the component responds to different input data.
Preview Displays a preview of the component as it would render for end-users.

If no inputs are defined in the component's interface, the Controls tab displays a prompt to define an input interface first.

Saving and Edit Mode

Shared Smart Components use a two-step publish model to protect all modules that use them.

  • Save: Writes changes into a private draft buffer, not yet live in any module. Only one Creator can own the draft at a time.
  • Review Changes: Opens the draft's review, where the draft is published or discarded. Previous versions are accessible in the History area if a rollback is needed.

Review Changes displays in the SC Editor toolbar when the Creator holds the draft. It opens a review of that one draft, which states where the component is used before either action is taken:

  • Publish Changes: Publishes the draft as the live definition. The change takes effect immediately in every module using the component. If publishing leaves consuming modules holding settings the new definition no longer has, the review names those modules afterward so they can be fixed by hand.
  • Discard Changes: Deletes the draft. The published version stays exactly as it is. Where discarding would also remove configuration that modules have set up against the draft, the review lists what goes and asks for confirmation first.

Publishing is withheld when another workspace's component builds on the draft, or when the component is used in modules outside the Creator's access. The review states the reason and offers the Component Library, where the draft can be duplicated instead. Discard stays available in every case, since it is the only way back out of draft mode.

Creators can also reach the same review without opening the editor: select Publish Draft from the component's row menu in the Component Library or the file explorer.

If another Creator opens the same component for editing while a draft is open, they can take over the draft. The new holder takes over from the current saved state of the draft. When this happens, the original holder receives a notification naming the new holder, their editor stops accepting saves, and Review Changes is withheld. Any unsaved changes stay on screen. To resume, take the draft back from the draft menu in the toolbar.

Review Changes is disabled when there are unsaved changes. Save first, then review.

Component Actions

Click the EllipsisVertical (ellipsis) in the toolbar to access the following actions.

Action Location Description
Make Discoverable Toolbar button Makes the component visible to the Build Agent across the environment and reusable in any module. Displays only while the component is private. This change is permanent. See Discoverability.
icon Accessibility Check menu Opens the accessibility checker for this component. Visible only when UnqorkAI is enabled in the environment.
icon Duplicate Component menu Creates a copy of this component in the library. Disabled while the Creator holds an open draft on this component.
icon Promote menu Opens the Promote dialog. Select a target environment and confirm to promote the component. Optionally include composed Smart Components as dependencies.
icon Export menu Downloads the component definition as an exportable file.
icon Settings menu Opens the component settings dialog. Rename the component, update its description, and set its category. For Query Smart Components, also configure execution behavior and role-based access controls. See Smart Component Settings.
icon Delete Component menu Permanently removes the component. This action cannot be undone.

Changelog

Date Change
2026-08-31 Updated Make Discoverable description with link to Discoverability concepts (EN-8062).
2026-08-28 Removed the Make Private toolbar action. Discoverability is now one-way: a discoverable component cannot be made private again (UQE-17757).
2026-08-27 Renamed the discoverability action from Make Not Discoverable to Make Private, matching the Discoverable and Private nomenclature in the platform (UQE-17572).
2026-08-25 Updated Saving and Edit Mode — the toolbar's Publish Changes is now Review Changes, opening a single-draft review with Publish Changes and Discard Changes; documented the refusal reasons and the orphaned-settings report (UQE-17572).
2026-08-25 Updated Saving and Edit Mode — removed the Smart Component Changes entry point from the module toolbar; drafts are published or discarded from the SC Editor toolbar or the Smart Components Hub row menu (UQE-17572).
2026-08-25 Added inline icons to Component Actions table. Added Editor Areas section documenting Definition, Tests, and History areas. Added Area tabs row to Editor Layout table. Updated Views by Component Type: corrected view names to UI and Logic; removed Config View and Query Pipeline (outdated); removed Tests from Definition views (Tests is now an area). Updated Component Actions: removed Where It's Used and Change History (deleted in UQE-17395); added Make Discoverable/Make Not Discoverable as a dedicated toolbar button; added Location column to clarify toolbar vs ellipsis menu. Updated Saving and Edit Mode to reference the History area instead of Change History in the ellipsis menu. Removed Tests as a standalone section (absorbed into Editor Areas). Removed HR dividers between sections (EN-8029).
2026-08-24 Updated Saving and Edit Mode — the displaced holder now gets a notification and the toolbar's draft menu rather than an in-editor displacement banner (UQE-17572).
2026-08-24 Updated Query Smart Components view name — Query Pipeline replaced by Logic View (EN-8033, UQE-16969).
2026-08-14 Updated Saving and Edit Mode — "Apply Edit" renamed to "Publish Changes"; Smart Component Changes dialog in module toolbar documents Publish/Discard/Take Over (EN-8032, UQE-17176).
2026-08-13 Added Saving and Edit Mode section — two-step Save/Apply model, displacement behavior, Change History as rollback (EN-8006).
2026-08-13 Rewrote Component Actions table to match actual ellipsis menu (EN-8006): added Where It's Used, Change History, Duplicate Component, Promote, Export…; corrected labels; removed incorrect Share, Copy ID, and Permissions entries.
2026-08-10 Initial publication (EN-8006). Documents the rebuilt Smart Component Editor: BuilderViewShell-based layout, view sets by component type, editing toolbar, Properties panel, and component actions.