Skip to main content

CnIntegrationWidget

Tabbed, app-faithful integration widget for OpenRegister object-detail pages and dashboards. Gives every registered integration its own tab (app icon + label + accent), composing each leaf's bespoke content component (provider.tab).

Supersedes the generic Phase E pair (CnIntegrationCard / CnIntegrationWidgetGrid) which rendered a one-size surface that erased each integrated app's visual identity. Has two modes: an all-integrations tabbed view, and a single-integration mode for manifest multi-placement.

See the Pluggable Integration Registry section for registration.

Props​

PropTypeDefaultDescription
surfaceString'detail-page'Surface the widget renders for ('detail-page' | 'single-entity' | dashboard surfaces).
integrationContextObjectnull{ register, schema, objectId } forwarded to each leaf tab so it can scope its data to the current object.
integrationIdString''When set, renders only that one integration (single-integration mode) instead of the full tab strip.

Usage​

<CnIntegrationWidget
surface="detail-page"
:integration-context="{ register, schema, objectId }" />

Additional props​

PropTypeDefaultDescription
registryObject—Override integration registry (defaults to the shared singleton).
includeArraynullAllowlist of integration ids to render (others hidden).
apiBaseString—Base path for integration API calls.
objectTypeString''Object type/schema the widget is bound to.
documentation-urlString''Documentation link for the overflow Actions menu.
widget-idString''Stable id forwarded to the menu.
objectLabelString''The record's display name, handed to the leaf as objectLabel.
placementPropsObject{}Extra props for the leaf, set by the placement (a manifest widget's props.placementProps), for example the kinds a finance leaf shows. The record's own identity always wins over a key of the same name.
leafSurfaceString''The surface the leaf is told it renders on when it differs from surface (a leaf in a dialog that keeps its sidebar-tab look).
appNameString''The app that provides the only leaf. When that leaf is not registered, the widget shows "{App} not available" with the install hint instead of the plain line.
appIconString''The icon of that empty state.

Mount-mode leaves​

In single mode (only) a leaf that mounts its own framework (renderMode: 'mount', ADR-066) is mounted through CnLeafMountHost with the record context, integrationContext and objectLabel, the same way a detail page mounts it:

<CnIntegrationWidget only="decidiq-approval-chain" surface="detail-page" leafSurface="sidebar-tab" register="dossiq" schema="informatieobject" :objectId="documentId" :objectLabel="documentTitle" appName="Decidiq" />

On a detail page an integration widget whose leaf is not registered shows the same "{App} not available" state, named after the widget's appName (or its requiredApp), instead of nothing.