Skip to content

SurfaceProvideDecl

A surface capability — a rendered region the shell can broker into a host (an app or the dashboard).

contexts: SurfaceContext[];

The contexts this surface supports being hosted in.


kind: "surface";

Discriminant marking this declaration as a surface.


name: string;

The surface name hosts pass to embedSurface, and the key of its loader in bootstrap.


optional navTarget?: string;

Deep-link sub-route the dashboard chrome’s “open app” targets; falls back to the app root.


optional paramsSchema?: unknown;

JSON Schema describing the surface params, for discovery and validation tooling.


optional requiredPermission?: string;

Inert: kept in the type but read by nothing — user authorization is enforced at the provider’s backend.


optional title?: string;

Dashboard-widget chrome title; the shell falls back to the app’s display name if absent.