Updates for Forms 10.5.6, 13.2.0 and 14.1.0

10/umbraco-forms/developer/extending/adding-a-fieldtype.md

@@ -166,7 +166,7 @@ To reference the file the setting should be configured with a full path to the v
     [Setting("My Setting",
         Description = "Help text for the setting",
         View = "~/App_Plugins/UmbracoFormsCustomFields/backoffice/Common/SettingTypes/mycustomsettingfield.html",
-        SupportsPlaceholders = "true"
+        SupportsPlaceholders = true
         DisplayOrder = 10)]
     public string MySetting { get; set; }
 ```

10/umbraco-forms/developer/themes.md

@@ -21,7 +21,7 @@ Umbraco 10+ distributes these files as part of a Razor class library, so you won
 
 You can obtain the latest version of the default theme Forms 10 from the following link:
 
-* [Forms 10 Default Theme](https://umbra.co/umbraco-forms-default-theme) (for 10.5.5 and above)
+* [Forms 10 Default Theme](https://umbra.co/umbraco-forms-default-theme) (for 10.5.6 and above)
 
 If you are using a lower minor version of Forms than those listed, you should download an older version of the default theme.
 

10/umbraco-forms/release-notes.md

@@ -21,6 +21,13 @@ This section contains the release notes for Umbraco Forms 8 and 10 including all
 
 <summary>Version 10</summary>
 
+[**10.5.6**](https://github.com/umbraco/Umbraco.Forms.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F10.5.6) **(July 9th 2024)**
+
+* Fixed issue with save button UI, when save is canceled via a notification [#1219](https://github.com/umbraco/Umbraco.Forms.Issues/issues/1219).
+* Improved date format for data values when using the **Send email** workflow [#1214](https://github.com/umbraco/Umbraco.Forms.Issues/issues/1214).
+* Removed unnecessary circular checks for conditions on workflows resolving an issue where workflow would trigger when conditions were not met [#1206](https://github.com/umbraco/Umbraco.Forms.Issues/issues/1206).
+* Fixed console error with blank values in data picker fields [#1241](https://github.com/umbraco/Umbraco.Forms.Issues/issues/1241).
+
 [**10.5.5**](https://github.com/umbraco/Umbraco.Forms.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F10.5.5) **(April 16th 2024)**
 
 * Corrected alignment of label `for` and input `id` attributes in the date picker field [#1200](https://github.com/umbraco/Umbraco.Forms.Issues/issues/1200).

12/umbraco-forms/developer/extending/adding-a-fieldtype.md

@@ -165,7 +165,7 @@ To reference the file the setting should be configured with a full path to the v
 [Setting("My Setting",
     Description = "Help text for the setting",
     View = "~/App_Plugins/UmbracoFormsCustomFields/backoffice/Common/SettingTypes/mycustomsettingfield.html",
-    SupportsPlaceholders = "true"
+    SupportsPlaceholders = true
     DisplayOrder = 10)]
 public virtual string MySetting { get; set; }
 ```

13/umbraco-forms/.gitbook/assets/umbraco_forms_swagger.json

@@ -37,11 +37,22 @@
             "schema": {
               "type": "string"
             }
