@vonage/vivid-react 3.4.1 → 3.5.0

package/v3/VwcNavItem/index.js

@@ -87,101 +87,378 @@ Code in this file were generated using following JSON:
    "name": "meta"
   },
   {
-   "description": "Add an icon to the component.",
+   "description": "The preferred way to add an icon to the component.",
    "name": "icon"
   }
  ],
  "members": [
   {
-   "kind": "method",
-   "name": "getBodyTemplate"
+   "kind": "field",
+   "name": "text",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "Text of the nav item",
+   "privacy": "public"
   },
   {
    "kind": "field",
-   "name": "text",
+   "name": "connotation",
+   "type": {
+    "text": "NavItemConnotation | undefined"
+   },
+   "description": "Sets the connotation color of the selected nav item",
+   "privacy": "public"
+  },
+  {
+   "kind": "field",
+   "name": "appearance",
+   "type": {
+    "text": "NavItemAppearance | undefined"
+   },
+   "description": "Sets the nav item's appearance",
+   "privacy": "public"
+  },
+  {
+   "kind": "field",
+   "name": "current",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "Sets the nav item as a current",
+   "privacy": "public"
+  },
+  {
+   "kind": "field",
+   "name": "icon",
    "type": {
     "text": "string | undefined"
    },
-   "description": "Indicates the text anchor's text.",
+   "description": "A decorative icon the custom element should have.",
    "privacy": "public",
    "inheritedFrom": {
-    "name": "TextAnchor",
-    "module": "libs/components/src/lib/text-anchor/text-anchor.ts"
+    "name": "AffixIcon",
+    "module": "src/shared/patterns/affix.ts"
    }
   },
   {
    "kind": "field",
-   "name": "connotation",
+   "name": "download",
    "type": {
-    "text": "TextAnchorConnotation | undefined"
+    "text": "string | undefined"
    },
-   "description": "The connotation Text-Anchor should have.",
+   "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": "TextAnchor",
-    "module": "libs/components/src/lib/text-anchor/text-anchor.ts"
+    "name": "Linkable",
+    "module": "src/shared/patterns/linkable.ts"
    }
   },
   {
    "kind": "field",
-   "name": "appearance",
+   "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": "TextAnchorAppearance | undefined"
+    "text": "string | undefined"
    },
-   "description": "The appearance Text-Anchor should have.",
+   "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information.",
    "privacy": "public",
    "inheritedFrom": {
-    "name": "TextAnchor",
-    "module": "libs/components/src/lib/text-anchor/text-anchor.ts"
+    "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"
    }
   }
  ],
- "superclass": {
-  "name": "TextAnchor",
-  "module": "/libs/components/src/lib/text-anchor/text-anchor"
- },
- "vividComponent": {
-  "public": true,
-  "name": "nav-item"
- },
  "attributes": [
   {
    "name": "text",
    "type": {
     "text": "string | undefined"
    },
-   "description": "Indicates the text anchor's text.",
-   "fieldName": "text",
+   "description": "Text of the nav item",
+   "fieldName": "text"
+  },
+  {
+   "name": "connotation",
+   "type": {
+    "text": "NavItemConnotation | undefined"
+   },
+   "description": "Sets the connotation color of the selected nav item",
+   "fieldName": "connotation"
+  },
+  {
+   "name": "appearance",
+   "type": {
+    "text": "NavItemAppearance | undefined"
+   },
+   "description": "Sets the nav item's appearance",
+   "fieldName": "appearance"
+  },
+  {
+   "name": "current",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "Sets the nav item as a current",
+   "fieldName": "current"
+  },
+  {
+   "name": "icon",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "A decorative icon the custom element should have.",
+   "fieldName": "icon",
    "inheritedFrom": {
-    "name": "TextAnchor",
-    "module": "libs/components/src/lib/text-anchor/text-anchor.ts"
+    "name": "AffixIcon",
+    "module": "src/shared/patterns/affix.ts"
    }
   },
   {
-   "name": "connotation",
+   "name": "download",
    "type": {
-    "text": "TextAnchorConnotation | undefined"
+    "text": "string | undefined"
    },
-   "description": "The connotation Text-Anchor should have.",
-   "fieldName": "connotation",
+   "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": "TextAnchor",
-    "module": "libs/components/src/lib/text-anchor/text-anchor.ts"
+    "name": "Linkable",
+    "module": "src/shared/patterns/linkable.ts"
    }
   },
   {
-   "name": "appearance",
+   "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": "TextAnchorAppearance | undefined"
+    "text": "string | undefined"
    },
