@vonage/vivid-react 3.4.1 → 3.5.0

package/v3/VwcOption/index.js

@@ -43,7 +43,7 @@ Code in this file were generated using following JSON:
  ],
  "slots": [
   {
-   "description": "Slot to add an icon to the option.",
+   "description": "The preferred way to add an icon to the component.",
    "name": "icon"
   }
  ],
@@ -57,34 +57,6 @@ Code in this file were generated using following JSON:
    "description": "The checked state is used when the parent listbox is in multiple selection mode.\nTo avoid accessibility conflicts, the checked state should not be present in\nsingle selection mode.",
    "privacy": "public"
   },
-  {
-   "kind": "method",
-   "name": "checkedChanged",
-   "privacy": "public",
-   "return": {
-    "type": {
-     "text": "void"
-    }
-   },
-   "parameters": [
-    {
-     "name": "_",
-     "type": {
-      "text": "boolean | unknown"
-     },
-     "description": "the previous checked value"
-    },
-    {
-     "name": "next",
-     "optional": true,
-     "type": {
-      "text": "boolean"
-     },
-     "description": "the current checked value"
-    }
-   ],
-   "description": "Updates the ariaChecked property when the checked property changes."
-  },
   {
    "kind": "field",
    "name": "defaultSelected",
@@ -233,15 +205,104 @@ Code in this file were generated using following JSON:
    },
    "readonly": true
   },
