Skip to content

Commit e9aca90

Browse files
Add a reference to the CMS docs for a list of available property editor ui elements
1 parent fe502e5 commit e9aca90

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

16/umbraco-commerce/key-concepts/settings-objects.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ There are places in Umbraco Commerce where you can use Settings Objects to pass
99
The settings objects have a number of responsibilities.
1010

1111
* **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.
12-
* **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.
12+
* **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.
1313
* **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.
1414

1515
## UI Scaffolding
@@ -30,7 +30,11 @@ public class MyDiscountRewardProviderSettings
3030
}
3131
```
3232

33-
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.
33+
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.
34+
35+
{% hint style="info" %}
36+
See the CMS docs for a list of [available Property Editor UI elements and their config properties](/umbraco-cms/reference/property-editor-uis).
37+
{% endhint %}
3438

3539
Labels and descriptions for settings are controlled through [Localization](#localization) entries.
3640

0 commit comments

Comments
 (0)