JSDocs

src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extension-element-controller.ts

@@ -5,6 +5,17 @@ import { ManifestCondition, ManifestWithDynamicConditions } from '../types.js';
 import { UmbBaseExtensionController } from './base-extension-controller.js';
 import { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
 
+/**
+ * This Controller manages a single Extension and its Element.
+ * When the extension is permitted to be used, its Element will be instantiated and available for the consumer.
+ *
+ * @example
+* ```ts
+* const controller = new UmbExtensionElementController(host, extensionRegistry, alias, (permitted, ctrl) => { console.log("Extension is permitted and this is the element: ", ctrl.component) }));
+* ```
+ * @export
+ * @class UmbCodeEditor
+ */
 export class UmbExtensionElementController<
 	ManifestType extends ManifestWithDynamicConditions = ManifestWithDynamicConditions,
 	ControllerType extends UmbExtensionElementController<ManifestType, any> = any

src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extension-manifest-controller.ts

@@ -3,6 +3,17 @@ import type { UmbExtensionRegistry } from '../registry/extension.registry.js';
 import { UmbBaseExtensionController } from './base-extension-controller.js';
 import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
 
+/**
+ * This Controller manages a single Extension and its Manifest.
+ * When the extension is permitted to be used, the manifest is available for the consumer.
+ *
+ * @example
+* ```ts
+* const controller = new UmbExtensionManifestController(host, extensionRegistry, alias, (permitted, ctrl) => { console.log("Extension is permitted and this is the manifest: ", ctrl.manifest) }));
+* ```
+ * @export
+ * @class UmbCodeEditor
+ */
 export class UmbExtensionManifestController<
 	ManifestType extends ManifestWithDynamicConditions = ManifestWithDynamicConditions,
 	ControllerType extends UmbBaseExtensionController<ManifestType, any> = any