+  {
+   "kind": "field",
+   "name": "matchedText",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "Text to highlighted as matching a search query."
+  },
+  {
+   "kind": "field",
+   "name": "_hasMatchedText",
+   "readonly": true
+  },
+  {
+   "kind": "field",
+   "name": "tagConnotation",
+   "type": {
+    "text": "OptionTagConnotation | undefined"
+   },
+   "description": "When displayed as a tag, the connotation of the tag.",
+   "privacy": "public"
+  },
   {
    "kind": "field",
    "name": "proxy",
    "default": "new Option(\n\t\t\tthis.text,\n\t\t\t// @ts-expect-error Propery is used before it is assigned\n\t\t\tthis.initialValue,\n\t\t\tthis.defaultSelected,\n\t\t\tthis.selected\n\t\t)",
    "description": ""
+  },
+  {
+   "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": "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"
+   }
   }
  ],
  "attributes": [
   {
+   "name": "disabled",
    "type": {
     "text": "boolean"
    },
@@ -277,11 +338,62 @@ Code in this file were generated using following JSON:
     "text": "string | undefined"
    },
    "fieldName": "_text"
+  },
+  {
+   "name": "matched-text",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "Text to highlighted as matching a search query.",
+   "fieldName": "matchedText"
+  },
+  {
+   "name": "tag-connotation",
+   "type": {
+    "text": "OptionTagConnotation | undefined"
+   },
+   "description": "When displayed as a tag, the connotation of the tag.",
+   "fieldName": "tagConnotation"
+  },
+  {
+   "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"
+   }
+  }
+ ],
+ "mixins": [
+  {
+   "name": "HostSemantics",
+   "module": "/src/shared/aria/host-semantics"
+  },
+  {
+   "name": "AffixIconWithTrailing",
+   "module": "/src/shared/patterns/affix"
   }
  ],
  "superclass": {
   "name": "VividElement",
-  "module": "/libs/components/src/shared/foundation/vivid-element/vivid-element"
+  "module": "/src/shared/foundation/vivid-element/vivid-element"
  },
  "vividComponent": {
   "public": true,
@@ -297,7 +409,7 @@ registerOption('vvd3')
 const VwcOption = wrapper(`vvd3-option`,  {
     events: [],
     attributes: [],
-    properties: ['checked', 'defaultSelected', 'disabled', 'selectedAttribute', 'selected', 'dirtyValue', '_label', 'label', '_text', 'text', 'value', 'proxy']
+    properties: ['checked', 'defaultSelected', 'disabled', 'selectedAttribute', 'selected', 'dirtyValue', '_label', 'label', '_text', 'text', 'value', 'matchedText', 'tagConnotation', 'proxy', '_vividAriaBehaviour', 'iconTrailing', 'icon', 'VIVID_VERSION', 'componentName']
 })
 
 VwcOption.displayName = 'VwcOption'

package/v3/VwcOption/package.json

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

@@ -2,10 +2,14 @@ import React, { ReactNode } from 'react';
 /** VwcOptionTag
 * For more info on this Vivid element please visit https://vivid.deno.dev/components/option-tag
 * @param {OptionTagShape | undefined} shape  **attribute** `shape`
+* @param {OptionTagConnotation | undefined} connotation
 * @param {string | undefined} label  **attribute** `label`
 * @param {boolean} removable  **attribute** `removable`
 * @param {boolean} disabled  **attribute** `disabled`
 * @param {boolean} hasIconPlaceholder
+* @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 VwcOptionTag: {
     (props: {
@@ -15,10 +19,13 @@ declare const VwcOptionTag: {
         style?: React.CSSProperties | undefined;
         ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined;
         shape?: any;
+        connotation?: any;
         label?: string | undefined;
         removable?: boolean | undefined;
         disabled?: boolean | undefined;
         hasIconPlaceholder?: boolean | undefined;
+        VIVID_VERSION?: string | undefined;
+        componentName?: string | undefined;
     }): JSX.Element;
     displayName: string;
 };

package/v3/VwcOptionTag/index.js

@@ -8,6 +8,10 @@ Code in this file were generated using following JSON:
  "description": "",
  "name": "OptionTag",
  "cssProperties": [
+  {
+   "name": "--vvd-option-tag-cta-contrast",
+   "default": "var(--vvd-color-cta-800)"
+  },
   {
    "name": "--vvd-option-tag-accent-contrast",
    "default": "var(--vvd-color-neutral-800)"
@@ -21,6 +25,13 @@ Code in this file were generated using following JSON:
     "text": "OptionTagShape | undefined"
    }
   },
+  {
+   "kind": "field",
+   "name": "connotation",
+   "type": {
+    "text": "OptionTagConnotation | undefined"
+   }
+  },
   {
    "kind": "field",
    "name": "label",
@@ -55,6 +66,33 @@ Code in this file were generated using following JSON:
   {
    "kind": "method",
    "name": "_onClickRemove"
+  },
+  {
+   "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"
+   }
   }
  ],
  "attributes": [
@@ -73,6 +111,7 @@ Code in this file were generated using following JSON:
    "fieldName": "label"
   },
   {
+   "name": "removable",
    "type": {
     "text": "boolean"
    },
@@ -80,6 +119,7 @@ Code in this file were generated using following JSON:
    "fieldName": "removable"
   },
   {
+   "name": "disabled",
    "type": {
     "text": "boolean"
    },
@@ -87,9 +127,15 @@ Code in this file were generated using following JSON:
    "fieldName": "disabled"
   }
  ],
+ "mixins": [
+  {
+   "name": "Localized",
+   "module": "/src/shared/patterns"
+  }
+ ],
  "superclass": {
   "name": "VividElement",
-  "module": "/libs/components/src/shared/foundation/vivid-element/vivid-element"
+  "module": "/src/shared/foundation/vivid-element/vivid-element"
  }
 }
 */
@@ -101,7 +147,7 @@ registerOptionTag('vvd3')
 const VwcOptionTag = wrapper(`vvd3-option-tag`,  {
     events: [],
     attributes: [],
-    properties: ['shape', 'label', 'removable', 'disabled', 'hasIconPlaceholder']
+    properties: ['shape', 'connotation', 'label', 'removable', 'disabled', 'hasIconPlaceholder', 'VIVID_VERSION', 'componentName']
 })
 
 VwcOptionTag.displayName = 'VwcOptionTag'

package/v3/VwcOptionTag/package.json

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

@@ -9,6 +9,9 @@ import React, { ReactNode, SyntheticEvent } from 'react';
 * @param {boolean} navIcons  **attribute** `nav-icons`
 * @param {number} total  **attribute** `total`
 * @param {number | undefined} selectedIndex  **attribute** `selected-index`
+* @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 VwcPagination: {
     (props: {
@@ -26,6 +29,8 @@ declare const VwcPagination: {
         navIcons?: boolean | undefined;
         total?: number | undefined;
         selectedIndex?: any;
+        VIVID_VERSION?: string | undefined;
+        componentName?: string | undefined;
     }): JSX.Element;
     displayName: string;
 };

package/v3/VwcPagination/index.js

@@ -129,6 +129,43 @@ Code in this file were generated using following JSON:
      }
     }
    ]
