@vonage/vivid-react 3.4.0 → 3.5.0

package/v3/VwcAccordion/index.d.ts

@@ -6,6 +6,9 @@ single or multiple item expansion. **attribute** `expand-mode`
 * @param {string | null} activeid
 * @param {number} activeItemIndex
 * @param {Array<string | null>} accordionIds
+* @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 VwcAccordion: {
     (props: {
@@ -19,6 +22,8 @@ declare const VwcAccordion: {
         activeid?: string | null | undefined;
         activeItemIndex?: number | undefined;
         accordionIds?: any;
+        VIVID_VERSION?: string | undefined;
+        componentName?: string | undefined;
     }): JSX.Element;
     displayName: string;
 };

package/v3/VwcAccordion/index.js

@@ -160,6 +160,33 @@ Code in this file were generated using following JSON:
      "text": "void"
     }
    }
+  },
+  {
+   "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": [
@@ -183,7 +210,7 @@ Code in this file were generated using following JSON:
  ],
  "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 +226,7 @@ registerAccordion('vvd3')
 const VwcAccordion = wrapper(`vvd3-accordion`,  {
     events: [{"name":"change","propName":"onChange"}],
     attributes: [],
-    properties: ['expandmode', 'activeid', 'activeItemIndex', 'accordionIds']
+    properties: ['expandmode', 'activeid', 'activeItemIndex', 'accordionIds', 'VIVID_VERSION', 'componentName']
 })
 
 VwcAccordion.displayName = 'VwcAccordion'

package/v3/VwcAccordion/package.json

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

@@ -9,6 +9,11 @@ heading element. **attribute** `heading-level`
 * @param {boolean} noIndicator - Indicates whether the accordion-item has indicator **attribute** `no-indicator`
 * @param {string | undefined} meta  **attribute** `meta`
 * @param {AccordionItemSize | undefined} size - The size the accordion-item should have. **attribute** `size`
+* @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 VwcAccordionItem: {
     (props: {
@@ -24,6 +29,10 @@ declare const VwcAccordionItem: {
         noIndicator?: boolean | undefined;
         meta?: string | undefined;
         size?: any;
+        iconTrailing?: boolean | undefined;
+        icon?: string | undefined;
+        VIVID_VERSION?: string | undefined;
+        componentName?: string | undefined;
     }): JSX.Element;
     displayName: string;
 };

package/v3/VwcAccordionItem/index.js

@@ -27,8 +27,16 @@ Code in this file were generated using following JSON:
    "name": ""
   },
   {
-   "description": "Add an icon to the component.",
+   "description": "The preferred way to add an icon to the component.",
    "name": "icon"
+  },
+  {
+   "description": "Used to add additional content to the heading.",
+   "name": "meta"
+  },
+  {
+   "description": "Used to add content to the heading.",
+   "name": "heading"
   }
  ],
  "members": [
@@ -102,6 +110,60 @@ Code in this file were generated using following JSON:
    "kind": "field",
    "name": "change",
    "privacy": "private"
+  },
+  {
+   "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"
+   }
   }
  ],
  "events": [
@@ -124,6 +186,7 @@ Code in this file were generated using following JSON:
    "fieldName": "headinglevel"
   },
   {
+   "name": "expanded",
    "type": {
     "text": "boolean"
    },
@@ -169,11 +232,42 @@ Code in this file were generated using following JSON:
    },
    "description": "The size the accordion-item should have.",
    "fieldName": "size"
