Skip to main content

VALID_SURFACES

Enum of rendering surfaces understood by the pluggable integration registry.

Value

import { VALID_SURFACES } from '@conduction/nextcloud-vue'

// ['user-dashboard', 'app-dashboard', 'detail-page', 'single-entity']
SurfaceWhere it rendersDefault widget override key
user-dashboardUser's personal Nextcloud dashboard widgetswidgetCompact
app-dashboardApp-level dashboard pages (e.g. CnDashboardPage)(none — uses widget)
detail-pagePer-object detail surfaces (e.g. CnDetailPage)widgetExpanded
single-entityInline rendering of a referenceType schema propertywidgetEntity

Surface fallback (AD-19)

registry.resolveWidget(id, surface) picks the surface-specific override when present; otherwise it returns the main widget with surface passed as a prop. Adding a future surface (e.g. email-digest, printed-pdf, mobile-card) requires zero re-registration from existing integrations — they keep working via fallback.

See also