From efff1741171a1cad1c8c38c8100a5c92f79f67bc Mon Sep 17 00:00:00 2001 From: Mads Rasmussen Date: Wed, 28 Sep 2022 15:05:29 +0200 Subject: [PATCH] add jsdocs to property editor config element --- .../entity-property.element.ts | 1 - .../property-editor-config.element.ts | 23 +++++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/src/Umbraco.Web.UI.Client/src/backoffice/components/entity-property/entity-property.element.ts b/src/Umbraco.Web.UI.Client/src/backoffice/components/entity-property/entity-property.element.ts index 1eb77cd46a..8ea5ea530e 100644 --- a/src/Umbraco.Web.UI.Client/src/backoffice/components/entity-property/entity-property.element.ts +++ b/src/Umbraco.Web.UI.Client/src/backoffice/components/entity-property/entity-property.element.ts @@ -14,7 +14,6 @@ import '../../editors/shared/editor-property-layout/editor-property-layout.eleme * @element umb-entity-property * @description - Component for displaying a entity property. The Element will render a Property Editor based on the Property Editor UI alias passed to the element. * The element will also render all Property Actions related to the Property Editor. - * @extends UUIRefNodeElement */ @customElement('umb-entity-property') export class UmbEntityPropertyElement extends UmbContextConsumerMixin(LitElement) { diff --git a/src/Umbraco.Web.UI.Client/src/backoffice/property-editors/shared/property-editor-config/property-editor-config.element.ts b/src/Umbraco.Web.UI.Client/src/backoffice/property-editors/shared/property-editor-config/property-editor-config.element.ts index 13e1931140..cd88693cc2 100644 --- a/src/Umbraco.Web.UI.Client/src/backoffice/property-editors/shared/property-editor-config/property-editor-config.element.ts +++ b/src/Umbraco.Web.UI.Client/src/backoffice/property-editors/shared/property-editor-config/property-editor-config.element.ts @@ -11,10 +11,20 @@ import type { PropertyEditorConfigDefaultData, PropertyEditorConfigProperty } fr import '../../../components/entity-property/entity-property.element'; +/** + * @element umb-property-editor-config + * @description - Element for displaying the configuration for a Property Editor and Property Editor UI. + */ @customElement('umb-property-editor-config') export class UmbPropertyEditorConfigElement extends UmbContextConsumerMixin(LitElement) { static styles = [UUITextStyles]; + /** + * Property Editor Alias. The element will render configuration for a Property Editor with this alias. + * @type {string} + * @attr + * @default '' + */ private _propertyEditorAlias = ''; @property({ type: String, attribute: 'property-editor-alias' }) public get propertyEditorAlias(): string { @@ -27,6 +37,12 @@ export class UmbPropertyEditorConfigElement extends UmbContextConsumerMixin(LitE this._observePropertyEditorConfig(); } + /** + * Property Editor UI Alias. The element will render configuration for a Property Editor UI with this alias. + * @type {string} + * @attr + * @default '' + */ private _propertyEditorUIAlias = ''; @property({ type: String, attribute: 'property-editor-ui-alias' }) public get propertyEditorUIAlias(): string { @@ -39,6 +55,13 @@ export class UmbPropertyEditorConfigElement extends UmbContextConsumerMixin(LitE this._observePropertyEditorUIConfig(); } + /** + * Data. The element will render configuration editors with values from this data. + * If a value is not found in this data, the element will use the default value from the configuration. + * @type {Array<{ alias: string; value: unknown }>} + * @attr + * @default [] + */ @property({ type: Array }) public data: Array<{ alias: string; value: unknown }> = [];