+  },
+  {
+   "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": "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,
@@ -189,7 +283,7 @@ registerAccordionItem('vvd3')
 const VwcAccordionItem = wrapper(`vvd3-accordion-item`,  {
     events: [{"name":"change","propName":"onChange"}],
     attributes: [],
-    properties: ['headinglevel', 'expanded', 'id', 'heading', 'noIndicator', 'meta', 'size']
+    properties: ['headinglevel', 'expanded', 'id', 'heading', 'noIndicator', 'meta', 'size', 'iconTrailing', 'icon', 'VIVID_VERSION', 'componentName']
 })
 
 VwcAccordionItem.displayName = 'VwcAccordionItem'

package/v3/VwcAccordionItem/package.json

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

@@ -4,8 +4,10 @@ import React, { ReactNode } from 'react';
 * @param {ActionGroupShape | undefined} shape - The shape the ActionGroup should have. **attribute** `shape`
 * @param {ActionGroupAppearance | undefined} appearance - The appearance the ActionGroup should have. **attribute** `appearance`
 * @param {boolean} tight - Indicates whether action group should have padding. **attribute** `tight`
-* @param {string | null} role  **attribute** `role`
-* @param {string | null} ariaLabel  **attribute** `aria-label`
+* @param {'delegate'} _vividAriaBehaviour
+* @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 VwcActionGroup: {
     (props: {
@@ -17,8 +19,9 @@ declare const VwcActionGroup: {
         shape?: any;
         appearance?: any;
         tight?: boolean | undefined;
-        role?: string | null | undefined;
-        ariaLabel?: string | null | undefined;
+        _vividAriaBehaviour?: any;
+        VIVID_VERSION?: string | undefined;
+        componentName?: string | undefined;
     }): JSX.Element;
     displayName: string;
 };

package/v3/VwcActionGroup/index.js

@@ -58,19 +58,42 @@ Code in this file were generated using following JSON:
   },
   {
    "kind": "field",
-   "name": "role",
+   "name": "_vividAriaBehaviour",
+   "default": "'delegate'",
    "type": {
-    "text": "string | null"
+    "text": "'delegate'"
    },
-   "default": "null"
+   "inheritedFrom": {
+    "name": "DelegatesAria",
+    "module": "src/shared/aria/delegates-aria.ts"
+   }
   },
   {
    "kind": "field",
-   "name": "ariaLabel",
+   "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 | null"
+    "text": "string"
    },
-   "default": "null"
+   "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": [
@@ -91,33 +114,24 @@ Code in this file were generated using following JSON:
    "fieldName": "appearance"
   },
   {
+   "name": "tight",
    "type": {
     "text": "boolean"
    },
    "default": "false",
    "description": "Indicates whether action group should have padding.",
    "fieldName": "tight"
-  },
-  {
-   "name": "role",
-   "type": {
-    "text": "string | null"
-   },
-   "default": "null",
-   "fieldName": "role"
-  },
+  }
+ ],
+ "mixins": [
   {
-   "name": "aria-label",
-   "type": {
-    "text": "string | null"
-   },
-   "default": "null",
-   "fieldName": "ariaLabel"
+   "name": "DelegatesAria",
+   "module": "/src/shared/aria/delegates-aria"
   }
  ],
  "superclass": {
   "name": "VividElement",
-  "module": "/libs/components/src/shared/foundation/vivid-element/vivid-element"
+  "module": "/src/shared/foundation/vivid-element/vivid-element"
  },
  "vividComponent": {
   "public": true,
@@ -133,7 +147,7 @@ registerActionGroup('vvd3')
 const VwcActionGroup = wrapper(`vvd3-action-group`,  {
     events: [],
     attributes: [],
-    properties: ['shape', 'appearance', 'tight', 'role', 'ariaLabel']
+    properties: ['shape', 'appearance', 'tight', '_vividAriaBehaviour', 'VIVID_VERSION', 'componentName']
 })
 
 VwcActionGroup.displayName = 'VwcActionGroup'

package/v3/VwcActionGroup/package.json

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

@@ -7,11 +7,14 @@ import React, { ReactNode, SyntheticEvent } from 'react';
 * @param {AlertPlacement | undefined} placement - The placement of the Alert on the screen. **attribute** `placement`
 * @param {string | undefined} headline - Adds a headline to the Alert. **attribute** `headline`
 * @param {string | undefined} text - The main text of the Alert. **attribute** `text`
-* @param {string | undefined} icon - The icon to display in the Alert. Takes precedence over the connotation's icon. **attribute** `icon`
 * @param {number} timeoutms - Timeout after which the Alert will close. **attribute** `timeoutms`
 * @param {AlertConnotation | undefined} connotation - Sets an appropriate icon / icon color for the connotation. **attribute** `connotation`
 * @param {AlertStrategy | undefined} strategy - Controls the `position` of the Alert. **attribute** `strategy`
 * @param {boolean} open - Open state of the Alert. **attribute** `open`
+* @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 VwcAlert: {
     (props: {
@@ -27,11 +30,13 @@ declare const VwcAlert: {
         placement?: any;
         headline?: string | undefined;
         text?: string | undefined;
-        icon?: string | undefined;
         timeoutms?: number | undefined;
         connotation?: any;
         strategy?: any;
         open?: boolean | undefined;
+        icon?: string | undefined;
+        VIVID_VERSION?: string | undefined;
+        componentName?: string | undefined;
     }): JSX.Element;
     displayName: string;
 };

package/v3/VwcAlert/index.js

@@ -67,7 +67,7 @@ Code in this file were generated using following JSON:
    "name": "action-items"
   },
   {
-   "description": "Add an icon to the component.",
+   "description": "The preferred way to add an icon to the component.",
    "name": "icon"
   }
  ],
