Make required fields in dates and address fragments configurable

README.md

@@ -669,6 +669,41 @@ Here is an example of using it with the `screenWithOneInput` fragment:
 
 Note that passing `required=true` here will append the red `(required)` to the label.
 
+#### Special situation for requiring address fields
+
+Sometimes you may want to apply custom validations to address fields through actions that effectively
+make the address field required. In these situations because you are not using annotations to make the
+address fields required, the library won't pick up on the fact that the fields should be marked as required.
+
+To handle this situation, we have provided a special attribute `requireAddressFields` which is a boolean
+that can be passed when calling the address input fragment like so:
+```html
+<th:block th:replace="~{fragments/inputs/address ::
+    address(requireAddressFields=true,
+    inputName='residentialAddress')}"/>
+
+```
+This will apply the red `(required)` to the address fields in the UI. Note it will not do so for the 
+street address line 2 as these are typically considered optional.
+
+#### Special situation for requiring date fields
+
+Sometimes you may want to apply custom validations to date fields through actions that effectively make
+the date fields required. In these situations because you are not using annotations to make the date
+fields required, the library won't pick up on the fact that the fields should be marked as required.
+
+For these situations we have provided a special attribute `requireDateFields` which is a boolean that
+can be passed when calling the date input fragment like so:
+```html
+<th:block th:replace="~{fragments/inputs/date ::
+    date(inputName='birth',
+    requireDateFields=true,
+    label=#{personal-info.birth-label},
+    groupName='birthDate')}"/>
+```
+
+This will apply the red `(required)` to the date fields in the UI.
+
 ## Dynamic Input Fields
 
 A field is dynamic if it is unknown exactly how many of them will be submitted on a given form

src/main/resources/templates/fragments/inputs/address.html

@@ -1,6 +1,7 @@
 <th:block
     th:fragment="address(validate, inputName)"
     th:with="
+    requireAddressFields=${requireAddressFields ?: false},
     streetAddressLabelDefault=#{address.street-address-1},
     streetAddress2LabelDefault=#{address.street-address-2},
     cityLabelDefault=#{address.city},
@@ -20,6 +21,7 @@
 >
   <th:block th:replace="~{fragments/inputs/text ::
                   text(inputName=${streetAddressInputName},
+                  required=${requireAddressFields},
                   label=${streetAddressLabel},
                   helpText=${streetAddressHelpText})}"/>
   <th:block th:replace="~{fragments/inputs/text ::
@@ -28,14 +30,17 @@
                   helpText=${streetAddress2HelpText})}"/>
   <th:block th:replace="~{fragments/inputs/text ::
                   text(inputName=${cityInputName},
+                  required=${requireAddressFields},
                   label=${cityLabel},
                   helpText=${cityHelpText})}"/>
   <th:block th:replace="~{fragments/inputs/state ::
                   state(inputName=${stateInputName},
+                  required=${requireAddressFields},
                   label=${stateLabel},
                   helpText=${stateHelpText})}"/>
   <th:block th:replace="~{fragments/inputs/text ::
                   text(inputName=${zipCodeInputName},
+                  required=${requireAddressFields},
                   label=${zipCodeLabel},
                   helpText=${zipCodeHelpText})}"/>
   <input type="hidden"

src/main/resources/templates/fragments/inputs/date.html

@@ -3,6 +3,7 @@
     th:with="
       hasLabel=${!#strings.isEmpty(label)},
       hasAriaLabel=${!#strings.isEmpty(ariaLabel)},
+      requireDateFields=${requireDateFields ?: false},
       requiredInputsForFlow=${requiredInputs.get(flow)},
       isRequiredInput=${(requiredInputsForFlow != null && requiredInputsForFlow.getOrDefault(inputName + 'Month', false)) || 
         (requiredInputsForFlow != null && requiredInputsForFlow.getOrDefault(inputName + 'Day', false)) || 
@@ -18,7 +19,7 @@
       <legend th:if="${hasLabel}" th:for="${inputName}"
              class="form-question">
         <span th:text="${label}"></span>
-        <span th:if="${isRequiredInput && !hasAriaLabel}" class="required-input" th:text="#{general.required-field}"></span>
+        <span th:if="${(isRequiredInput || requireDateFields) && !hasAriaLabel}" class="required-input" th:text="#{general.required-field}"></span>
       </legend>
       <th:block
           th:replace="~{fragments/inputError :: validationError(inputName=${inputName} + 'Month')}"></th:block>