-   "description": "The appearance Text-Anchor should have.",
-   "fieldName": "appearance",
+   "description": "See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element  for more information.",
+   "fieldName": "rel",
    "inheritedFrom": {
-    "name": "TextAnchor",
-    "module": "libs/components/src/lib/text-anchor/text-anchor.ts"
+    "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": "AffixIcon",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "Linkable",
+   "module": "/src/shared/patterns"
+  }
+ ],
+ "superclass": {
+  "name": "VividElement",
+  "module": "/src/shared/foundation/vivid-element/vivid-element"
+ },
+ "vividComponent": {
+  "public": true,
+  "name": "nav-item"
+ }
 }
 */
 import wrapper from '@vonage/vivid-react-wrapper'
@@ -192,7 +469,7 @@ registerNavItem('vvd3')
 const VwcNavItem = wrapper(`vvd3-nav-item`,  {
     events: [],
     attributes: [],
-    properties: ['text', 'connotation', 'appearance']
+    properties: ['text', 'connotation', 'appearance', 'current', 'icon', 'download', 'href', 'hreflang', 'ping', 'referrerpolicy', 'rel', 'target', 'type', 'control', '_vividAriaBehaviour', 'VIVID_VERSION', 'componentName']
 })
 
 VwcNavItem.displayName = 'VwcNavItem'

package/v3/VwcNavItem/package.json

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

@@ -3,6 +3,10 @@ import React, { ReactNode } from 'react';
 * For more info on this Vivid element please visit https://vivid.deno.dev/components/note
 * @param {string | undefined} headline - Indicates the note's headline text **attribute** `headline`
 * @param {NoteConnotation | undefined} connotation  **attribute** `connotation`
+* @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 VwcNote: {
     (props: {
@@ -13,6 +17,9 @@ declare const VwcNote: {
         ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined;
         headline?: string | undefined;
         connotation?: any;
+        icon?: string | undefined;
+        VIVID_VERSION?: string | undefined;
+        componentName?: string | undefined;
     }): JSX.Element;
     displayName: string;
 };

package/v3/VwcNote/index.js

@@ -87,7 +87,7 @@ 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"
   }
  ],
@@ -107,6 +107,46 @@ Code in this file were generated using following JSON:
    "type": {
     "text": "NoteConnotation | undefined"
    }
+  },
+  {
+   "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": [
@@ -124,11 +164,29 @@ Code in this file were generated using following JSON:
     "text": "NoteConnotation | undefined"
    },
    "fieldName": "connotation"
+  },
+  {
+   "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"
   }
  ],
  "superclass": {
   "name": "VividElement",
-  "module": "/libs/components/src/shared/foundation/vivid-element/vivid-element"
+  "module": "/src/shared/foundation/vivid-element/vivid-element"
  },
  "vividComponent": {
   "public": true,
@@ -144,7 +202,7 @@ registerNote('vvd3')
 const VwcNote = wrapper(`vvd3-note`,  {
     events: [],
     attributes: [],
-    properties: ['headline', 'connotation']
+    properties: ['headline', 'connotation', 'icon', 'VIVID_VERSION', 'componentName']
 })
 
 VwcNote.displayName = 'VwcNote'

package/v3/VwcNote/package.json

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

@@ -20,7 +20,23 @@ import React, { ReactNode, SyntheticEvent } from 'react';
 * @param {NumberFieldAppearance | undefined} appearance  **attribute** `appearance`
 * @param {NumberFieldShape | undefined} shape  **attribute** `shape`
 * @param {string | undefined} autoComplete  **attribute** `autoComplete`
-* @param  proxy
+* @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 {string | undefined} successText - Provides a custom success message. Any current error state will be overridden. **attribute** `success-text`
+* @param {string | undefined} label - The label for the form element. **attribute** `label`
+* @param {string | undefined} icon - A decorative icon the custom element should have. **attribute** `icon`
+* @param {'delegate'} _vividAriaBehaviour
+* @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 VwcNumberField: {
     (props: {
@@ -48,7 +64,20 @@ declare const VwcNumberField: {
         appearance?: any;
         shape?: any;
         autoComplete?: string | undefined;
-        proxy?: any;
+        helperText?: string | undefined;
+        errorText?: string | undefined;
+        successText?: string | undefined;
+        label?: string | undefined;
+        icon?: string | undefined;
+        _vividAriaBehaviour?: any;
+        value?: string | undefined;
+        currentValue?: any;
+        initialValue?: string | undefined;
+        disabled?: boolean | undefined;
+        name?: string | undefined;
+        required?: boolean | undefined;
+        VIVID_VERSION?: string | undefined;
+        componentName?: string | undefined;
     }): JSX.Element;
     displayName: string;
 };