@vonage/vivid-react 3.4.0 → 3.5.0

package/v3/VwcMenuItem/index.js

@@ -115,22 +115,28 @@ Code in this file were generated using following JSON:
    "description": "The role of the element.",
    "privacy": "public"
   },
+  {
+   "kind": "method",
+   "name": "#ensureRoleMatchesPresentational"
+  },
   {
    "kind": "field",
-   "name": "checked",
+   "name": "controlType",
    "type": {
-    "text": "boolean"
+    "text": "ControlType | undefined"
    },
-   "description": "The checked value of the element.",
+   "description": "Whether the menu item should behave as a checkbox or radio button.",
    "privacy": "public"
   },
   {
    "kind": "field",
-   "name": "observer",
+   "name": "checked",
    "type": {
-    "text": "MutationObserver | undefined"
+    "text": "boolean"
    },
-   "privacy": "private"
+   "default": "false",
+   "description": "The checked value of the element.",
+   "privacy": "public"
   },
   {
    "kind": "field",
@@ -178,7 +184,7 @@ Code in this file were generated using following JSON:
    "kind": "field",
    "name": "checkedAppearance",
    "type": {
-    "text": "CheckAppearance | undefined"
+    "text": "| 'normal'\n\t\t| 'tick-only' | undefined"
    },
    "description": "Controls the appearance of the check indicator.",
    "privacy": "public"
@@ -190,20 +196,6 @@ Code in this file were generated using following JSON:
     "text": "HTMLElement[] | undefined"
    }
   },
-  {
-   "kind": "field",
-   "name": "#submenuArray",
-   "privacy": "private",
-   "type": {
-    "text": "Menu[]"
-   },
-   "default": "[]"
-  },
-  {
-   "kind": "method",
-   "name": "updateSubmenu",
-   "privacy": "private"
-  },
   {
    "kind": "method",
    "name": "#collapseExpandedItem"
@@ -221,6 +213,58 @@ Code in this file were generated using following JSON:
   {
    "kind": "method",
    "name": "#emitSyntheticClick"
+  },
+  {
+   "kind": "field",
+   "name": "_vividAriaBehaviour",
+   "default": "'host'",
+   "type": {
+    "text": "'host'"
+   },
+   "inheritedFrom": {
+    "name": "HostSemantics",
+    "module": "src/shared/aria/host-semantics.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": [
@@ -228,19 +272,20 @@ Code in this file were generated using following JSON:
    "type": {
     "text": "CustomEvent<HTMLElement>"
    },
-   "description": "Fires a custom 'expanded-change' event when the expanded state changes",
+   "description": "Fired when the expanded state changes.",
    "name": "expanded-change"
   },
   {
    "type": {
     "text": "CustomEvent<undefined>"
    },
-   "description": "Fires a custom 'change' event when a non-submenu item with a role of `menuitemcheckbox`, `menuitemradio`, or `menuitem` is invoked",
+   "description": "Fired when the item is triggered. Does not fire when a submenu is collapsed or expanded.",
    "name": "change"
   }
  ],
  "attributes": [
   {
+   "name": "disabled",
    "type": {
     "text": "boolean"
    },
@@ -248,6 +293,7 @@ Code in this file were generated using following JSON:
    "fieldName": "disabled"
   },
   {
+   "name": "expanded",
    "type": {
     "text": "boolean"
    },
@@ -263,9 +309,19 @@ Code in this file were generated using following JSON:
    "fieldName": "role"
   },
   {
+   "name": "control-type",
+   "type": {
+    "text": "ControlType | undefined"
+   },
+   "description": "Whether the menu item should behave as a checkbox or radio button.",
+   "fieldName": "controlType"
+  },
+  {
+   "name": "checked",
    "type": {
     "text": "boolean"
    },
+   "default": "false",
    "description": "The checked value of the element.",
    "fieldName": "checked"
   },
@@ -305,15 +361,37 @@ Code in this file were generated using following JSON:
   {
    "name": "check-appearance",
    "type": {
-    "text": "CheckAppearance | undefined"
+    "text": "| 'normal'\n\t\t| 'tick-only' | undefined"
    },
    "description": "Controls the appearance of the check indicator.",
    "fieldName": "checkedAppearance"
+  },
+  {
+   "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": "AffixIcon",
+   "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,
@@ -321,11 +399,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"
    }
   ]
  }
@@ -339,7 +417,7 @@ registerMenuItem('vvd3')
 const VwcMenuItem = wrapper(`vvd3-menu-item`,  {
     events: [{"name":"change","propName":"onChange"},{"name":"expanded-change","propName":"onExpandedChange"}],
     attributes: [],
-    properties: ['disabled', 'expanded', 'role', 'checked', 'text', 'textSecondary', 'connotation', 'checkTrailing', 'checkedAppearance', 'trailingMetaSlottedContent', 'icon']
+    properties: ['disabled', 'expanded', 'role', 'controlType', 'checked', 'text', 'textSecondary', 'connotation', 'checkTrailing', 'checkedAppearance', 'trailingMetaSlottedContent', '_vividAriaBehaviour', 'icon', 'VIVID_VERSION', 'componentName', 'icon']
 })
 
 VwcMenuItem.displayName = 'VwcMenuItem'

package/v3/VwcMenuItem/package.json

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

@@ -1,7 +1,10 @@
 import React, { ReactNode } from 'react';
 /** VwcNav
 * For more info on this Vivid element please visit https://vivid.deno.dev/components/nav
-
+* @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 VwcNav: {
     (props: {
@@ -10,6 +13,9 @@ declare const VwcNav: {
         id?: string | undefined;
         style?: React.CSSProperties | undefined;
         ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined;
+        _vividAriaBehaviour?: any;
+        VIVID_VERSION?: string | undefined;
+        componentName?: string | undefined;
     }): JSX.Element;
     displayName: string;
 };

package/v3/VwcNav/index.js

@@ -13,14 +13,61 @@ Code in this file were generated using following JSON:
    "name": ""
   }
  ],
+ "mixins": [
+  {
+   "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,
   "name": "nav"
- }
+ },
+ "members": [
+  {
+   "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"
+   }
+  }
+ ]
 }
 */
 import wrapper from '@vonage/vivid-react-wrapper'
@@ -31,7 +78,7 @@ registerNav('vvd3')
 const VwcNav = wrapper(`vvd3-nav`,  {
     events: [],
     attributes: [],
-    properties: []
+    properties: ['_vividAriaBehaviour', 'VIVID_VERSION', 'componentName']
 })
 
 VwcNav.displayName = 'VwcNav'

package/v3/VwcNav/package.json

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

@@ -6,7 +6,12 @@ import React, { ReactNode, SyntheticEvent } from 'react';
 * @param {NavDisclosureAppearance | undefined} appearance - The appearance nav-disclosure should have. **attribute** `appearance`
 * @param {NavDisclosureConnotation | undefined} connotation - The connotation nav-disclosure should have. **attribute** `connotation`
 * @param {boolean} open - Indicates whether the nav-disclosure is open **attribute** `open`
-* @param {string | null} ariaCurrent  **attribute** `aria-current`
+* @param {boolean} current - Indicates there's a nested active nav-item within nav-disclosure **attribute** `current`
+* @param {string | undefined} icon - A decorative icon the custom element should have. **attribute** `icon`
+* @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 VwcNavDisclosure: {
     (props: {
@@ -21,7 +26,11 @@ declare const VwcNavDisclosure: {
         appearance?: any;
         connotation?: any;
         open?: boolean | undefined;
-        ariaCurrent?: string | null | undefined;
+        current?: boolean | undefined;
+        icon?: string | undefined;
+        _vividAriaBehaviour?: any;
+        VIVID_VERSION?: string | undefined;
+        componentName?: string | undefined;
     }): JSX.Element;
     displayName: string;
 };

package/v3/VwcNavDisclosure/index.js

@@ -91,7 +91,7 @@ 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"
   }
  ],
