@vonage/vivid-react 3.4.1 → 3.5.0

package/v3/VwcCombobox/index.d.ts

@@ -15,12 +15,25 @@ HTML Attribute: string **attribute** `placement`
 * @param {boolean} open - The open attribute. **attribute** `open`
 * @param {ListboxOption[]} options - The list of options.
 * @param {string} placeholder - Sets the placeholder value of the element, generally used to provide a hint to the user. **attribute** `placeholder`
-* @param  value - The value property.
-* @param  proxy
-* @param {boolean} disabled - The disabled state of the listbox. **attribute** `disabled`
+* @param {string | undefined} helperText - Provides additional information to help the user enter the correct information.
+To add HTML to the helper text, use the helper-text slot instead. **attribute** `helper-text`
+* @param {string | undefined} errorText - Provides a custom error message. Any current error state will be overridden. **attribute** `error-text`
+* @param {string | undefined} successText - Provides a custom success message. Any current error state will be overridden. **attribute** `success-text`
+* @param {string | undefined} label - The label for the form element. **attribute** `label`
+* @param {string | undefined} icon - A decorative icon the custom element should have. **attribute** `icon`
+* @param {string} value - The current value of the element. **attribute** `current-value`
+* @param  currentValue
+* @param {string} initialValue - The default value of the element. This value sets the `value` property
+only when the `value` property has not been explicitly set. **attribute** `value`
+* @param {boolean} disabled - Sets the element's disabled state. A disabled element will not be included during form submission. **attribute** `disabled`
+* @param {string} name - The name of the element. This element's value will be surfaced during form submission under the provided name. **attribute** `name`
+* @param {boolean} required - Require the field to be completed prior to form submission. **attribute** `required`
 * @param {number} selectedIndex - The index of the selected option.
 * @param {ListboxOption[]} selectedOptions - A collection of the selected options.
 * @param  slottedOptionFilter - A static filter to include only selectable options.
+* @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 VwcCombobox: {
     (props: {
@@ -42,12 +55,22 @@ declare const VwcCombobox: {
         open?: boolean | undefined;
         options?: any[] | undefined;
         placeholder?: string | undefined;
-        value?: any;
-        proxy?: any;
+        helperText?: string | undefined;
+        errorText?: string | undefined;
+        successText?: string | undefined;
+        label?: string | undefined;
+        icon?: string | undefined;
+        value?: string | undefined;
+        currentValue?: any;
+        initialValue?: string | undefined;
         disabled?: boolean | undefined;
+        name?: string | undefined;
+        required?: boolean | undefined;
         selectedIndex?: number | undefined;
         selectedOptions?: any[] | undefined;
         slottedOptionFilter?: any;
+        VIVID_VERSION?: string | undefined;
+        componentName?: string | undefined;
     }): JSX.Element;
     displayName: string;
 };

package/v3/VwcCombobox/index.js

@@ -13,7 +13,7 @@ Code in this file were generated using following JSON:
    "name": ""
   },
   {
-   "description": "Slot to add an icon to the combobox control.",
+   "description": "The preferred way to add an icon to the combobox control.",
    "name": "icon"
   },
   {
@@ -112,7 +112,11 @@ Code in this file were generated using following JSON:
      "text": "void"
     }
    },
-   "description": "{@inheritDoc (FormAssociated:interface).validate}"
+   "description": "{@inheritDoc (FormAssociated:interface).validate}",
+   "inheritedFrom": {
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
+   }
   },
   {
    "kind": "field",
@@ -161,7 +165,7 @@ Code in this file were generated using following JSON:
    "privacy": "public",
    "inheritedFrom": {
     "name": "Listbox",
-    "module": "libs/components/src/shared/foundation/listbox/listbox.ts"
+    "module": "src/shared/foundation/listbox/listbox.ts"
    }
   },
   {
@@ -173,12 +177,6 @@ Code in this file were generated using following JSON:
    "description": "Sets the placeholder value of the element, generally used to provide a hint to the user.",
    "privacy": "public"
   },
