@vonage/vivid-react 3.4.1 → 3.5.0

package/v3/VwcCheckbox/index.js

@@ -68,14 +68,6 @@ Code in this file were generated using following JSON:
   }
  ],
  "members": [
-  {
-   "kind": "field",
-   "name": "ariaLabel",
-   "type": {
-    "text": "string | null"
-   },
-   "default": "null"
-  },
   {
    "kind": "field",
    "name": "tabindex",
@@ -95,42 +87,387 @@ Code in this file were generated using following JSON:
   },
   {
    "kind": "field",
-   "name": "ariaChecked",
+   "name": "readOnly",
    "type": {
-    "text": "AriaCheckedStates | null"
+    "text": "boolean"
    },
-   "default": "null",
-   "description": "The current checkbox state",
+   "description": "When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information.",
    "privacy": "public"
   },
   {
    "kind": "field",
-   "name": "readOnly",
+   "name": "indeterminate",
    "type": {
     "text": "boolean"
    },
-   "description": "When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information.",
+   "default": "false",
+   "description": "The indeterminate state of the control.",
    "privacy": "public"
   },
+  {
+   "kind": "method",
+   "name": "ariaCheckedChanged"
+  },
   {
    "kind": "field",
-   "name": "indeterminate",
+   "name": "_vividAriaBehaviour",
+   "default": "'delegate'",
+   "type": {
+    "text": "'delegate'"
+   },
+   "inheritedFrom": {
+    "name": "DelegatesAria",
+    "module": "src/shared/aria/delegates-aria.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "helperText",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "Provides additional information to help the user enter the correct information.\nTo add HTML to the helper text, use the helper-text slot instead.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "WithFeedback",
+    "module": "src/shared/feedback/mixins.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "errorText",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "Provides a custom error message. Any current error state will be overridden.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "#blockValidateCalls",
+   "privacy": "private",
    "type": {
     "text": "boolean"
    },
    "default": "false",
-   "description": "The indeterminate state of the control"
+   "inheritedFrom": {
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "#originalValidateFn",
+   "privacy": "private",
+   "type": {
+    "text": "() => void"
+   },
+   "inheritedFrom": {
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
+   }
   },
   {
    "kind": "method",
-   "name": "ariaCheckedChanged"
+   "name": "#forceCustomError",
+   "parameters": [
+    {
+     "name": "errorMessage",
+     "type": {
+      "text": "string"
+     }
+    }
+   ],
+   "inheritedFrom": {
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
+   }
+  },
+  {
+   "kind": "method",
+   "name": "#clearCustomErrorAndRevalidate",
+   "inheritedFrom": {
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "validate",
+   "inheritedFrom": {
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "successText",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "Provides a custom success message. Any current error state will be overridden.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "WithSuccessText",
+    "module": "src/shared/patterns/form-elements/with-success-text.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "label",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "The label for the form element.",
+   "inheritedFrom": {
+    "name": "FormElement",
+    "module": "src/shared/patterns/form-elements/form-element.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "#handleInvalidEvent",
+   "privacy": "private",
+   "inheritedFrom": {
+    "name": "FormElement",
+    "module": "src/shared/patterns/form-elements/form-element.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "defaultChecked",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "The default checkedness of the element. This value sets the `checked` property\nonly when the `checked` property has not been explicitly set.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "CheckableFormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "checked",
+   "type": {
+    "text": "boolean"
+   },
+   "description": "The current checkedness of the element.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "CheckableFormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "checkedAttribute",
+   "inheritedFrom": {
+    "name": "CheckableFormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "currentChecked",
+   "inheritedFrom": {
+    "name": "CheckableFormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "validity",
+   "type": {
+    "text": "ValidityState"
+   },
+   "description": "Returns the validity state of the element",
+   "readonly": true,
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "form",
+   "type": {
+    "text": "HTMLFormElement | null"
+   },
+   "description": "Retrieve a reference to the associated form.\nReturns null if not associated to any form.",
+   "readonly": true,
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "validationMessage",
+   "type": {
+    "text": "string"
+   },
+   "description": "Retrieve the localized validation message,\nor custom validation message if set.",
+   "readonly": true,
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "willValidate",
+   "type": {
+    "text": "boolean"
+   },
+   "description": "Whether the element will be validated when the\nform is submitted",
+   "readonly": true,
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "labels",
+   "type": {
+    "text": "ReadonlyArray<Node>"
+   },
+   "description": "A reference to all associated label elements",
+   "readonly": true,
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "value",
+   "type": {
+    "text": "string"
+   },
+   "description": "The current value of the element.",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "currentValue",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "initialValue",
+   "type": {
+    "text": "string"
+   },
+   "description": "The default value of the element. This value sets the `value` property\nonly when the `value` property has not been explicitly set.",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "disabled",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "Sets the element's disabled state. A disabled element will not be included during form submission.",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "name",
+   "type": {
+    "text": "string"
+   },
+   "description": "The name of the element. This element's value will be surfaced during form submission under the provided name.",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "required",
+   "type": {
+    "text": "boolean"
+   },
+   "description": "Require the field to be completed prior to form submission.",
+   "default": "false",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "method",
+   "name": "checkValidity",
+   "return": {
+    "type": {
+     "text": "boolean"
+    }
+   },
+   "description": "Return the current validity of the element.",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "method",
+   "name": "reportValidity",
+   "return": {
+    "type": {
+     "text": "boolean"
+    }
+   },
+   "description": "Return the current validity of the element.\nIf false, fires an invalid event at the element.",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "VIVID_VERSION",
+   "static": true,
+   "default": "__PACKAGE_VERSION__",
+   "description": "The current version of the Vivid library, which is useful for debugging.\nIt can be accessed from any Vivid element via `<el>.constructor.VIVID_VERSION`.",
+   "type": {
+    "text": "string"
+   },
+   "inheritedFrom": {
+    "name": "VividElement",
+    "module": "src/shared/foundation/vivid-element/vivid-element.ts"
+   }
   },
   {
    "kind": "field",
-   "name": "proxy",
+   "name": "componentName",
+   "type": {
+    "text": "string"
+   },
+   "static": true,
+   "description": "Core component name, without prefix",
    "inheritedFrom": {
-    "name": "FormAssociatedCheckbox",
-    "module": "libs/components/src/lib/checkbox/checkbox.form-associated.ts"
+    "name": "VividElement",
+    "module": "src/shared/foundation/vivid-element/vivid-element.ts"
    }
   }
  ],
@@ -151,14 +488,6 @@ Code in this file were generated using following JSON:
   }
  ],
  "attributes": [
-  {
-   "name": "aria-label",
-   "type": {
-    "text": "string | null"
-   },
-   "default": "null",
-   "fieldName": "ariaLabel"
-  },
   {
    "name": "tabindex",
    "type": {
@@ -176,26 +505,187 @@ Code in this file were generated using following JSON:
    "fieldName": "connotation"
   },
   {
-   "name": "aria-checked",
+   "name": "readonly",
    "type": {
-    "text": "AriaCheckedStates | null"
+    "text": "boolean"
    },
-   "default": "null",
-   "description": "The current checkbox state",
-   "fieldName": "ariaChecked"
+   "description": "When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information.",
+   "fieldName": "readOnly"
   },
   {
-   "name": "readonly",
+   "name": "indeterminate",
    "type": {
     "text": "boolean"
    },
-   "description": "When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information.",
-   "fieldName": "readOnly"
+   "default": "false",
+   "description": "The indeterminate state of the control.",
+   "fieldName": "indeterminate"
+  },
+  {
+   "name": "helper-text",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "Provides additional information to help the user enter the correct information.\nTo add HTML to the helper text, use the helper-text slot instead.",
+   "fieldName": "helperText",
+   "inheritedFrom": {
+    "name": "WithFeedback",
+    "module": "src/shared/feedback/mixins.ts"
+   }
+  },
+  {
+   "name": "error-text",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "Provides a custom error message. Any current error state will be overridden.",
+   "fieldName": "errorText",
+   "inheritedFrom": {
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
+   }
+  },
+  {
+   "name": "success-text",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "Provides a custom success message. Any current error state will be overridden.",
+   "fieldName": "successText",
+   "inheritedFrom": {
+    "name": "WithSuccessText",
+    "module": "src/shared/patterns/form-elements/with-success-text.ts"
+   }
+  },
+  {
+   "name": "label",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "The label for the form element.",
+   "fieldName": "label",
+   "inheritedFrom": {
+    "name": "FormElement",
+    "module": "src/shared/patterns/form-elements/form-element.ts"
+   }
+  },
+  {
+   "name": "checked",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "The default checkedness of the element. This value sets the `checked` property\nonly when the `checked` property has not been explicitly set.",
+   "fieldName": "defaultChecked",
+   "inheritedFrom": {
+    "name": "CheckableFormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "name": "current-checked",
+   "type": {
+    "text": "boolean"
+   },
+   "description": "The current checkedness of the element.",
+   "fieldName": "checked",
+   "inheritedFrom": {
+    "name": "CheckableFormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "name": "current-value",
+   "type": {
+    "text": "string"
+   },
+   "description": "The current value of the element.",
+   "fieldName": "value",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "name": "value",
+   "type": {
+    "text": "string"
+   },
+   "description": "The default value of the element. This value sets the `value` property\nonly when the `value` property has not been explicitly set.",
+   "fieldName": "initialValue",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "name": "disabled",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "Sets the element's disabled state. A disabled element will not be included during form submission.",
+   "fieldName": "disabled",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "name": "name",
+   "type": {
+    "text": "string"
+   },
+   "description": "The name of the element. This element's value will be surfaced during form submission under the provided name.",
+   "fieldName": "name",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "name": "required",
+   "type": {
+    "text": "boolean"
+   },
+   "description": "Require the field to be completed prior to form submission.",
+   "default": "false",
+   "fieldName": "required",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  }
+ ],
+ "mixins": [
+  {
+   "name": "DelegatesAria",
+   "module": "/src/shared/aria/delegates-aria"
+  },
+  {
+   "name": "WithFeedback",
+   "module": "/src/shared/feedback/mixins"
+  },
+  {
+   "name": "WithErrorText",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "WithSuccessText",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "FormElement",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "CheckableFormAssociated",
+   "module": "/src/shared/foundation/form-associated/form-associated"
   }
  ],
  "superclass": {
-  "name": "FormAssociatedCheckbox",
-  "module": "/libs/components/src/lib/checkbox/checkbox.form-associated"
+  "name": "VividElement",
+  "module": "/src/shared/foundation/vivid-element/vivid-element"
  },
  "vividComponent": {
   "public": true,
@@ -203,11 +693,11 @@ Code in this file were generated using following JSON:
   "vueModels": [
    {
     "name": "modelValue",
-    "attributeName": "checked",
+    "propName": "checked",
     "eventNames": [
      "change"
     ],
-    "valueMapping": "(event.target as HTMLInputElement).checked"
+    "valueMapping": "event.currentTarget.checked"
    }
   ]
  }
@@ -221,7 +711,7 @@ registerCheckbox('vvd3')
 const VwcCheckbox = wrapper(`vvd3-checkbox`,  {
     events: [{"name":"change","propName":"onChange"},{"name":"input","propName":"onInput"}],
     attributes: [],
-    properties: ['ariaLabel', 'tabindex', 'connotation', 'ariaChecked', 'readOnly', 'indeterminate', 'proxy', 'onClick', 'label', 'value', 'checked', 'indeterminate', 'disabled', 'readonly']
+    properties: ['tabindex', 'connotation', 'readOnly', 'indeterminate', '_vividAriaBehaviour', 'helperText', 'errorText', 'validate', 'successText', 'label', 'defaultChecked', 'checked', 'checkedAttribute', 'currentChecked', 'value', 'currentValue', 'initialValue', 'disabled', 'name', 'required', 'VIVID_VERSION', 'componentName', 'onClick', 'label', 'value', 'checked', 'indeterminate', 'disabled', 'readonly']
 })
 
 VwcCheckbox.displayName = 'VwcCheckbox'

package/v3/VwcCheckbox/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@vonage/vivid-react-vvd3-checkbox",
-  "version": "4.16.2",
+  "version": "4.28.0",
   "main": "index.js",
   "types": "index.d.ts",
   "private": true,
   "license": "MIT",
   "dependencies": {
-    "@vonage/vivid": "4.16.2"
+    "@vonage/vivid": "4.28.0"
   }
 }