@@ -128,15 +128,6 @@ Code in this file were generated using following JSON:
    "description": "The main text of the Alert.",
    "privacy": "public"
   },
-  {
-   "kind": "field",
-   "name": "icon",
-   "type": {
-    "text": "string | undefined"
-   },
-   "description": "The icon to display in the Alert. Takes precedence over the connotation's icon.",
-   "privacy": "public"
-  },
   {
    "kind": "field",
    "name": "timeoutms",
@@ -216,6 +207,46 @@ Code in this file were generated using following JSON:
    "kind": "field",
    "name": "#onTransitionEnd",
    "privacy": "private"
+  },
+  {
+   "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"
+   }
   }
  ],
  "events": [
@@ -245,6 +276,7 @@ Code in this file were generated using following JSON:
    "fieldName": "dismissButtonAriaLabel"
   },
   {
+   "name": "removable",
    "type": {
     "text": "boolean"
    },
@@ -253,6 +285,7 @@ Code in this file were generated using following JSON:
    "fieldName": "removable"
   },
   {
+   "name": "placement",
    "type": {
     "text": "AlertPlacement | undefined"
    },
@@ -277,14 +310,7 @@ Code in this file were generated using following JSON:
    "fieldName": "text"
   },
   {
-   "name": "icon",
-   "type": {
-    "text": "string | undefined"
-   },
-   "description": "The icon to display in the Alert. Takes precedence over the connotation's icon.",
-   "fieldName": "icon"
-  },
-  {
+   "name": "timeoutms",
    "type": {
     "text": "number"
    },
@@ -309,17 +335,40 @@ Code in this file were generated using following JSON:
    "fieldName": "strategy"
   },
   {
+   "name": "open",
    "type": {
     "text": "boolean"
    },
    "default": "false",
    "description": "Open state of the Alert.",
    "fieldName": "open"
+  },
+  {
+   "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": "AffixIcon",
+   "module": "/src/shared/patterns/affix"
+  },
+  {
+   "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,
@@ -335,7 +384,7 @@ registerAlert('vvd3')
 const VwcAlert = wrapper(`vvd3-alert`,  {
     events: [{"name":"close","propName":"onClose"},{"name":"open","propName":"onOpen"}],
     attributes: [],
-    properties: ['dismissButtonAriaLabel', 'removable', 'placement', 'headline', 'text', 'icon', 'timeoutms', 'connotation', 'strategy', 'open']
+    properties: ['dismissButtonAriaLabel', 'removable', 'placement', 'headline', 'text', 'timeoutms', 'connotation', 'strategy', 'open', 'icon', 'VIVID_VERSION', 'componentName']
 })
 
 VwcAlert.displayName = 'VwcAlert'

package/v3/VwcAlert/package.json

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

@@ -15,11 +15,14 @@ import React, { ReactNode } from 'react';
 * @param  playbackRate
 * @param {boolean} disabled - Indicates whether audio player is disabled. **attribute** `disabled`
 * @param {boolean} notime  **attribute** `notime`
-* @param {MediaSkipBy | undefined} skipBy - Allows the audio to skip back or forward **attribute** `skip-by`
+* @param {AudioPlayerMediaSkipBy | undefined} skipBy - Allows the audio to skip back or forward **attribute** `skip-by`
 * @param {string | null} playbackRates - Sets the available playback rates. When an empty string, no choices will be available **attribute** `playback-rates`
 * @param {boolean} paused
 * @param  duration
 * @param  currentTime
+* @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 VwcAudioPlayer: {
     (props: {
@@ -43,6 +46,8 @@ declare const VwcAudioPlayer: {
         paused?: boolean | undefined;
         duration?: any;
         currentTime?: any;
+        VIVID_VERSION?: string | undefined;
+        componentName?: string | undefined;
     }): JSX.Element;
     displayName: string;
 };