@vonage/vivid-react 3.4.1 → 3.5.0

package/v3/VwcSelect/index.js

@@ -47,7 +47,7 @@ Code in this file were generated using following JSON:
    "name": ""
   },
   {
-   "description": "Slot to add an icon to the select control.",
+   "description": "The preferred way to add an icon to the select control.",
    "name": "icon"
   },
   {
@@ -76,7 +76,7 @@ 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"
    }
   },
   {
@@ -89,30 +89,6 @@ Code in this file were generated using following JSON:
    "description": "The open attribute.",
    "privacy": "public"
   },
-  {
-   "kind": "field",
-   "name": "value",
-   "description": "The value property.",
-   "privacy": "public"
-  },
-  {
-   "kind": "method",
-   "name": "multipleChanged",
-   "parameters": [
-    {
-     "name": "prev",
-     "type": {
-      "text": "boolean | undefined"
-     }
-    },
-    {
-     "name": "next",
-     "type": {
-      "text": "boolean"
-     }
-    }
-   ]
-  },
   {
    "kind": "field",
    "name": "scale",
@@ -159,10 +135,6 @@ Code in this file were generated using following JSON:
    "description": "The placeholder attribute.",
    "privacy": "public"
   },
-  {
-   "kind": "method",
-   "name": "labelChanged"
-  },
   {
    "kind": "field",
    "name": "displayValue",
@@ -204,50 +176,349 @@ 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": "FormAssociatedSelect",
-    "module": "libs/components/src/lib/select/select.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": "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": "_vividAriaBehaviour",
+   "default": "'host'",
+   "type": {
+    "text": "'host'"
+   },
+   "inheritedFrom": {
+    "name": "HostSemantics",
+    "module": "src/shared/aria/host-semantics.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "iconTrailing",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "Indicates the icon affix alignment.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "AffixIconWithTrailing",
+    "module": "src/shared/patterns/affix.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": "options",
+   "name": "form",
    "type": {
-    "text": "ListboxOption[]"
+    "text": "HTMLFormElement | null"
    },
-   "description": "The list of options.",
+   "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"
+   },
+   "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": "libs/components/src/shared/foundation/listbox/listbox.ts"
+    "module": "src/shared/foundation/listbox/listbox.ts"
    }
   },
   {
    "kind": "field",
-   "name": "disabled",
+   "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": "The disabled state of the listbox.",
+   "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": "src/shared/foundation/listbox/listbox.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "options",
+   "type": {
+    "text": "ListboxOption[]"
+   },
+   "description": "The list of options.",
    "privacy": "public",
    "inheritedFrom": {
     "name": "Listbox",
-    "module": "libs/components/src/shared/foundation/listbox/listbox.ts"
+    "module": "src/shared/foundation/listbox/listbox.ts"
    }
   },
   {
@@ -261,7 +532,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"
    }
   },
   {
@@ -275,7 +546,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 +563,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"
    }
   },
   {
@@ -307,7 +578,34 @@ 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"
+   }
+  },
+  {
+   "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"
    }
   }
  ],
@@ -329,15 +627,12 @@ Code in this file were generated using following JSON:
  ],
  "attributes": [
   {
+   "name": "multiple",
    "type": {
     "text": "boolean"
    },
    "description": "Indicates if the listbox is in multi-selection mode.",
-   "fieldName": "multiple",
-   "inheritedFrom": {
-    "name": "Listbox",
-    "module": "libs/components/src/shared/foundation/listbox/listbox.ts"
-   }
+   "fieldName": "multiple"
   },
   {
    "name": "open",
@@ -388,11 +683,176 @@ Code in this file were generated using following JSON:
    },
    "description": "The placeholder attribute.",
    "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-trailing",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "Indicates the icon affix alignment.",
+   "fieldName": "iconTrailing",
+   "inheritedFrom": {
+    "name": "AffixIconWithTrailing",
+    "module": "src/shared/patterns/affix.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": "Sets the element's disabled state. A disabled element will not be included during form submission.",
+   "fieldName": "disabled",
+   "default": "false",
+   "inheritedFrom": {
+    "name": "Listbox",
+    "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": "WithLightDOMFeedback",
+   "module": "/src/shared/feedback/mixins"
+  },
+  {
+   "name": "WithErrorText",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "WithSuccessText",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "FormElement",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "HostSemantics",
+   "module": "/src/shared/aria/host-semantics"
+  },
+  {
+   "name": "AffixIconWithTrailing",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "FormAssociated",
+   "module": "/src/shared/foundation/form-associated/form-associated"
   }
  ],
  "superclass": {
-  "name": "FormAssociatedSelect",
-  "module": "/libs/components/src/lib/select/select.form-associated"
+  "name": "Listbox",
+  "module": "/src/shared/foundation/listbox/listbox"
  },
  "vividComponent": {
   "public": true,
@@ -400,11 +860,11 @@ Code in this file were generated using following JSON:
   "vueModels": [
    {
     "name": "modelValue",
-    "attributeName": "value",
+    "propName": "value",
     "eventNames": [
      "input"
     ],
-    "valueMapping": "(event.target as HTMLInputElement).value"
+    "valueMapping": "event.currentTarget.value"
    }
   ]
  }
@@ -418,7 +878,7 @@ registerSelect('vvd3')
 const VwcSelect = wrapper(`vvd3-select`,  {
     events: [{"name":"change","propName":"onChange"},{"name":"input","propName":"onInput"}],
     attributes: [],
-    properties: ['multiple', 'open', 'value', 'scale', 'appearance', 'shape', 'fixedDropdown', 'placeholder', 'proxy', 'options', 'disabled', 'selectedIndex', 'selectedOptions', 'slottedOptionFilter', 'disabled', 'errorText', 'helperText', 'icon', 'iconTrailing', 'initialValue', 'label', 'name', 'required', 'successText', 'value']
+    properties: ['multiple', 'open', 'scale', 'appearance', 'shape', 'fixedDropdown', 'placeholder', 'helperText', 'errorText', 'validate', 'successText', 'label', '_vividAriaBehaviour', 'iconTrailing', 'icon', 'value', 'currentValue', 'initialValue', 'disabled', 'name', 'required', 'options', 'selectedIndex', 'selectedOptions', 'slottedOptionFilter', 'VIVID_VERSION', 'componentName', 'disabled', 'errorText', 'helperText', 'icon', 'iconTrailing', 'initialValue', 'label', 'name', 'required', 'successText', 'value']
 })
 
 VwcSelect.displayName = 'VwcSelect'