@vonage/vivid-react 3.4.1 → 3.5.1

package/v3/VwcSwitch/index.d.ts

@@ -1,18 +1,30 @@
 import React, { ReactNode, SyntheticEvent } from 'react';
 /** VwcSwitch
 * For more info on this Vivid element please visit https://vivid.deno.dev/components/switch
-* @param {string | null} ariaLabel  **attribute** `aria-label`
+* @param {boolean} checked  **attribute** `current-checked`
+* @param {boolean} readonly
+* @param {boolean} disabled  **attribute** `disabled`
+* @param {string | undefined} value  **attribute** `current-value`
+* @param {string | undefined} name  **attribute** `name`
 * @param {string | undefined} label - Indicates the switch's label. **attribute** `label`
 * @param {SwitchConnotation | undefined} connotation - Indicates the switch's connotation. **attribute** `connotation`
 * @param {boolean} readOnly - 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. **attribute** `readonly`
-* @param {boolean} defaultChecked
-* @param  checked
-* @param  proxy
-* @param {boolean} checked
-* @param {boolean} readonly
-* @param {boolean} disabled
-* @param {string | undefined} value
-* @param {string | undefined} name
+* @param {boolean} checked - The current checkedness of the element. **attribute** `current-checked`
+* @param {'delegate'} _vividAriaBehaviour
+* @param {boolean} defaultChecked - The default checkedness of the element. This value sets the `checked` property
+only when the `checked` property has not been explicitly set. **attribute** `checked`
+* @param  checkedAttribute
+* @param  currentChecked
+* @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 {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 VwcSwitch: {
     (props: {
@@ -23,17 +35,23 @@ declare const VwcSwitch: {
         ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined;
         onChange?: ((event: SyntheticEvent) => void) | undefined;
         onClick?: ((event: SyntheticEvent) => void) | undefined;
-        ariaLabel?: string | null | undefined;
-        label?: string | undefined;
-        connotation?: any;
-        readOnly?: boolean | undefined;
-        defaultChecked?: boolean | undefined;
-        checked?: any;
-        proxy?: any;
+        checked?: boolean | undefined;
         readonly?: boolean | undefined;
         disabled?: boolean | undefined;
         value?: string | undefined;
         name?: string | undefined;
+        label?: string | undefined;
+        connotation?: any;
+        readOnly?: boolean | undefined;
+        _vividAriaBehaviour?: any;
+        defaultChecked?: boolean | undefined;
+        checkedAttribute?: any;
+        currentChecked?: any;
+        currentValue?: any;
+        initialValue?: string | undefined;
+        required?: boolean | undefined;
+        VIVID_VERSION?: string | undefined;
+        componentName?: string | undefined;
     }): JSX.Element;
     displayName: string;
 };

package/v3/VwcSwitch/index.js

@@ -130,14 +130,6 @@ Code in this file were generated using following JSON:
   }
  ],
  "members": [
-  {
-   "kind": "field",
-   "name": "ariaLabel",
-   "type": {
-    "text": "string | null"
-   },
-   "default": "null"
-  },
   {
    "kind": "field",
    "name": "label",
@@ -166,13 +158,28 @@ Code in this file were generated using following JSON:
    "privacy": "public"
   },
   {
-   "kind": "method",
-   "name": "updateForm",
-   "privacy": "private",
-   "return": {
-    "type": {
-     "text": "void"
-    }
+   "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": "_vividAriaBehaviour",
+   "default": "'delegate'",
+   "type": {
+    "text": "'delegate'"
+   },
+   "inheritedFrom": {
+    "name": "DelegatesAria",
+    "module": "src/shared/aria/delegates-aria.ts"
    }
   },
   {
@@ -181,18 +188,218 @@ Code in this file were generated using following JSON:
    "type": {
     "text": "boolean"
    },
-   "default": "!!this.checkedAttribute"
+   "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": "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": "checked"
+   "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": "FormAssociatedSwitch",
-    "module": "libs/components/src/lib/switch/switch.form-associated.ts"
+    "name": "VividElement",
+    "module": "src/shared/foundation/vivid-element/vivid-element.ts"
    }
   }
  ],
@@ -206,14 +413,6 @@ Code in this file were generated using following JSON:
   }
  ],
  "attributes": [
-  {
-   "name": "aria-label",
-   "type": {
-    "text": "string | null"
-   },
-   "default": "null",
-   "fieldName": "ariaLabel"
-  },
   {
    "name": "label",
    "type": {
@@ -237,11 +436,108 @@ Code in this file were generated using following JSON:
    },
    "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": "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": "CheckableFormAssociated",
+   "module": "/src/shared/foundation/form-associated/form-associated"
   }
  ],
  "superclass": {
-  "name": "FormAssociatedSwitch",
-  "module": "/libs/components/src/lib/switch/switch.form-associated"
+  "name": "VividElement",
+  "module": "/src/shared/foundation/vivid-element/vivid-element"
  },
  "vividComponent": {
   "public": true,
@@ -249,11 +545,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"
    }
   ]
  }
@@ -267,7 +563,7 @@ registerSwitch('vvd3')
 const VwcSwitch = wrapper(`vvd3-switch`,  {
     events: [{"name":"change","propName":"onChange"},{"name":"click","propName":"onClick"}],
     attributes: [],
-    properties: ['ariaLabel', 'label', 'connotation', 'readOnly', 'defaultChecked', 'checked', 'proxy', 'checked', 'readonly', 'disabled', 'value', 'name']
+    properties: ['checked', 'readonly', 'disabled', 'value', 'name', 'label', 'connotation', 'readOnly', 'checked', '_vividAriaBehaviour', 'defaultChecked', 'checkedAttribute', 'currentChecked', 'value', 'currentValue', 'initialValue', 'disabled', 'name', 'required', 'VIVID_VERSION', 'componentName']
 })
 
 VwcSwitch.displayName = 'VwcSwitch'

package/v3/VwcSwitch/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@vonage/vivid-react-vvd3-switch",
-  "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/VwcTab/index.d.ts

@@ -5,9 +5,14 @@ import React, { ReactNode, SyntheticEvent } from 'react';
 * @param {TabConnotation | undefined} connotation - The connotation the tab should have. **attribute** `connotation`
 * @param {TabShape | undefined} shape - The shape the tab should have. **attribute** `shape`
 * @param {string | undefined} label - Indicates the tab's label. **attribute** `label`
-* @param {boolean} removable - Indicates the tab's label. **attribute** `removable`
+* @param {boolean} removable - Adds a close button **attribute** `removable`
 * @param {number} tabIndex  **attribute** `tabIndex`
-* @param {string | null} ariaSelected  **attribute** `aria-selected`
+* @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 VwcTab: {
     (props: {
@@ -23,7 +28,11 @@ declare const VwcTab: {
         label?: string | undefined;
         removable?: boolean | undefined;
         tabIndex?: number | undefined;
-        ariaSelected?: string | null | undefined;
+        _vividAriaBehaviour?: any;
+        iconTrailing?: boolean | undefined;
+        icon?: string | undefined;
+        VIVID_VERSION?: string | undefined;
+        componentName?: string | undefined;
     }): JSX.Element;
     displayName: string;
 };