@vonage/vivid-react 3.4.1 → 3.5.1

package/v3/VwcNumberField/index.js

@@ -231,7 +231,11 @@ Code in this file were generated using following JSON:
   {
    "kind": "method",
    "name": "validate",
-   "description": "{@inheritDoc (FormAssociated:interface).validate}"
+   "description": "{@inheritDoc (FormAssociated:interface).validate}",
+   "inheritedFrom": {
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
+   }
   },
   {
    "kind": "method",
@@ -290,10 +294,326 @@ Code in this file were generated using following JSON:
   },
   {
    "kind": "field",
-   "name": "proxy",
+   "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",
+   "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": "#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": "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": "icon",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "A decorative icon the custom element should have.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "AffixIcon",
+    "module": "src/shared/patterns/affix.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "_vividAriaBehaviour",
+   "default": "'delegate'",
+   "type": {
+    "text": "'delegate'"
+   },
+   "inheritedFrom": {
+    "name": "DelegatesAria",
+    "module": "src/shared/aria/delegates-aria.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": "FormAssociatedNumberField",
-    "module": "libs/components/src/lib/number-field/number-field.form-associated.ts"
+    "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": "componentName",
+   "type": {
+    "text": "string"
+   },
+   "static": true,
+   "description": "Core component name, without prefix",
+   "inheritedFrom": {
+    "name": "VividElement",
+    "module": "src/shared/foundation/vivid-element/vivid-element.ts"
    }
   }
  ],
@@ -324,6 +644,7 @@ Code in this file were generated using following JSON:
    "fieldName": "readOnly"
   },
   {
+   "name": "autofocus",
    "type": {
     "text": "boolean"
    },
@@ -348,6 +669,7 @@ Code in this file were generated using following JSON:
    "fieldName": "list"
   },
   {
+   "name": "maxlength",
    "type": {
     "text": "number"
    },
@@ -355,6 +677,7 @@ Code in this file were generated using following JSON:
    "fieldName": "maxlength"
   },
   {
+   "name": "minlength",
    "type": {
     "text": "number"
    },
@@ -362,6 +685,7 @@ Code in this file were generated using following JSON:
    "fieldName": "minlength"
   },
   {
+   "name": "size",
    "type": {
     "text": "number"
    },
@@ -377,6 +701,7 @@ Code in this file were generated using following JSON:
    "fieldName": "scale"
   },
   {
+   "name": "step",
    "type": {
     "text": "number"
    },
@@ -385,6 +710,7 @@ Code in this file were generated using following JSON:
    "fieldName": "step"
   },
   {
+   "name": "max",
    "type": {
     "text": "number"
    },
@@ -392,6 +718,7 @@ Code in this file were generated using following JSON:
    "fieldName": "max"
   },
   {
+   "name": "min",
    "type": {
     "text": "number"
    },
@@ -434,11 +761,167 @@ Code in this file were generated using following JSON:
     "text": "string | undefined"
    },
    "fieldName": "autoComplete"
+  },
+  {
+   "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": "icon",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "A decorative icon the custom element should have.",
+   "fieldName": "icon",
+   "inheritedFrom": {
+    "name": "AffixIcon",
+    "module": "src/shared/patterns/affix.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": "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": "AffixIcon",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "Localized",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "DelegatesAria",
+   "module": "/src/shared/aria/delegates-aria"
+  },
+  {
+   "name": "FormAssociated",
+   "module": "/src/shared/foundation/form-associated/form-associated"
   }
  ],
  "superclass": {
-  "name": "FormAssociatedNumberField",
-  "module": "/libs/components/src/lib/number-field/number-field.form-associated"
+  "name": "VividElement",
+  "module": "/src/shared/foundation/vivid-element/vivid-element"
  },
  "vividComponent": {
   "public": true,
@@ -446,11 +929,19 @@ Code in this file were generated using following JSON:
   "vueModels": [
    {
     "name": "modelValue",
-    "attributeName": "value",
+    "propName": "value",
+    "eventNames": [
+     "input"
+    ],
+    "valueMapping": "event.currentTarget.value"
+   },
+   {
+    "name": "valueAsNumber",
+    "propName": "valueAsNumber",
     "eventNames": [
      "input"
     ],
-    "valueMapping": "(event.target as HTMLInputElement).value"
+    "valueMapping": "event.currentTarget.valueAsNumber"
    }
   ]
  }
@@ -464,7 +955,7 @@ registerNumberField('vvd3')
 const VwcNumberField = wrapper(`vvd3-number-field`,  {
     events: [{"name":"input","propName":"onInput"},{"name":"change","propName":"onChange"}],
     attributes: [],
-    properties: ['readOnly', 'autofocus', 'placeholder', 'list', 'maxlength', 'minlength', 'size', 'scale', 'step', 'max', 'min', 'valueAsNumber', 'incrementButtonAriaLabel', 'decrementButtonAriaLabel', 'appearance', 'shape', 'autoComplete', 'proxy']
+    properties: ['readOnly', 'autofocus', 'placeholder', 'list', 'maxlength', 'minlength', 'size', 'scale', 'step', 'max', 'min', 'valueAsNumber', 'incrementButtonAriaLabel', 'decrementButtonAriaLabel', 'appearance', 'shape', 'autoComplete', 'helperText', 'errorText', 'successText', 'label', 'icon', '_vividAriaBehaviour', 'value', 'currentValue', 'initialValue', 'disabled', 'name', 'required', 'VIVID_VERSION', 'componentName']
 })
 
 VwcNumberField.displayName = 'VwcNumberField'

package/v3/VwcNumberField/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@vonage/vivid-react-vvd3-number-field",
-  "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"
   }
 }

package/v3/VwcOption/index.d.ts

@@ -15,7 +15,15 @@ single selection mode.
 * @param {string | undefined} _text  **attribute** `text`
 * @param  text
 * @param {string} value
+* @param {string | undefined} matchedText - Text to highlighted as matching a search query. **attribute** `matched-text`
+* @param {OptionTagConnotation | undefined} tagConnotation - When displayed as a tag, the connotation of the tag. **attribute** `tag-connotation`
 * @param  proxy
+* @param {'host'} _vividAriaBehaviour
+* @param {boolean} iconTrailing - Indicates the icon affix alignment. **attribute** `icon-trailing`
+* @param {string | undefined} icon - A decorative icon the custom element should have. **attribute** `icon`
+* @param {string} VIVID_VERSION - The current version of the Vivid library, which is useful for debugging.
+It can be accessed from any Vivid element via `<el>.constructor.VIVID_VERSION`.
+* @param {string} componentName - Core component name, without prefix
 */
 declare const VwcOption: {
     (props: {
@@ -35,7 +43,14 @@ declare const VwcOption: {
         _text?: string | undefined;
         text?: any;
         value?: string | undefined;
+        matchedText?: string | undefined;
+        tagConnotation?: any;
         proxy?: any;
+        _vividAriaBehaviour?: any;
+        iconTrailing?: boolean | undefined;
+        icon?: string | undefined;
+        VIVID_VERSION?: string | undefined;
+        componentName?: string | undefined;
     }): JSX.Element;
     displayName: string;
 };