@@ -142,16 +142,70 @@ Code in this file were generated using following JSON:
   },
   {
    "kind": "field",
-   "name": "ariaCurrent",
+   "name": "current",
    "type": {
-    "text": "string | null"
+    "text": "boolean"
    },
-   "default": "null"
+   "default": "false",
+   "description": "Indicates there's a nested active nav-item within nav-disclosure",
+   "privacy": "public"
   },
   {
    "kind": "field",
    "name": "#onToggle",
    "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": "_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"
+   }
   }
  ],
  "events": [
@@ -188,6 +242,7 @@ Code in this file were generated using following JSON:
    "fieldName": "connotation"
   },
   {
+   "name": "open",
    "type": {
     "text": "boolean"
    },
@@ -196,17 +251,40 @@ Code in this file were generated using following JSON:
    "fieldName": "open"
   },
   {
-   "name": "aria-current",
+   "name": "current",
    "type": {
-    "text": "string | null"
+    "text": "boolean"
    },
-   "default": "null",
-   "fieldName": "ariaCurrent"
+   "default": "false",
+   "description": "Indicates there's a nested active nav-item within nav-disclosure",
+   "fieldName": "current"
+  },
+  {
+   "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": "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,
@@ -222,7 +300,7 @@ registerNavDisclosure('vvd3')
 const VwcNavDisclosure = wrapper(`vvd3-nav-disclosure`,  {
     events: [{"name":"toggle","propName":"onToggle"}],
     attributes: [],
-    properties: ['details', 'label', 'appearance', 'connotation', 'open', 'ariaCurrent']
+    properties: ['details', 'label', 'appearance', 'connotation', 'open', 'current', 'icon', '_vividAriaBehaviour', 'VIVID_VERSION', 'componentName']
 })
 
 VwcNavDisclosure.displayName = 'VwcNavDisclosure'

package/v3/VwcNavDisclosure/package.json

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

@@ -2,9 +2,24 @@ import React, { ReactNode } from 'react';
 /** A Nav Item Custom HTML Element.
 Based largely on the https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element .
 * For more info on this Vivid element please visit https://vivid.deno.dev/components/nav-item
-* @param {string | undefined} text - Indicates the text anchor's text. **attribute** `text`
-* @param {TextAnchorConnotation | undefined} connotation - The connotation Text-Anchor should have. **attribute** `connotation`
-* @param {TextAnchorAppearance | undefined} appearance - The appearance Text-Anchor should have. **attribute** `appearance`
+* @param {string | undefined} text - Text of the nav item **attribute** `text`
+* @param {NavItemConnotation | undefined} connotation - Sets the connotation color of the selected nav item **attribute** `connotation`
+* @param {NavItemAppearance | undefined} appearance - Sets the nav item's appearance **attribute** `appearance`
+* @param {boolean} current - Sets the nav item as a current **attribute** `current`
+* @param {string | undefined} icon - A decorative icon the custom element should have. **attribute** `icon`
+* @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 VwcNavItem: {
     (props: {
@@ -16,6 +31,20 @@ declare const VwcNavItem: {
         text?: string | undefined;
         connotation?: any;
         appearance?: any;
+        current?: boolean | undefined;
+        icon?: string | 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;
 };