-
Notifications
You must be signed in to change notification settings - Fork 811
Added release notes for Forms 13.4-rc1 and 15.1-rc1 #6731
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
eshanrnh
merged 25 commits into
umbraco:main
from
AndyButland:forms/release-notes-13.4.0-rc1-and-15.1.0-rc1
Dec 13, 2024
Merged
Changes from all commits
Commits
Show all changes
25 commits
Select commit
Hold shift + click to select a range
da0f3d5
Added release notes for Forms 13.4-rc1 and 15.1-rc1
AndyButland df8a62d
Correction
AndyButland 05b631b
Linting
AndyButland 535ab3d
Update 13/umbraco-forms/developer/configuration/README.md
eshanrnh 86a3256
Update 13/umbraco-forms/developer/configuration/README.md
eshanrnh 36b82b9
Update 13/umbraco-forms/editor/creating-a-form/form-advanced.md
eshanrnh af72df4
Update 13/umbraco-forms/editor/creating-a-form/form-advanced.md
eshanrnh de35633
Update 13/umbraco-forms/editor/creating-a-form/form-advanced.md
eshanrnh 12da115
Update 13/umbraco-forms/editor/creating-a-form/form-advanced.md
eshanrnh 56284c4
Update 13/umbraco-forms/release-notes.md
eshanrnh 03bd8e4
Update 13/umbraco-forms/release-notes.md
eshanrnh a5fcad4
Update 15/umbraco-forms/developer/configuration/README.md
eshanrnh 059a7e2
Update 15/umbraco-forms/editor/creating-a-form/form-advanced.md
eshanrnh 0001dcf
Update 15/umbraco-forms/developer/configuration/README.md
eshanrnh 1d2dcaa
Update 15/umbraco-forms/editor/creating-a-form/form-advanced.md
eshanrnh 96c8dd9
Update 15/umbraco-forms/editor/creating-a-form/form-advanced.md
eshanrnh aec7c7c
Update 15/umbraco-forms/editor/creating-a-form/form-advanced.md
eshanrnh d78f72a
Update 15/umbraco-forms/release-notes.md
eshanrnh cd1d8b8
Update 15/umbraco-forms/release-notes.md
eshanrnh b9a52b9
Update 13/umbraco-forms/release-notes.md
eshanrnh d990702
Update 13/umbraco-forms/editor/creating-a-form/form-advanced.md
eshanrnh 128f29c
Update 15/umbraco-forms/editor/creating-a-form/form-advanced.md
eshanrnh 9d3d02b
Update 15/umbraco-forms/release-notes.md
eshanrnh d68c0b0
Further advanced validation rule example
AndyButland b9bd789
Merge branch 'forms/release-notes-13.4.0-rc1-and-15.1.0-rc1' of https…
AndyButland File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| # Form Advanced Options | ||
|
|
||
| In this article, you will find information about accessing the Forms Advanced Options and the features available to customize your Form. | ||
|
|
||
| To access the Form Advanced Options: | ||
|
|
||
| 1. Navigate to the **Forms** section. | ||
| 2. Open a Form you wish to customize. | ||
| 3. Click **Advanced** in the top-right corner of the screen. | ||
|
|
||
| {% hint style="info" %} | ||
| The advanced options for forms are only available when [configured to display](../../developer/configuration/README.md#enableadvancedvalidationrules). | ||
| {% endhint %} | ||
|
|
||
| ## Validation Rules | ||
|
|
||
| When creating forms you can add validation to individual fields, making them mandatory or applying a regular expression pattern. You can provide validation rules for the entire form via the advanced options. This allows you to validate expressions based on multiple fields. For example, "these two email fields should be the same", or "this date should be after this other one". | ||
|
|
||
|  | ||
|
|
||
| To add new rules, you need to provide the rule definition, an error message and select a field to which the message will be associated. Once created you can click to edit or delete them from the list. | ||
|
|
||
| Crafting the rule definition itself requires use of [JSON logic](https://jsonlogic.com/) along with placeholders for the field or fields that are being validated. | ||
|
|
||
| ### Examples | ||
|
|
||
| One example use case would be ensuring that two fields match each other, perhaps when asking for a user's email address. Given two fields on the form, one with the alias of `email` and the other `compareEmail`, the rule would be: | ||
|
|
||
| ```json | ||
| { | ||
| "==": [ | ||
| "{email}", | ||
| "{compareEmail}" | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| A slightly more complex example could be with two dates, where, if provided, you want to ensure the second date is later than the first. So given fields with aliases of `startDate` and `endDate` a rule would look like this: | ||
|
|
||
| ```json | ||
| { | ||
| "or": [ | ||
| { | ||
| "==": [ | ||
| "{startDate}", | ||
| "" | ||
| ] | ||
| }, | ||
| { | ||
| "==": [ | ||
| "{endDate}", | ||
| "" | ||
| ] | ||
| }, | ||
| { | ||
| ">": [ | ||
| "{endDate}", | ||
| "{startDate}" | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| Rules can be nested too. In this final illustrative example, we have two fields. One with the alias `choose` is a drop-down list with two values: `A` and `B`. The second field with alias `test` we want to be completed only if the user selects `B`. So we create a rule that is valid only if A is selected OR B is selected AND `test` is completed. | ||
|
Check failure on line 65 in 13/umbraco-forms/editor/creating-a-form/form-advanced.md
|
||
|
|
||
| ```json | ||
| { | ||
| "or": [ | ||
| { | ||
| "==": [ | ||
| "{choose}", | ||
| "A" | ||
| ] | ||
| }, | ||
| { | ||
| "and": [ | ||
| { | ||
| "==": [ | ||
| "{choose}", | ||
| "B" | ||
| ] | ||
| }, | ||
| { | ||
| "!=": [ | ||
| "{test}", | ||
| "" | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| Overall, you can create rules of varying complexity, using comparisons between fields and static values. | ||
|
|
||
| When the form is rendered, these validation rules will be applied on both the client and server-side. In this way, you can ensure the submission is only accepted if it meets the requirements. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| # Form Advanced Options | ||
|
|
||
| In this article, you will find information about accessing the Forms Advanced Options and the features available to customize your Form. | ||
|
|
||
| To access the Form Advanced Options: | ||
|
|
||
| 1. Navigate to the **Forms** section. | ||
| 2. Open a Form you wish to customize. | ||
| 3. Click **Advanced** in the top-right corner of the screen. | ||
|
|
||
| {% hint style="info" %} | ||
| The advanced options for forms are only available when [configured to display](../../developer/configuration/README.md#enableadvancedvalidationrules). | ||
| {% endhint %} | ||
|
|
||
| ## Validation Rules | ||
|
|
||
| When creating forms you can add validation to individual fields, making them mandatory or applying a regular expression pattern. You can provide validation rules for the entire form via the advanced options. This allows you to validate expressions based on multiple fields. For example, "these two email fields should be the same", or "this date should be after this other one". | ||
|
|
||
|  | ||
|
|
||
| To add new rules, you need to provide the rule definition, an error message and select a field to which the message will be associated. Once created you can click to edit or delete them from the list. | ||
eshanrnh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Crafting the rule definition itself requires use of [JSON logic](https://jsonlogic.com/) along with placeholders for the field or fields that are being validated. | ||
|
|
||
| ### Examples | ||
|
|
||
| One example use case would be ensuring that two fields match each other, perhaps when asking for a user's email address. Given two fields on the form, one with the alias of `email` and the other `compareEmail`, the rule would be: | ||
|
|
||
| ```json | ||
| { | ||
| "==": [ | ||
| "{email}", | ||
| "{compareEmail}" | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| A slightly more complex example could be with two dates, where, if provided, you want to ensure the second date is later than the first. So given fields with aliases of `startDate` and `endDate` a rule would look like this: | ||
|
|
||
| ```json | ||
| { | ||
| "or": [ | ||
| { | ||
| "==": [ | ||
| "{startDate}", | ||
| "" | ||
| ] | ||
| }, | ||
| { | ||
| "==": [ | ||
| "{endDate}", | ||
| "" | ||
| ] | ||
| }, | ||
| { | ||
| ">": [ | ||
| "{endDate}", | ||
| "{startDate}" | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| Rules can be nested too. In this final illustrative example, we have two fields. One with the alias `choose` is a drop-down list with two values: `A` and `B`. The second field with alias `test` we want to be completed only if the user selects `B`. So we create a rule that is valid only if A is selected OR B is selected AND `test` is completed. | ||
|
Check failure on line 65 in 15/umbraco-forms/editor/creating-a-form/form-advanced.md
|
||
|
|
||
| ```json | ||
| { | ||
| "or": [ | ||
| { | ||
| "==": [ | ||
| "{choose}", | ||
| "A" | ||
| ] | ||
| }, | ||
| { | ||
| "and": [ | ||
| { | ||
| "==": [ | ||
| "{choose}", | ||
| "B" | ||
| ] | ||
| }, | ||
| { | ||
| "!=": [ | ||
| "{test}", | ||
| "" | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| Overall, you can create rules of varying complexity, using comparisons between fields and static values. | ||
|
|
||
| When the form is rendered, these validation rules will be applied on both the client and server-side. In this way, you can ensure the submission is only accepted if it meets the requirements. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.