yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #2411 from umbraco/v15/feature/property-type-cleanup

Browse Source 
Chore: Property Type Clean up
This commit is contained in:
Mads Rasmussen
2024-10-07 09:17:26 +02:00
committed by GitHub
parent 3c88f8cc0a b6ebf04bd5
commit 83ca4cb22d
4 changed files with 22 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/Umbraco.Web.UI.Client/src/packages/block/block/workspace/block-element-manager.ts
View File

@@ -101,7 +101,6 @@ export class UmbBlockElementManager extends UmbControllerBase {
/**
* @function propertyValueByAlias
* @param {string} propertyAlias - Property Alias to observe the value of.
* @param {UmbVariantId | undefined} variantId - Optional variantId to filter by.
* @returns {Promise<Observable<ReturnType | undefined> | undefined>} - Promise which resolves to an Observable
* @description Get an Observable for the value of this property.
*/

1
src/Umbraco.Web.UI.Client/src/packages/core/content-type/components/property-type-based-property/property-type-based-property.element.ts
View File

@@ -109,7 +109,6 @@ export class UmbPropertyTypeBasedPropertyElement extends UmbLitElement {
if (this._isUnsupported) {
return html`<umb-unsupported-property
.alias=${this._property.alias}
.ownerEntityType=${this._ownerEntityType}
.schema=${this._propertyEditorSchemaAlias!}></umb-unsupported-property>`;
}
return html`

28
src/Umbraco.Web.UI.Client/src/packages/core/property/property/property.context.ts
View File

@@ -156,7 +156,7 @@ export class UmbPropertyContext<ValueType = any> extends UmbContextBase<UmbPrope
/**
* Set the alias of this property.
* @param {(string | undefined)} alias
* @param {string | undefined} alias - The alias of the property
* @memberof UmbPropertyContext
*/
public setAlias(alias: string | undefined): void {
@@ -174,7 +174,7 @@ export class UmbPropertyContext<ValueType = any> extends UmbContextBase<UmbPrope
/**
* Set the label of this property.
* @param {(string | undefined)} label
* @param {(string | undefined)} label - The label of the property
* @memberof UmbPropertyContext
*/
public setLabel(label: string | undefined): void {
@@ -183,7 +183,7 @@ export class UmbPropertyContext<ValueType = any> extends UmbContextBase<UmbPrope
/**
* Get the label of this property.
* @returns {*} {(string | undefined)}
* @returns {(string | undefined)} - the label
* @memberof UmbPropertyContext
*/
public getLabel(): string | undefined {
@@ -210,7 +210,7 @@ export class UmbPropertyContext<ValueType = any> extends UmbContextBase<UmbPrope
/**
* Set the appearance of this property.
* @param {(UmbPropertyTypeAppearanceModel | undefined)} appearance
* @param {UmbPropertyTypeAppearanceModel | undefined} appearance - the appearance properties of this property
* @memberof UmbPropertyContext
*/
public setAppearance(appearance: UmbPropertyTypeAppearanceModel | undefined): void {
@@ -219,7 +219,7 @@ export class UmbPropertyContext<ValueType = any> extends UmbContextBase<UmbPrope
/**
* Get the appearance of this property.
* @returns {*} {(UmbPropertyTypeAppearanceModel | undefined)}
* @returns {UmbPropertyTypeAppearanceModel | undefined}- the appearance properties of this property
* @memberof UmbPropertyContext
*/
public getAppearance(): UmbPropertyTypeAppearanceModel | undefined {
@@ -228,7 +228,7 @@ export class UmbPropertyContext<ValueType = any> extends UmbContextBase<UmbPrope
/**
* Set the value of this property.
* @param value {ValueType} the whole value to be set
* @param {unknown} value - the whole value to be set
*/
public setValue(value: ValueType | undefined): void {
const alias = this.#alias.getValue();
@@ -239,7 +239,7 @@ export class UmbPropertyContext<ValueType = any> extends UmbContextBase<UmbPrope
/**
* Gets the current value of this property.
* Notice this is not reactive, you should us the `value` observable for that.
* @returns {ValueType}
* @returns {unknown} - the current value of this property
*/
public getValue(): ValueType | undefined {
return this.#value.getValue();
@@ -247,7 +247,7 @@ export class UmbPropertyContext<ValueType = any> extends UmbContextBase<UmbPrope
/**
* Set the config of this property.
* @param {(Array<UmbPropertyEditorConfigProperty> | undefined)} config
* @param {Array<UmbPropertyEditorConfigProperty> | undefined} config - Array of configurations for this property
* @memberof UmbPropertyContext
*/
public setConfig(config: Array<UmbPropertyEditorConfigProperty> | undefined): void {
@@ -256,7 +256,7 @@ export class UmbPropertyContext<ValueType = any> extends UmbContextBase<UmbPrope
/**
* Get the config of this property.
* @returns {*} {(Array<UmbPropertyEditorConfigProperty> | undefined)}
* @returns {Array<UmbPropertyEditorConfigProperty> | undefined} - Array of configurations for this property
* @memberof UmbPropertyContext
*/
public getConfig(): Array<UmbPropertyEditorConfigProperty> | undefined {
@@ -265,7 +265,7 @@ export class UmbPropertyContext<ValueType = any> extends UmbContextBase<UmbPrope
/**
* Set the variant ID of this property.
* @param {(UmbVariantId | undefined)} variantId
* @param {UmbVariantId | undefined} variantId - The property Variant ID, not necessary the same as the Property Dataset Context VariantId.
* @memberof UmbPropertyContext
*/
public setVariantId(variantId: UmbVariantId | undefined): void {
@@ -274,7 +274,7 @@ export class UmbPropertyContext<ValueType = any> extends UmbContextBase<UmbPrope
/**
* Get the variant ID of this property.
* @returns {*} {(UmbVariantId | undefined)}
* @returns {UmbVariantId | undefined} - The property Variant ID, not necessary the same as the Property Dataset Context VariantId.
* @memberof UmbPropertyContext
*/
public getVariantId(): UmbVariantId | undefined {
@@ -283,7 +283,7 @@ export class UmbPropertyContext<ValueType = any> extends UmbContextBase<UmbPrope
/**
* Set the validation of this property.
* @param {(UmbPropertyTypeValidationModel | undefined)} validation
* @param {UmbPropertyTypeValidationModel | undefined} validation - Object holding the Validation Properties.
* @memberof UmbPropertyContext
*/
public setValidation(validation: UmbPropertyTypeValidationModel | undefined): void {
@@ -292,7 +292,7 @@ export class UmbPropertyContext<ValueType = any> extends UmbContextBase<UmbPrope
/**
* Get the validation of this property.
* @returns {*} {(UmbPropertyTypeValidationModel | undefined)}
* @returns {UmbPropertyTypeValidationModel | undefined} - Object holding the Validation Properties.
* @memberof UmbPropertyContext
*/
public getValidation(): UmbPropertyTypeValidationModel | undefined {
@@ -301,7 +301,7 @@ export class UmbPropertyContext<ValueType = any> extends UmbContextBase<UmbPrope
/**
* Get the read only state of this property
* @returns {*} {boolean}
* @returns {boolean} - If property is in read-only mode.
* @memberof UmbPropertyContext
*/
public getIsReadOnly(): boolean {

18
src/Umbraco.Web.UI.Client/src/packages/core/property/property/property.element.ts
View File

@@ -32,7 +32,6 @@ export class UmbPropertyElement extends UmbLitElement {
/**
* Label. Name of the property
* @type {string}
* @attr
* @default
*/
@property({ type: String })
@@ -46,7 +45,6 @@ export class UmbPropertyElement extends UmbLitElement {
/**
* Description: render a description underneath the label.
* @type {string}
* @attr
* @default
*/
@property({ type: String })
@@ -72,7 +70,6 @@ export class UmbPropertyElement extends UmbLitElement {
* Alias
* @public
* @type {string}
* @attr
* @default
*/
@property({ type: String })
@@ -87,7 +84,6 @@ export class UmbPropertyElement extends UmbLitElement {
* Property Editor UI Alias. Render the Property Editor UI registered for this alias.
* @public
* @type {string}
* @attr
* @default
*/
@property({ type: String, attribute: 'property-editor-ui-alias' })
@@ -104,7 +100,6 @@ export class UmbPropertyElement extends UmbLitElement {
* Config. Configuration to pass to the Property Editor UI. This is also the configuration data stored on the Data Type.
* @public
* @type {string}
* @attr
* @default
*/
@property({ type: Array, attribute: false })
@@ -130,7 +125,6 @@ export class UmbPropertyElement extends UmbLitElement {
* DataPath, declare the path to the value of the data that this property represents.
* @public
* @type {string}
* @attr
* @default
*/
@property({ type: String, attribute: 'data-path' })
@@ -235,10 +229,14 @@ export class UmbPropertyElement extends UmbLitElement {
null,
);
this.observe(this.#propertyContext.isReadOnly, (value) => {
this._isReadOnly = value;
this._element?.toggleAttribute('readonly', value);
});
this.observe(
this.#propertyContext.isReadOnly,
(value) => {
this._isReadOnly = value;
this._element?.toggleAttribute('readonly', value);
},
null,
);
}
private _onPropertyEditorChange = (e: CustomEvent): void => {