-  {
-   "kind": "field",
-   "name": "value",
-   "description": "The value property.",
-   "privacy": "public"
-  },
   {
    "kind": "method",
    "name": "filterOptions",
@@ -192,24 +190,221 @@ 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": "FormAssociatedCombobox",
-    "module": "libs/components/src/lib/combobox/combobox.form-associated.ts"
+    "name": "WithFeedback",
+    "module": "src/shared/feedback/mixins.ts"
    }
   },
   {
    "kind": "field",
-   "name": "length",
+   "name": "errorText",
    "type": {
-    "text": "number"
+    "text": "string | undefined"
    },
-   "description": "The number of options.",
+   "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": "validity",
+   "type": {
+    "text": "ValidityState"
+   },
+   "description": "Returns the validity state of the element",
    "readonly": true,
    "inheritedFrom": {
-    "name": "Listbox",
-    "module": "libs/components/src/shared/foundation/listbox/listbox.ts"
+    "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"
    }
   },
   {
@@ -218,11 +413,79 @@ Code in this file were generated using following JSON:
    "type": {
     "text": "boolean"
    },
-   "description": "The disabled state of the listbox.",
+   "description": "Sets the element's disabled state. A disabled element will not be included during form submission.",
+   "privacy": "public",
+   "default": "false",
+   "inheritedFrom": {
+    "name": "Listbox",
+    "module": "src/shared/foundation/listbox/listbox.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": "length",
+   "type": {
+    "text": "number"
+   },
+   "description": "The number of options.",
    "privacy": "public",
+   "readonly": true,
    "inheritedFrom": {
     "name": "Listbox",
-    "module": "libs/components/src/shared/foundation/listbox/listbox.ts"
+    "module": "src/shared/foundation/listbox/listbox.ts"
    }
   },
   {
@@ -236,7 +499,7 @@ Code in this file were generated using following JSON:
    "privacy": "public",
    "inheritedFrom": {
     "name": "Listbox",
-    "module": "libs/components/src/shared/foundation/listbox/listbox.ts"
+    "module": "src/shared/foundation/listbox/listbox.ts"
    }
   },
   {
@@ -250,7 +513,7 @@ Code in this file were generated using following JSON:
    "privacy": "public",
    "inheritedFrom": {
     "name": "Listbox",
-    "module": "libs/components/src/shared/foundation/listbox/listbox.ts"
+    "module": "src/shared/foundation/listbox/listbox.ts"
    }
   },
   {
@@ -267,7 +530,7 @@ Code in this file were generated using following JSON:
    "privacy": "public",
    "inheritedFrom": {
     "name": "Listbox",
-    "module": "libs/components/src/shared/foundation/listbox/listbox.ts"
+    "module": "src/shared/foundation/listbox/listbox.ts"
    }
   },
   {
@@ -282,7 +545,7 @@ Code in this file were generated using following JSON:
    "privacy": "public",
    "inheritedFrom": {
     "name": "Listbox",
-    "module": "libs/components/src/shared/foundation/listbox/listbox.ts"
+    "module": "src/shared/foundation/listbox/listbox.ts"
    }
   },
   {
@@ -292,7 +555,34 @@ Code in this file were generated using following JSON:
    "description": "Sets an option as selected and gives it focus.",
    "inheritedFrom": {
     "name": "Listbox",
-    "module": "libs/components/src/shared/foundation/listbox/listbox.ts"
+    "module": "src/shared/foundation/listbox/listbox.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"
    }
   }
  ],
@@ -373,20 +663,157 @@ Code in this file were generated using following JSON:
    "fieldName": "placeholder"
   },
   {
+   "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"
    },
-   "description": "The disabled state of the listbox.",
+   "description": "Sets the element's disabled state. A disabled element will not be included during form submission.",
    "fieldName": "disabled",
+   "default": "false",
    "inheritedFrom": {
     "name": "Listbox",
-    "module": "libs/components/src/shared/foundation/listbox/listbox.ts"
+    "module": "src/shared/foundation/listbox/listbox.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": "FormAssociated",
+   "module": "/src/shared/foundation/form-associated/form-associated"
   }
  ],
  "superclass": {
-  "name": "FormAssociatedCombobox",
-  "module": "/libs/components/src/lib/combobox/combobox.form-associated"
+  "name": "Listbox",
+  "module": "/src/shared/foundation/listbox/listbox"
  },
  "vividComponent": {
   "public": true,
@@ -394,11 +821,11 @@ Code in this file were generated using following JSON:
   "vueModels": [
    {
     "name": "modelValue",
-    "attributeName": "value",
+    "propName": "value",
     "eventNames": [
      "change"
     ],
-    "valueMapping": "(event.target as HTMLInputElement).value"
+    "valueMapping": "event.currentTarget.value"
    }
   ]
  }
@@ -412,7 +839,7 @@ registerCombobox('vvd3')
 const VwcCombobox = wrapper(`vvd3-combobox`,  {
     events: [{"name":"change","propName":"onChange"}],
     attributes: [],
-    properties: ['autocomplete', 'filteredOptions', 'appearance', 'shape', 'scale', 'placement', 'fixedDropdown', '_popup', '_anchor', 'open', 'options', 'placeholder', 'value', 'proxy', 'disabled', 'selectedIndex', 'selectedOptions', 'slottedOptionFilter']
+    properties: ['autocomplete', 'filteredOptions', 'appearance', 'shape', 'scale', 'placement', 'fixedDropdown', '_popup', '_anchor', 'open', 'options', 'placeholder', 'helperText', 'errorText', 'successText', 'label', 'icon', 'value', 'currentValue', 'initialValue', 'disabled', 'name', 'required', 'selectedIndex', 'selectedOptions', 'slottedOptionFilter', 'VIVID_VERSION', 'componentName']
 })
 
 VwcCombobox.displayName = 'VwcCombobox'

package/v3/VwcCombobox/package.json

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