Skip to main content

VALID_SURFACES

Frozen list of the surface names a JS integration may register a widget against. Used by the integration registry to reject unknown surfaces in development.

Values

['user-dashboard', 'app-dashboard', 'detail-page', 'single-entity']
SurfaceWhere it renders
user-dashboardThe per-user dashboard (CnDashboardPage in user-scope mode).
app-dashboardThe app-level dashboard.
detail-pageAn object detail page (CnDetailPage).
single-entityA single-entity reference widget (e.g. inside CnFormDialog / CnDetailGrid).

Usage

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

const registry = createIntegrationRegistry()
// registry.registerWidget(...) throws in dev when the surface is not in VALID_SURFACES

Reference