+  },
+  {
+   "kind": "field",
+   "name": "#constrainedSelectedIndex",
+   "privacy": "private",
+   "readonly": true
+  },
+  {
+   "kind": "method",
+   "name": "#constrainSelectedIndex"
+  },
+  {
+   "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"
+   }
   }
  ],
  "events": [
@@ -166,6 +203,7 @@ Code in this file were generated using following JSON:
    "fieldName": "navIcons"
   },
   {
+   "name": "total",
    "type": {
     "text": "number"
    },
@@ -181,9 +219,15 @@ Code in this file were generated using following JSON:
    "fieldName": "selectedIndex"
   }
  ],
+ "mixins": [
+  {
+   "name": "Localized",
+   "module": "/src/shared/patterns"
+  }
+ ],
  "superclass": {
   "name": "VividElement",
-  "module": "/libs/components/src/shared/foundation/vivid-element/vivid-element"
+  "module": "/src/shared/foundation/vivid-element/vivid-element"
  },
  "vividComponent": {
   "public": true,
@@ -199,7 +243,7 @@ registerPagination('vvd3')
 const VwcPagination = wrapper(`vvd3-pagination`,  {
     events: [{"name":"pagination-change","propName":"onPaginationChange"}],
     attributes: [],
-    properties: ['size', 'shape', 'paginationButtons', 'prevButton', 'nextButton', 'navIcons', 'total', 'selectedIndex']
+    properties: ['size', 'shape', 'paginationButtons', 'prevButton', 'nextButton', 'navIcons', 'total', 'selectedIndex', 'VIVID_VERSION', 'componentName']
 })
 
 VwcPagination.displayName = 'VwcPagination'

package/v3/VwcPagination/package.json

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

@@ -0,0 +1,49 @@
+import React, { ReactNode } from 'react';
+/** Base class for picker fields. Picker fields consist of a text field with a button that opens a popup that allows
+picking values.
+* For more info on this Vivid element please visit https://vivid.deno.dev/components/picker-field
+* @param {boolean} readOnly - Whether the date-picker is readonly. **attribute** `readonly`
+* @param {string} value - The current value of the element. **attribute** `current-value`
+* @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  validate
+* @param {string | undefined} label - The label for the form element. **attribute** `label`
+* @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
+* @param {boolean} specialHandling
+* @param {VividAriaBehaviour} _vividAriaBehaviour
+*/
+declare const VwcPickerField: {
+    (props: {
+        children?: ReactNode;
+        slot?: string | undefined;
+        id?: string | undefined;
+        style?: React.CSSProperties | undefined;
+        ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined;
+        readOnly?: boolean | undefined;
+        value?: string | undefined;
+        helperText?: string | undefined;
+        errorText?: string | undefined;
+        validate?: any;
+        label?: string | undefined;
+        currentValue?: any;
+        initialValue?: string | undefined;
+        disabled?: boolean | undefined;
+        name?: string | undefined;
+        required?: boolean | undefined;
+        VIVID_VERSION?: string | undefined;
+        componentName?: string | undefined;
+        specialHandling?: boolean | undefined;
+        _vividAriaBehaviour?: any;
+    }): JSX.Element;
+    displayName: string;
+};
+export default VwcPickerField;