From e9aca902d6db8325db2dd4d0d07e24e265957574 Mon Sep 17 00:00:00 2001 From: Matt Brailsford Date: Tue, 23 Sep 2025 12:42:49 +0100 Subject: [PATCH 1/2] Add a reference to the CMS docs for a list of available property editor ui elements --- 16/umbraco-commerce/key-concepts/settings-objects.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/16/umbraco-commerce/key-concepts/settings-objects.md b/16/umbraco-commerce/key-concepts/settings-objects.md index 53d9ca2b204..6e169827ad8 100644 --- a/16/umbraco-commerce/key-concepts/settings-objects.md +++ b/16/umbraco-commerce/key-concepts/settings-objects.md @@ -9,7 +9,7 @@ There are places in Umbraco Commerce where you can use Settings Objects to pass The settings objects have a number of responsibilities. * **Typed Settings Model** - The type represents a strongly typed settings model the given Provider accepts. Any stored settings in the database will be deserialized to this type before being passed to the Provider for processing. This provides strongly typed access to the relevant configuration settings. -* **UI Scaffold** - The settings object defines metadata on its properties via an Attribute implementing `UmbracoCommerceSettingAttribute`, each Provider type has its own attribute type in case they require additional config, for example `DiscountRewardProviderSettingAttribute`, `DiscountRuleProviderSettingAttribute` or `PaymentProviderSettingAttribute`. The attributes are used to dynamically build the AngularJS-based UI for the given Provider configuration. See the [UI Scaffolding](settings-objects.md#ui-scaffolding) section below for more information on UI Scaffolding. +* **UI Scaffold** - The settings object defines metadata on its properties via an Attribute implementing `UmbracoCommerceSettingAttribute`, each Provider type has its own attribute type in case they require additional config, for example `DiscountRewardProviderSettingAttribute`, `DiscountRuleProviderSettingAttribute` or `PaymentProviderSettingAttribute`. The attributes are used to dynamically build the UI for the given Provider configuration. See the [UI Scaffolding](settings-objects.md#ui-scaffolding) section below for more information on UI Scaffolding. * **JavaScript Settings Model** - The settings object also defines the JavaScript settings model passed to the Provider editor UI, using either the settings Property name as the object property key, or using the `Key` property of the Setting Attribute declared on the given Property. ## UI Scaffolding @@ -30,7 +30,11 @@ public class MyDiscountRewardProviderSettings } ``` -Attributes define an optional `Key` parameter to override the default setting alias which would otherwise be the property name in camel case. An optional `EditorUiAlias` and `EdiutorConfig` options can also be defined to control the Umbraco property editor used to edit the given property. If no view is defined, one will attempt to be automatically chosen based on the property's value type. +Attributes define an optional `Key` parameter to override the default setting alias which would otherwise be the property name in camel case. An optional `EditorUiAlias` and `EditorConfig` options can also be defined to control the Umbraco property editor used to edit the given property. If no view is defined, one will attempt to be automatically chosen based on the property's value type. + +{% hint style="info" %} +See the CMS docs for a list of [available Property Editor UI elements and their config properties](/umbraco-cms/reference/property-editor-uis). +{% endhint %} Labels and descriptions for settings are controlled through [Localization](#localization) entries. From b4e9a536eb15b45c4113bf6c9179b509a62023fa Mon Sep 17 00:00:00 2001 From: Esha Noronha <82437098+eshanrnh@users.noreply.github.com> Date: Tue, 23 Sep 2025 13:53:57 +0200 Subject: [PATCH 2/2] Update 16/umbraco-commerce/key-concepts/settings-objects.md --- 16/umbraco-commerce/key-concepts/settings-objects.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/16/umbraco-commerce/key-concepts/settings-objects.md b/16/umbraco-commerce/key-concepts/settings-objects.md index 6e169827ad8..170bb2cd88b 100644 --- a/16/umbraco-commerce/key-concepts/settings-objects.md +++ b/16/umbraco-commerce/key-concepts/settings-objects.md @@ -33,7 +33,7 @@ public class MyDiscountRewardProviderSettings Attributes define an optional `Key` parameter to override the default setting alias which would otherwise be the property name in camel case. An optional `EditorUiAlias` and `EditorConfig` options can also be defined to control the Umbraco property editor used to edit the given property. If no view is defined, one will attempt to be automatically chosen based on the property's value type. {% hint style="info" %} -See the CMS docs for a list of [available Property Editor UI elements and their config properties](/umbraco-cms/reference/property-editor-uis). +See the CMS documentation for a list of [available Property Editor UI elements and their config properties](/umbraco-cms/reference/property-editor-uis). {% endhint %} Labels and descriptions for settings are controlled through [Localization](#localization) entries.