Describes a web component to create and the properties to set on it.

Used wherever the platform needs a component specified as data rather than instantiated directly — for example configuration UIs, metadata renderers, or slot content provided by plugins.

Example

const descriptor: ComponentDescriptor = {
name: 'customer-insights-config',
props: { defaultView: 'monthly' },
};

Type Parameters

  • V = unknown

Hierarchy

  • ComponentDescriptor

Properties

Properties

name: string

Tag name of the web component to create.

props?: Record<string, V>

Properties to set on the created component.