+          },
+          {
+            "name": "additionalData",
+            "in": "query",
+            "description": "Additional data provided when rendering the form.",
+            "schema": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              }
+            }
           }
         ],
         "responses": {
           "200": {
-            "description": "Success",
+            "description": "OK",
             "content": {
               "application/json": {
                 "schema": {
@@ -124,7 +135,7 @@
             }
           },
           "422": {
-            "description": "Client Error",
+            "description": "Unprocessable Content",
             "content": {
               "application/json": {
                 "schema": {
@@ -144,16 +155,14 @@
           "Show",
           "Hide"
         ],
-        "type": "integer",
-        "format": "int32"
+        "type": "string"
       },
       "FieldConditionLogicType": {
         "enum": [
           "All",
           "Any"
         ],
-        "type": "integer",
-        "format": "int32"
+        "type": "string"
       },
       "FieldConditionRuleOperator": {
         "enum": [
@@ -162,11 +171,19 @@
           "GreaterThen",
           "LessThen",
           "Contains",
+          "ContainsIgnoreCase",
           "StartsWith",
-          "EndsWith"
+          "StartsWithIgnoreCase",
+          "EndsWith",
+          "EndsWithIgnoreCase",
+          "NotContains",
+          "NotContainsIgnoreCase",
+          "NotStartsWith",
+          "NotStartsWithIgnoreCase",
+          "NotEndsWith",
+          "NotEndsWithIgnoreCase"
         ],
-        "type": "integer",
-        "format": "int32"
+        "type": "string"
       },
       "FormConditionDto": {
         "type": "object",
@@ -285,6 +302,13 @@
           "culture": {
             "type": "string",
             "nullable": true
+          },
+          "additionalData": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string"
+            },
+            "nullable": true
           }
         },
         "additionalProperties": false
@@ -305,7 +329,8 @@
           },
           "placeholder": {
             "type": "string",
-            "nullable": true
+            "nullable": true,
+            "deprecated": true
           },
           "cssClass": {
             "type": "string",
@@ -359,8 +384,7 @@
           "MarkMandatoryFields",
           "MarkOptionalFields"
         ],
-        "type": "integer",
-        "format": "int32"
+        "type": "string"
       },
       "FormFieldPrevalueDto": {
         "type": "object",

13/umbraco-forms/developer/ajaxforms.md

@@ -43,7 +43,7 @@ The Open API specification is available from: `/umbraco/swagger/forms/swagger.js
 To request the definition of a form, the following request can be made:
 
 ```none
-GET /umbraco/forms/api/v1/definitions/{id}?contentId={contentId}&culture={culture}
+GET /umbraco/forms/api/v1/definitions/{id}?contentId={contentId}&culture={culture}&additionalData[{key}]={value}&additionalData[key2]={value2}
 ```
 
 The GET request requires the Guid identifying the form.
@@ -52,6 +52,8 @@ An optional `contentId` parameter can be provided, which can either be the integ
 
 A `culture` parameter can also be provided, expected as an ISO code identifying a language used in the Umbraco installation (for example, `en-US`). This will be used to ensure the correct translation for dictionary keys is used. It will also retrieve page content from the appropriate language variant. If the parameter is not provided in the request, the default Umbraco language will be used.
 
+Finally, an `additionalData` parameter can be provided as a dictionary. This information will be made available when rendering the form allowing it to be used as a source for ["magic string" replacements](./magic-strings.md).
+
 If the requested form is not found, a 404 status code will be returned.
 
 A successful request will return a 200 status code. An example response is as follows. It will differ depending on the pages, fields and other settings available for the form.
@@ -398,14 +400,20 @@ It also requires a `Content-Type` header of `application/json` and accepts a bod
         "dataConsent": "on"
     },
     "contentId": "ca4249ed-2b23-4337-b522-63cabe5587d1",
-    "culture": "en-US"
+    "culture": "en-US",
+    "additionalData": {
+        "foo": "bar",
+        "baz": "buzz",
+    }
 }
 ```
 
 The `values` collection consists of a set of name/value pairs, where the name is the alias of a form field. The value is the value of the submitted field, which can either be a string, or an array of strings. In this way we support fields that accept multiple values, such as checkbox lists.
 
 The `contentId` and `culture` parameters are optional. If provided they will be used to customize the response for the current page and language respectively.
 
+Similarly, the `additionalData` dictionary is optional. This data is associated with the created record and made available within workflows.
+
 In the case of a validation error, a 422 "Unprocessable Entity" status code will be returned, along with a response similar to the following:
 
 ```json

13/umbraco-forms/developer/configuration/type-details.md

@@ -130,6 +130,7 @@ The intention is to be able to make available details such as IDs, aliases and p
 
 **Settings:**
 
+* `DisplayLayout`
 * `DefaultValue`
 * `ShowLabel`
 
@@ -206,6 +207,7 @@ The intention is to be able to make available details such as IDs, aliases and p
 
 **Settings:**
 
+* `DisplayLayout`
 * `DefaultValue`
 * `ShowLabel`
 

13/umbraco-forms/developer/extending/adding-a-fieldtype.md

@@ -165,7 +165,7 @@ To reference the file the setting should be configured with a full path to the v
 [Setting("My Setting",
     Description = "Help text for the setting",
     View = "~/App_Plugins/UmbracoFormsCustomFields/backoffice/Common/SettingTypes/mycustomsettingfield.html",
-    SupportsPlaceholders = "true"
+    SupportsPlaceholders = true,
     DisplayOrder = 10)]
 public virtual string MySetting { get; set; }
 ```
@@ -174,6 +174,8 @@ public virtual string MySetting { get; set; }
 
 `HtmlEncodeReplacedPlaceholderValues` takes effect only if `SupportsPlaceholders` is `true`. It controls whether the replaced placeholder values should be HTML encoded (as is necessary for rendering within content from a rich text editor).
 
+`SupportsHtml` is a flag indicating whether the setting can contain HTML content. When set to `true` it will be treated as HTML content when the value is read from the Forms delivery API.
+
 `IsMandatory` if set to `true` will provide client-side validation in the backoffice to ensure the value is completed.
 
 ### Settings when inheriting

13/umbraco-forms/developer/extending/setting-types.md

@@ -20,11 +20,12 @@ The following setting types are available and are used for the field, prevalue s
 | Name                      | Description                                                       | Used in                                         |
 |---------------------------|-------------------------------------------------------------------|-------------------------------------------------|
 | Checkbox                  | Uses a single checkbox for entry                                  |                                                 |
-| DocumentMapper            | Used for selection of a documenttype                             | The "Save as Umbraco node" workflow             |
+| DocumentMapper            | Used for selection of a documenttype                              | The "Save as Umbraco node" workflow             |
 | Dropdownlist              | Used for selection from a list of options                         |                                                 |
 | EmailTemplatePicker       | Used for selection of an email template                           | The "Send email with Razor template" workflow   |
 | FieldMapper               | Used to map fields from a form to required aliases                | The "Send to URL" workflow                      |
 | File                      | Used for selection of a file                                      | The "Send email with XSLT template" workflow    |
+| MultipleTextString        | Uses multiple text boxes for entry                       | Not used in core types                          |
 | NumericField              | Uses numerical text box for entry                                 |                                                 |
 | Password                  | Uses password text box for entry                                  |                                                 |
 | PasswordNoAutocomplete    | Uses password text box for entry (with autocomplete disabled)     |                                                 |
@@ -38,7 +39,6 @@ The following setting types are available and are used for the field, prevalue s
 | Textfield                 | Used a single-line textbox for entry                              |                                                 |
 | TextfieldNoAutocomplete   | Used a single-line textbox for entry (with autocomplete disabled) |                                                 |
 | TextWithFieldPicker       | Used a single-line textbox/form field list for entry              | Not used in core types                          |
-| MultipleTextString        | Used multiple textboxes for multiple entries                      | Not used in core types                          |
 
 All of the above setting types are used in one or more field, prevalue source and workflow types available with Umbraco Forms. For the less common ones, a usage has been indicated in the table.
 

13/umbraco-forms/developer/magic-strings.md

@@ -50,6 +50,12 @@ Some extra variables are:
 
 `[$myRecursiveItem]` this allows you to parse the Umbraco Document Type property myRecursiveItem. So if the current page does not contain a value for this then it will request it from the parent up until the root or until it finds a value.
 
+### Additional data
+
+When rendering a form, additional data can be provided in the form of a dictionary. As well as being associated with the created record and available within workflows, they can be used for "magic string" replacements.
+
+They are accessed using this syntax: `[+additionalDataKey]`.
+
 ### Umbraco Form field
 
 `{myAliasForFormField}` this allows you to display the entered value for that specific field from the form submission. Used in workflows to send an automated email back to the customer based on the email address submitted in the form. The value here needs to be the alias of the field, and not the name of the field.
@@ -82,16 +88,17 @@ For example, to truncate a string value read from an Umbraco page field with ali
 
 Umbraco Forms ships with the following filters:
 
-| Filter                        | Function   | Arguments            | Example                              |
-| ----------------------------- | ---------- | -------------------- | ------------------------------------ |
-| Bound a number                | `bound`    | min and max bound    | `[#field \| bound: 1: 10]`           |
-| Convert string to lower case  | `lower`    |                      | `[#field \| lower]`                  |
-| Convert string to upper case  | `upper`    |                      | `[#field \| upper]`                  |
-| Truncate a string             | `truncate` | number of characters | `[#field \| truncate: 10]`           |
-| Format a number               | `number`   | format string        | `[#field \| number: #0.##%]`         |
-| Format a number as a currency | `currency` |                      | `[#field \| currency]`               |
-| Format a date                 | `date`     | format string        | `[#field \| date: dd-MM-yyyy HH:mm]` |
-| HTML encode a string          | `html`     |                      | `[#field \| html]`                   |
+| Filter                                           | Function                | Arguments            | Example                                              |
+| ------------------------------------------------ | ----------------------- | -------------------- | ---------------------------------------------------- |
+| Bound a number                                   | `bound`                 | min and max bound    | `[#field \| bound: 1: 10]`                           |
+| Convert string to lower case                     | `lower`                 |                      | `[#field \| lower]`                                  |
+| Convert string to upper case                     | `upper`                 |                      | `[#field \| upper]`                                  |
+| Format a number                                  | `number`                | format string        | `[#field \| number: #0.##%]`                         |
+| Format a number as a currency                    | `currency`              |                      | `[#field \| currency]`                               |
+| Format a date                                    | `date`                  | format string        | `[#field \| date: dd-MM-yyyy HH:mm]`                 |
+| HTML encode a string                             | `html`                  |                      | `[#field \| html]`                                   |
+| Truncate a string                                | `truncate`              | number of characters | `[#field \| truncate: 10]`                           |
+
 
 The format strings used for formatting dates and numbers are the standard or custom .NET [date](https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings) and [numeric](https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings) format strings respectively.
 

13/umbraco-forms/developer/rendering-forms.md

@@ -14,18 +14,20 @@ To display a form in your view, you can make a call to a view component:
 @await Component.InvokeAsync("RenderForm", new { formId = Guid.Parse("<form guid>"), theme = "default", includeScripts = false })
 ```
 
-Five parameters can be provided:
+Six parameters can be provided:
 
 - `formId` is the GUID of a form.
 - `theme` is the name of a theme. If not provided, the default theme is used (see [Themes](./themes.md)).
 - `includeScripts` indicates whether scripts should be rendered with the form (see [Rendering Scripts](./rendering-scripts.md).
 - `recordId` is an optional existing record GUID, used if editing records via the website is [enabled in configuration](../developer/configuration/README.md#alloweditableformsubmissions)
 - `redirectToPageId` is an optional GUID for a content page that, if provided, is redirected to once the form has been submitted. It will be used in preference to post-submission behavior defined on the form itself.
+- `additionalData` is an optional dictionary of string values. When provided it will be used as a source for ["magic string" replacements](./magic-strings.md). The data will be associated with the created record and made available for custom logic or update within workflows.
 
 Usually, rather than hard-coding the form's GUID and other details, you'll use a form, theme or content picker on your page:
 
 ```csharp
-@await Component.InvokeAsync("RenderForm", new { formId = @Model.Form, theme = @Model.Theme, includeScripts = false })
+var additionalData = new Dictionary<string, string> { { "foo", "bar" }, { "buzz", "baz" } };
+@await Component.InvokeAsync("RenderForm", new { formId = @Model.Form, theme = @Model.Theme, includeScripts = false, additionalData })
 ```
 
 ## Rendering Using a Tag Helper
@@ -43,7 +45,8 @@ Then in your view you can use:
 ```csharp
 @if (Model.Form.HasValue)
 {
-    <umb-forms-render form-id="@Model.FormId.Value" theme="@Model.FormTheme" exclude-scripts="true" />
+    var additionalData = new Dictionary<string, string> { { "foo", "bar" }, { "buzz", "baz" } };
+    <umb-forms-render form-id="@Model.FormId.Value" theme="@Model.FormTheme" exclude-scripts="true" additional-data="@additionalData" />
 }
 ```