@motopays/pay-form 1.0.16-rc.0 → 1.0.16-rc.2

package/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## 1.0.16
 
+### Added
+- userPreferences field added to settings model. This field allows to configure non-required checkboxes that have to be selected by users. Check README.md to see more details
+
 ### Changed
 - 'hidden-enabled' and 'disabled' states for settings.requiredFieldsBehavior.buttonStateUntilCorrect enables buttons when user has filled required fields (without validation). On click the validation occures
 

package/README.md

@@ -147,13 +147,17 @@ declare module "@motopays/pay-form/pay";
 | chargeTerms                 | IChargeTermsSettings | The charge terms section |
 | chargeTerms.visible         | boolean | Whether to show the charge terms |
 | chargeTerms.checkboxes      | ITermCheckbox[] | The checkboxes that, without being selected, the user will not be able to make a payment. All these checkboxes have to be selected by user to be able to make a payment |
-| chargeTerms.text            | string   | The text of charge terms. For example, description of subscription plan |
+| chargeTerms.text            | string   | The text of charge terms. For example, description of terms and policy |
 | chargeTerms.location        | string or ChargeTermsLocation | The location of ChargeTerms element. Currently accepted: { BeforePay, AfterPay } |
 | availableCardBrands         | string[] or CreditCardTypeCardBrandId[] | The сard brands for which icons will be displayed on the form as card payment methods. Currently accepted: {american-express, discover, jcb, maestro, mastercard, unionpay, visa} |
 | requiredFieldsBehavior      | IRequiredFieldsBehavior | Configuration of the display of required fields for the user to manage the user's focus on them |
 | requiredFieldsBehavior<br>.showStars | boolean | Show the stars on labels of required fields |
 | requiredFieldsBehavior<br>.buttonStateUntilCorrect | string | If 'disabled', the payment buttons remain disabled until the user fills in all the required fields. If 'enabled', then when one of the buttons is pressed (the buttons are enabled), the required fields will be marked as invalid (red color) for the user. If 'hidden-enabled', then when one of the buttons is pressed (the buttons are enabled but have styles as disabled), the required fields will be marked as invalid (red color) for the user. Current accepted: { enabled, disabled, hidden-enabled } |
 | requiredFieldsBehavior<br>.markAsInvalidUntilCorrect | boolean | If true, then all unfilled or incorrectly filled required fields will initially appear as invalid (red color) to the user until they are filled and correct. If the value is false, the required fields will only be shown as invalid in the event that the user presses the payment button when the buttons are enabled |
+| userPreferences             | IUserPreferencesSettings | The user preferences section |
+| userPreferences.visible     | boolean | Whether to show the user preferences |
+| userPreferences.text        | string  | The text of user preferences. For example, description of autorefill plan |
+| userPreferences.checkboxes  | IUserPreferenceCheckbox[]  | The text of user preferences. For example, description of autorefill plan |
 
 
 ILink interface:
@@ -172,6 +176,16 @@ interface ITermCheckbox {
 }
 ```
 
+IUserPreferenceCheckbox interface:
+```
+interface IUserPreferenceCheckbox {
+    name: string;
+    text: string;
+    link?: ILink;
+    defaultValue?: boolean;
+}
+```
+
 Example of merchantInfo:
 ```
 merchantInfo: {
@@ -214,6 +228,33 @@ chargeTerms: {
 },
 ```
 
+Example of userPreferences:
+```
+"userPreferences": {
+  "visible": true,
+  "text": "By checking this box, I am affirming my full and complete understanding of, as well as my agreement to, all the terms and conditions that were previously presented to me, acknowledging that they form a binding contractual agreement.",
+  "checkboxes": [
+    {
+      "name": "autoFill",
+      "text": "Do you want to auto refill? Check this.",
+      "link": {
+        "text": "Refill policy",
+        "href": "https://www.google.com/"
+      }
+    },
+    {
+      "name": "isGood",
+      "defaultValue": true,
+      "text": "Do you want to mark this as good? Check this.",
+      "link": {
+        "text": "Link to the application",
+        "href": "https://www.google.com/"
+      }
+    }
+  ]
+}
+```
+
 ### Output events
 
 | Event | Type           | Description                                  |