@vonage/vivid-react 3.4.1 → 3.5.1

package/v3/VwcAudioPlayer/index.js

@@ -98,7 +98,7 @@ Code in this file were generated using following JSON:
    "kind": "field",
    "name": "skipBy",
    "type": {
-    "text": "MediaSkipBy | undefined"
+    "text": "AudioPlayerMediaSkipBy | undefined"
    },
    "description": "Allows the audio to skip back or forward",
    "privacy": "public"
@@ -202,6 +202,33 @@ Code in this file were generated using following JSON:
    "kind": "field",
    "name": "#setPausedState",
    "privacy": "private"
+  },
+  {
+   "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": [
@@ -262,6 +289,7 @@ Code in this file were generated using following JSON:
    "fieldName": "src"
   },
   {
+   "name": "disabled",
    "type": {
     "text": "boolean"
    },
@@ -270,6 +298,7 @@ Code in this file were generated using following JSON:
    "fieldName": "disabled"
   },
   {
+   "name": "notime",
    "type": {
     "text": "boolean"
    },
@@ -279,7 +308,7 @@ Code in this file were generated using following JSON:
   {
    "name": "skip-by",
    "type": {
-    "text": "MediaSkipBy | undefined"
+    "text": "AudioPlayerMediaSkipBy | undefined"
    },
    "description": "Allows the audio to skip back or forward",
    "fieldName": "skipBy"
@@ -294,9 +323,15 @@ Code in this file were generated using following JSON:
    "fieldName": "playbackRates"
   }
  ],
+ "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,
@@ -312,7 +347,7 @@ registerAudioPlayer('vvd3')
 const VwcAudioPlayer = wrapper(`vvd3-audio-player`,  {
     events: [],
     attributes: [],
-    properties: ['playButtonAriaLabel', 'pauseButtonAriaLabel', 'sliderAriaLabel', 'skipForwardButtonAriaLabel', 'skipBackwardButtonAriaLabel', 'connotation', 'src', 'playbackRate', 'disabled', 'notime', 'skipBy', 'playbackRates', 'paused', 'duration', 'currentTime']
+    properties: ['playButtonAriaLabel', 'pauseButtonAriaLabel', 'sliderAriaLabel', 'skipForwardButtonAriaLabel', 'skipBackwardButtonAriaLabel', 'connotation', 'src', 'playbackRate', 'disabled', 'notime', 'skipBy', 'playbackRates', 'paused', 'duration', 'currentTime', 'VIVID_VERSION', 'componentName']
 })
 
 VwcAudioPlayer.displayName = 'VwcAudioPlayer'

package/v3/VwcAudioPlayer/package.json

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

@@ -5,8 +5,22 @@ import React, { ReactNode } from 'react';
 * @param {AvatarShape | undefined} shape - The shape the avatar should have. **attribute** `shape`
 * @param {AvatarAppearance | undefined} appearance - The appearance the avatar should have. **attribute** `appearance`
 * @param {AvatarSize | undefined} size - The size the avatar should have. **attribute** `size`
-* @param {string | undefined} icon - avatar header icon **attribute** `icon`
+* @param {string | undefined} icon  **attribute** `icon`
 * @param {string | undefined} initials - avatar name **attribute** `initials`
+* @param {boolean} clickable - Indicates whether avatar should be a clickable <button> element. **attribute** `clickable`
+* @param {string | undefined} download - Prompts the user to save the linked URL. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information. **attribute** `download`
+* @param {string | undefined} href - The URL the hyperlink references. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information. **attribute** `href`
+* @param {string | undefined} hreflang - Hints at the language of the referenced resource. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information. **attribute** `hreflang`
+* @param {string | undefined} ping - See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information. **attribute** `ping`
+* @param {string | undefined} referrerpolicy - See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information. **attribute** `referrerpolicy`
+* @param {string | undefined} rel - See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information. **attribute** `rel`
+* @param {'_self' | '_blank' | '_parent' | '_top' | undefined} target - See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information. **attribute** `target`
+* @param {string | undefined} type - See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information. **attribute** `type`
+* @param {HTMLAnchorElement} control - References the root element
+* @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 VwcAvatar: {
     (props: {
@@ -21,6 +35,19 @@ declare const VwcAvatar: {
         size?: any;
         icon?: string | undefined;
         initials?: string | undefined;
+        clickable?: boolean | undefined;
+        download?: string | undefined;
+        href?: string | undefined;
+        hreflang?: string | undefined;
+        ping?: string | undefined;
+        referrerpolicy?: string | undefined;
+        rel?: string | undefined;
+        target?: any;
+        type?: string | undefined;
+        control?: any;
+        _vividAriaBehaviour?: any;
+        VIVID_VERSION?: string | undefined;
+        componentName?: string | undefined;
     }): JSX.Element;
     displayName: string;
 };

package/v3/VwcAvatar/index.js

@@ -77,6 +77,10 @@ Code in this file were generated using following JSON:
   {
    "description": "Assign nodes to the graphic slot to set a graphic media of any kind (e.g. image, illustration etc).",
    "name": "graphic"
+  },
+  {
+   "description": "The preferred way to add an icon to the component.",
+   "name": "icon"
   }
  ],
  "members": [
@@ -122,8 +126,8 @@ Code in this file were generated using following JSON:
    "type": {
     "text": "string | undefined"
    },
-   "description": "avatar header icon",
-   "privacy": "public"
+   "privacy": "public",
+   "description": ""
   },
   {
    "kind": "field",
@@ -133,6 +137,171 @@ Code in this file were generated using following JSON:
    },
    "description": "avatar name",
    "privacy": "public"
+  },
+  {
+   "kind": "field",
+   "name": "clickable",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "Indicates whether avatar should be a clickable <button> element.",
+   "privacy": "public"
+  },
+  {
+   "kind": "field",
+   "name": "download",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "Prompts the user to save the linked URL. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "Linkable",
+    "module": "src/shared/patterns/linkable.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "href",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "The URL the hyperlink references. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "Linkable",
+    "module": "src/shared/patterns/linkable.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "hreflang",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "Hints at the language of the referenced resource. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "Linkable",
+    "module": "src/shared/patterns/linkable.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "ping",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "Linkable",
+    "module": "src/shared/patterns/linkable.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "referrerpolicy",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "Linkable",
+    "module": "src/shared/patterns/linkable.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "rel",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "Linkable",
+    "module": "src/shared/patterns/linkable.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "target",
+   "type": {
+    "text": "'_self' | '_blank' | '_parent' | '_top' | undefined"
+   },
+   "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "Linkable",
+    "module": "src/shared/patterns/linkable.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "type",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "Linkable",
+    "module": "src/shared/patterns/linkable.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "control",
+   "type": {
+    "text": "HTMLAnchorElement"
+   },
+   "description": "References the root element",
+   "inheritedFrom": {
+    "name": "Linkable",
+    "module": "src/shared/patterns/linkable.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "_vividAriaBehaviour",
+   "default": "'delegate'",
+   "type": {
+    "text": "'delegate'"
+   },
+   "inheritedFrom": {
+    "name": "DelegatesAria",
+    "module": "src/shared/aria/delegates-aria.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": [
@@ -173,7 +342,6 @@ Code in this file were generated using following JSON:
    "type": {
     "text": "string | undefined"
    },
-   "description": "avatar header icon",
    "fieldName": "icon"
   },
   {
@@ -183,11 +351,122 @@ Code in this file were generated using following JSON:
    },
    "description": "avatar name",
    "fieldName": "initials"
+  },
+  {
+   "name": "clickable",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "Indicates whether avatar should be a clickable <button> element.",
+   "fieldName": "clickable"
+  },
+  {
+   "name": "download",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "Prompts the user to save the linked URL. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information.",
+   "fieldName": "download",
+   "inheritedFrom": {
+    "name": "Linkable",
+    "module": "src/shared/patterns/linkable.ts"
+   }
+  },
+  {
+   "name": "href",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "The URL the hyperlink references. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information.",
+   "fieldName": "href",
+   "inheritedFrom": {
+    "name": "Linkable",
+    "module": "src/shared/patterns/linkable.ts"
+   }
+  },
+  {
+   "name": "hreflang",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "Hints at the language of the referenced resource. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information.",
+   "fieldName": "hreflang",
+   "inheritedFrom": {
+    "name": "Linkable",
+    "module": "src/shared/patterns/linkable.ts"
+   }
+  },
+  {
+   "name": "ping",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information.",
+   "fieldName": "ping",
+   "inheritedFrom": {
+    "name": "Linkable",
+    "module": "src/shared/patterns/linkable.ts"
+   }
+  },
+  {
+   "name": "referrerpolicy",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information.",
+   "fieldName": "referrerpolicy",
+   "inheritedFrom": {
+    "name": "Linkable",
+    "module": "src/shared/patterns/linkable.ts"
+   }
+  },
+  {
+   "name": "rel",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information.",
+   "fieldName": "rel",
+   "inheritedFrom": {
+    "name": "Linkable",
+    "module": "src/shared/patterns/linkable.ts"
+   }
+  },
+  {
+   "name": "target",
+   "type": {
+    "text": "'_self' | '_blank' | '_parent' | '_top' | undefined"
+   },
+   "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information.",
+   "fieldName": "target",
+   "inheritedFrom": {
+    "name": "Linkable",
+    "module": "src/shared/patterns/linkable.ts"
+   }
+  },
+  {
+   "name": "type",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information.",
+   "fieldName": "type",
+   "inheritedFrom": {
+    "name": "Linkable",
+    "module": "src/shared/patterns/linkable.ts"
+   }
+  }
+ ],
+ "mixins": [
+  {
+   "name": "Linkable",
+   "module": "/src/shared/patterns/linkable"
   }
  ],
  "superclass": {
   "name": "VividElement",
-  "module": "/libs/components/src/shared/foundation/vivid-element/vivid-element"
+  "module": "/src/shared/foundation/vivid-element/vivid-element"
  },
  "vividComponent": {
   "public": true,
@@ -203,7 +482,7 @@ registerAvatar('vvd3')
 const VwcAvatar = wrapper(`vvd3-avatar`,  {
     events: [],
     attributes: [],
-    properties: ['connotation', 'shape', 'appearance', 'size', 'icon', 'initials']
+    properties: ['connotation', 'shape', 'appearance', 'size', 'icon', 'initials', 'clickable', 'download', 'href', 'hreflang', 'ping', 'referrerpolicy', 'rel', 'target', 'type', 'control', '_vividAriaBehaviour', 'VIVID_VERSION', 'componentName']
 })
 
 VwcAvatar.displayName = 'VwcAvatar'

package/v3/VwcAvatar/package.json

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

@@ -3,8 +3,14 @@ import React, { ReactNode } from 'react';
 * For more info on this Vivid element please visit https://vivid.deno.dev/components/badge
 * @param {BadgeConnotation | undefined} connotation - The connotation the badge should have. **attribute** `connotation`
 * @param {BadgeShape | undefined} shape - The shape the badge should have. **attribute** `shape`
+* @param {BadgeSize | undefined} size - The size the badge should have. **attribute** `size`
 * @param {BadgeAppearance | undefined} appearance - The appearance the badge should have. **attribute** `appearance`
 * @param {string | undefined} text - Indicates the badge's text. **attribute** `text`
+* @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 VwcBadge: {
     (props: {
@@ -15,8 +21,13 @@ declare const VwcBadge: {
         ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined;
         connotation?: any;
         shape?: any;
+        size?: any;
         appearance?: any;
         text?: string | undefined;
+        iconTrailing?: boolean | undefined;
+        icon?: string | undefined;
+        VIVID_VERSION?: string | undefined;
+        componentName?: string | undefined;
     }): JSX.Element;
     displayName: string;
 };

package/v3/VwcBadge/index.js

@@ -291,7 +291,7 @@ Code in this file were generated using following JSON:
  ],
  "slots": [
   {
-   "description": "Add an icon to the component.",
+   "description": "The preferred way to add an icon to the component.",
    "name": "icon"
   }
  ],
@@ -314,6 +314,15 @@ Code in this file were generated using following JSON:
    "description": "The shape the badge should have.",
    "privacy": "public"
   },
+  {
+   "kind": "field",
+   "name": "size",
+   "type": {
+    "text": "BadgeSize | undefined"
+   },
+   "description": "The size the badge should have.",
+   "privacy": "public"
+  },
   {
    "kind": "field",
    "name": "appearance",
@@ -331,6 +340,60 @@ Code in this file were generated using following JSON:
    },
    "description": "Indicates the badge's text.",
    "privacy": "public"
+  },
+  {
+   "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": [
@@ -350,6 +413,14 @@ Code in this file were generated using following JSON:
    "description": "The shape the badge should have.",
    "fieldName": "shape"
   },
+  {
+   "name": "size",
+   "type": {
+    "text": "BadgeSize | undefined"
+   },
+   "description": "The size the badge should have.",
+   "fieldName": "size"
+  },
   {
    "name": "appearance",
    "type": {
@@ -365,11 +436,42 @@ Code in this file were generated using following JSON:
    },
    "description": "Indicates the badge's text.",
    "fieldName": "text"
+  },
+  {
+   "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,
@@ -385,7 +487,7 @@ registerBadge('vvd3')
 const VwcBadge = wrapper(`vvd3-badge`,  {
     events: [],
     attributes: [],
-    properties: ['connotation', 'shape', 'appearance', 'text']
+    properties: ['connotation', 'shape', 'size', 'appearance', 'text', 'iconTrailing', 'icon', 'VIVID_VERSION', 'componentName']
 })
 
 VwcBadge.displayName = 'VwcBadge'