@vonage/vivid-vue 3.20.1 → 3.22.0

package/dist/web-types.json

@@ -1,7 +1,7 @@
 {
  "framework": "vue",
  "name": "@vonage/vivid-vue",
- "version": "3.20.1",
+ "version": "3.22.0",
  "contributions": {
   "html": {
    "description-markup": "markdown",
@@ -296,6 +296,13 @@
         "type": "'page' | 'step' | 'location' | 'date' | 'time' | 'true' | 'false'"
        }
       },
+      {
+       "name": "dismissButtonAriaLabel",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
       {
        "name": "removable",
        "description": "if the alert is removable\naccepts boolean",
@@ -624,6 +631,13 @@
         "type": "'page' | 'step' | 'location' | 'date' | 'time' | 'true' | 'false'"
        }
       },
+      {
+       "name": "dismissAriaLabel",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
       {
        "name": "role",
        "value": {
@@ -1334,6 +1348,14 @@
         "type": "'page' | 'step' | 'location' | 'date' | 'time' | 'true' | 'false'"
        }
       },
+      {
+       "name": "appearance",
+       "description": "The appearance the card should have.",
+       "value": {
+        "kind": "expression",
+        "type": "'elevated' | 'ghost' | 'outlined'"
+       }
+      },
       {
        "name": "headline",
        "description": "the text of the card heading\naccepts string",
@@ -1521,6 +1543,14 @@
         "type": "boolean"
        }
       },
+      {
+       "name": "currentChecked",
+       "description": "The current checkedness of the element. This property serves as a mechanism\nto set the `checked` property through both property assignment and the\n.setAttribute() method. This is useful for setting the field's checkedness\nin UI libraries that bind data through the .setAttribute() API\nand don't support IDL attribute binding.",
+       "value": {
+        "kind": "expression",
+        "type": "boolean"
+       }
+      },
       {
        "name": "readonly",
        "description": "When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information.",
@@ -1529,6 +1559,20 @@
         "type": "boolean"
        }
       },
+      {
+       "name": "ariaLabel",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
+      {
+       "name": "tabindex",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
       {
        "name": "connotation",
        "description": "The connotation the checklist should have.",
@@ -1562,6 +1606,10 @@
       {
        "name": "input",
        "description": "Fires when the value of an element has been changed."
+      },
+      {
+       "name": "change",
+       "description": "Emits a custom change event when the checked state changes"
       }
      ],
      "slots": [],
@@ -1607,6 +1655,14 @@
         "type": "string"
        }
       },
+      {
+       "name": "currentValue",
+       "description": "The current value of the element. This property serves as a mechanism\nto set the `value` property through both property assignment and the\n.setAttribute() method. This is useful for setting the field's value\nin UI libraries that bind data through the .setAttribute() API\nand don't support IDL attribute binding.",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
       {
        "name": "name",
        "description": "The name of the element. This element's value will be surfaced during form submission under the provided name.",
@@ -1696,6 +1752,10 @@
       {
        "name": "input",
        "description": "Fires when the value of an element has been changed."
+      },
+      {
+       "name": "change",
+       "description": "Fires a custom 'change' event when the value updates"
       }
      ],
      "slots": [
@@ -1748,6 +1808,7 @@
       },
       {
        "name": "selectionMode",
+       "description": "Indicates the selection mode.",
        "value": {
         "kind": "expression",
         "type": "'none' | 'single-row' | 'multi-row' | 'single-cell' | 'multi-cell'"
@@ -1830,6 +1891,7 @@
       },
       {
        "name": "ariaSelected",
+       "description": "Indicates the selected status.",
        "value": {
         "kind": "expression",
         "type": "string"
@@ -1916,6 +1978,7 @@
       },
       {
        "name": "ariaSelected",
+       "description": "Indicates the selected status.",
        "value": {
         "kind": "expression",
         "type": "string"
@@ -1923,6 +1986,7 @@
       },
       {
        "name": "ariaSort",
+       "description": "Indicates the sort status.",
        "value": {
         "kind": "expression",
         "type": "string"
@@ -1957,6 +2021,10 @@
       {
        "name": "cell-focused",
        "description": "Fires a custom 'cell-focused' event when focus is on the cell or its contents"
+      },
+      {
+       "name": "sort",
+       "description": "Event that fires when a sortable column header is clicked"
       }
      ],
      "slots": [
@@ -1973,16 +2041,134 @@
     },
     {
      "name": "VDatePicker",
-     "description": "Base class for date-picker",
+     "description": "Single date picker component.",
      "attributes": [
       {
-       "name": "helperText",
-       "description": "The helper text for the form element.",
+       "name": "label",
+       "description": "The label for the form element.",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
+      {
+       "name": "errorText",
+       "description": "The error text for the form element.",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
+      {
+       "name": "ariaCurrent",
+       "description": "Indicates the element that represents the current item within a container or set of related elements.",
+       "value": {
+        "kind": "expression",
+        "type": "'page' | 'step' | 'location' | 'date' | 'time' | 'true' | 'false'"
+       }
+      },
+      {
+       "name": "disabled",
+       "description": "Sets the element's disabled state. A disabled element will not be included during form submission.",
+       "value": {
+        "kind": "expression",
+        "type": "boolean"
+       }
+      },
+      {
+       "name": "name",
+       "description": "The name of the element. This element's value will be surfaced during form submission under the provided name.",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
+      {
+       "name": "required",
+       "description": "Require the field to be completed prior to form submission.",
+       "value": {
+        "kind": "expression",
+        "type": "boolean"
+       }
+      },
+      {
+       "name": "max",
+       "description": "The latest accepted date of the date-picker.",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
+      {
+       "name": "min",
+       "description": "The earliest accepted date of the date-picker.",
        "value": {
         "kind": "expression",
         "type": "string"
        }
       },
+      {
+       "name": "value",
+       "description": "The initial value of the date-picker.",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
+      {
+       "name": "currentValue",
+       "description": "The current value of the date-picker.",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
+      {
+       "name": "readonly",
+       "description": "Whether the date-picker is readonly.",
+       "value": {
+        "kind": "expression",
+        "type": "boolean"
+       }
+      }
+     ],
+     "events": [
+      {
+       "name": "click",
+       "description": "Fires when a pointing device button (such as a mouse's primary mouse button) is both pressed and released while the pointer is located inside the element."
+      },
+      {
+       "name": "focus",
+       "description": "Fires when the element receives focus."
+      },
+      {
+       "name": "blur",
+       "description": "Fires when the element loses focus."
+      },
+      {
+       "name": "keydown",
+       "description": "Fires when a key is pressed."
+      },
+      {
+       "name": "keyup",
+       "description": "Fires when a key is released."
+      },
+      {
+       "name": "input",
+       "description": "Fires when the value of an element has been changed."
+      }
+     ],
+     "slots": [],
+     "source": {
+      "module": "@vonage/vivid-vue",
+      "symbol": "VDatePicker"
+     },
+     "priority": "highest"
+    },
+    {
+     "name": "VDateRangePicker",
+     "description": "Base class for date-range-picker",
+     "attributes": [
       {
        "name": "label",
        "description": "The label for the form element.",
@@ -2031,6 +2217,30 @@
         "type": "boolean"
        }
       },
+      {
+       "name": "max",
+       "description": "The latest accepted date of the date-picker.",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
+      {
+       "name": "currentStart",
+       "description": "The current start value of the element. This property serves as a mechanism\nto set the `start` property through both property assignment and the\n.setAttribute() method. This is useful for setting the field's value\nin UI libraries that bind data through the .setAttribute() API\nand don't support IDL attribute binding.",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
+      {
+       "name": "currentEnd",
+       "description": "The current end value of the element. This property serves as a mechanism\nto set the `end` property through both property assignment and the\n.setAttribute() method. This is useful for setting the field's value\nin UI libraries that bind data through the .setAttribute() API\nand don't support IDL attribute binding.",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
       {
        "name": "min",
        "description": "The earliest accepted date of the date-picker.",
@@ -2040,8 +2250,8 @@
        }
       },
       {
-       "name": "max",
-       "description": "The latest accepted date of the date-picker.",
+       "name": "value",
+       "description": "The initial value of the date-picker.",
        "value": {
         "kind": "expression",
         "type": "string"
@@ -2084,12 +2294,24 @@
       {
        "name": "keyup",
        "description": "Fires when a key is released."
+      },
+      {
+       "name": "input",
+       "description": "Fires when the value of an element has been changed."
+      },
+      {
+       "name": "input:start",
+       "description": "Event emitted when the start value changes"
+      },
+      {
+       "name": "input:end",
+       "description": "Event emitted when the end value changes"
       }
      ],
      "slots": [],
      "source": {
       "module": "@vonage/vivid-vue",
-      "symbol": "VDatePicker"
+      "symbol": "VDateRangePicker"
      },
      "priority": "highest"
     },
@@ -2169,6 +2391,13 @@
         "kind": "expression",
         "type": "string"
        }
+      },
+      {
+       "name": "dismissButtonAriaLabel",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
       }
      ],
      "events": [
@@ -2198,7 +2427,7 @@
       },
       {
        "name": "close",
-       "description": "Fired when the dialog is closed"
+       "description": "Fired when the dialog is closed."
       }
      ],
      "slots": [
@@ -2944,6 +3173,14 @@
         "type": "'menuitem' | 'menuitemcheckbox' | 'menuitemradio'"
        }
       },
+      {
+       "name": "checked",
+       "description": "The checked value of the element.",
+       "value": {
+        "kind": "expression",
+        "type": "boolean"
+       }
+      },
       {
        "name": "text",
        "description": "Indicates the menu item's text.",
@@ -2959,6 +3196,22 @@
         "kind": "expression",
         "type": "string"
        }
+      },
+      {
+       "name": "checkTrailing",
+       "description": "Controls the placement of the menu item's checkmark or radio icon.",
+       "value": {
+        "kind": "expression",
+        "type": "boolean"
+       }
+      },
+      {
+       "name": "checkAppearance",
+       "description": "Controls the appearance of the check indicator.",
+       "value": {
+        "kind": "expression",
+        "type": "'normal' | 'tick-only'"
+       }
       }
      ],
      "events": [
@@ -2989,6 +3242,10 @@
       {
        "name": "expanded-change",
        "description": "Fires a custom 'expanded-change' event when the expanded state changes"
+      },
+      {
+       "name": "change",
+       "description": "Fires a custom 'change' event when a non-submenu item with a role of `menuitemcheckbox`, `menuitemradio`, or `menuitem` is invoked"
       }
      ],
      "slots": [
@@ -3420,6 +3677,14 @@
         "type": "string"
        }
       },
+      {
+       "name": "currentValue",
+       "description": "The current value of the element. This property serves as a mechanism\nto set the `value` property through both property assignment and the\n.setAttribute() method. This is useful for setting the field's value\nin UI libraries that bind data through the .setAttribute() API\nand don't support IDL attribute binding.",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
       {
        "name": "name",
        "description": "The name of the element. This element's value will be surfaced during form submission under the provided name.",
@@ -3524,6 +3789,20 @@
         "type": "number"
        }
       },
+      {
+       "name": "incrementButtonAriaLabel",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
+      {
+       "name": "decrementButtonAriaLabel",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
       {
        "name": "appearance",
        "value": {
@@ -3567,6 +3846,10 @@
        "name": "keyup",
        "description": "Fires when a key is released."
       },
+      {
+       "name": "input",
+       "description": "Fires a custom 'input' event when the value has changed"
+      },
       {
        "name": "change",
        "description": "Fires a custom 'change' event when the value has changed"
@@ -3815,8 +4098,16 @@
         "type": "boolean"
        }
       },
+      {
+       "name": "ariaLabel",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
       {
        "name": "shape",
+       "description": "Indicates the progress' shape.",
        "value": {
         "kind": "expression",
         "type": "'rounded' | 'sharp'"
@@ -3824,6 +4115,7 @@
       },
       {
        "name": "connotation",
+       "description": "Indicates the progress' connotation.",
        "value": {
         "kind": "expression",
         "type": "'accent' | 'success' | 'alert' | 'cta' | 'pacific'"
@@ -3831,6 +4123,7 @@
       },
       {
        "name": "reverse",
+       "description": "Indicates the progress' reverse status.",
        "value": {
         "kind": "expression",
         "type": "boolean"
@@ -3914,6 +4207,13 @@
         "type": "boolean"
        }
       },
+      {
+       "name": "ariaLabel",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
       {
        "name": "connotation",
        "value": {
@@ -4038,6 +4338,13 @@
         "type": "boolean"
        }
       },
+      {
+       "name": "ariaLabel",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
       {
        "name": "label",
        "description": "Indicates the radio's label.",
@@ -4128,6 +4435,14 @@
         "type": "string"
        }
       },
+      {
+       "name": "value",
+       "description": "The value of the checked radio",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
       {
        "name": "orientation",
        "description": "The orientation of the group",
@@ -4169,6 +4484,10 @@
       {
        "name": "input",
        "description": "Fires when the value of an element has been changed."
+      },
+      {
+       "name": "change",
+       "description": "Fires a custom 'change' event when the value changes"
       }
      ],
      "slots": [
@@ -4183,6 +4502,108 @@
      },
      "priority": "highest"
     },
+    {
+     "name": "VSelectableBox",
+     "description": "Base class for selectable-box",
+     "attributes": [
+      {
+       "name": "ariaCurrent",
+       "description": "Indicates the element that represents the current item within a container or set of related elements.",
+       "value": {
+        "kind": "expression",
+        "type": "'page' | 'step' | 'location' | 'date' | 'time' | 'true' | 'false'"
+       }
+      },
+      {
+       "name": "ariaLabel",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
+      {
+       "name": "checked",
+       "description": "Controls the checked state of the box",
+       "value": {
+        "kind": "expression",
+        "type": "boolean"
+       }
+      },
+      {
+       "name": "clickable",
+       "description": "Makes the whole selectable box clickable",
+       "value": {
+        "kind": "expression",
+        "type": "boolean"
+       }
+      },
+      {
+       "name": "connotation",
+       "description": "The connotation the selectable box should have.",
+       "value": {
+        "kind": "expression",
+        "type": "'accent' | 'cta'"
+       }
+      },
+      {
+       "name": "controlType",
+       "description": "The type of control the box should have: checkbox or radio.",
+       "value": {
+        "kind": "expression",
+        "type": "'checkbox' | 'radio'"
+       }
+      },
+      {
+       "name": "tight",
+       "description": "Removes the padding around the box's slot content",
+       "value": {
+        "kind": "expression",
+        "type": "boolean"
+       }
+      }
+     ],
+     "events": [
+      {
+       "name": "click",
+       "description": "Fires when a pointing device button (such as a mouse's primary mouse button) is both pressed and released while the pointer is located inside the element."
+      },
+      {
+       "name": "focus",
+       "description": "Fires when the element receives focus."
+      },
+      {
+       "name": "blur",
+       "description": "Fires when the element loses focus."
+      },
+      {
+       "name": "keydown",
+       "description": "Fires when a key is pressed."
+      },
+      {
+       "name": "keyup",
+       "description": "Fires when a key is released."
+      },
+      {
+       "name": "input",
+       "description": "Fires when the value of an element has been changed."
+      },
+      {
+       "name": "change",
+       "description": "Fired when the checked state changes"
+      }
+     ],
+     "slots": [
+      {
+       "name": "default",
+       "description": "Slot for box's content."
+      }
+     ],
+     "source": {
+      "module": "@vonage/vivid-vue",
+      "symbol": "VSelectableBox"
+     },
+     "priority": "highest"
+    },
     {
      "name": "VSelect",
      "description": "Base class for select",
@@ -4259,6 +4680,14 @@
         "type": "string"
        }
       },
+      {
+       "name": "currentValue",
+       "description": "The current value of the element. This property serves as a mechanism\nto set the `value` property through both property assignment and the\n.setAttribute() method. This is useful for setting the field's value\nin UI libraries that bind data through the .setAttribute() API\nand don't support IDL attribute binding.",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
       {
        "name": "name",
        "description": "The name of the element. This element's value will be surfaced during form submission under the provided name.",
@@ -4353,6 +4782,10 @@
        "name": "keyup",
        "description": "Fires when a key is released."
       },
+      {
+       "name": "input",
+       "description": "Fires a custom 'input' event when the value updates"
+      },
       {
        "name": "change",
        "description": "Fires a custom 'change' event when the value updates"
@@ -4447,6 +4880,14 @@
       {
        "name": "input",
        "description": "Fires when the value of an element has been changed."
+      },
+      {
+       "name": "close",
+       "description": "Fired when the side drawer is closed."
+      },
+      {
+       "name": "open",
+       "description": "Fired when the side drawer is opened."
       }
      ],
      "slots": [
@@ -4493,6 +4934,14 @@
         "type": "string"
        }
       },
+      {
+       "name": "currentValue",
+       "description": "The current value of the element. This property serves as a mechanism\nto set the `value` property through both property assignment and the\n.setAttribute() method. This is useful for setting the field's value\nin UI libraries that bind data through the .setAttribute() API\nand don't support IDL attribute binding.",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
       {
        "name": "name",
        "description": "The name of the element. This element's value will be surfaced during form submission under the provided name.",
@@ -4557,6 +5006,20 @@
         "type": "'single-value'"
        }
       },
+      {
+       "name": "ariaLabel",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
+      {
+       "name": "ariaValuetext",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
       {
        "name": "markers",
        "description": "Display markers on/off",
@@ -4564,6 +5027,14 @@
         "kind": "expression",
         "type": "boolean"
        }
+      },
+      {
+       "name": "connotation",
+       "description": "slider connotation",
+       "value": {
+        "kind": "expression",
+        "type": "'accent' | 'cta'"
+       }
       }
      ],
      "events": [
@@ -4590,6 +5061,10 @@
       {
        "name": "input",
        "description": "Fires when the value of an element has been changed."
+      },
+      {
+       "name": "change",
+       "description": "Fires a custom 'change' event when the slider value changes"
       }
      ],
      "slots": [],
@@ -4621,10 +5096,19 @@
       },
       {
        "name": "connotation",
+       "description": "Indicates the switch's connotation.",
        "value": {
         "kind": "expression",
         "type": "'accent' | 'alert' | 'success' | 'cta'"
        }
+      },
+      {
+       "name": "currentChecked",
+       "description": "The current checked state of the switch.",
+       "value": {
+        "kind": "expression",
+        "type": "boolean"
+       }
       }
      ],
      "events": [
@@ -4651,6 +5135,10 @@
       {
        "name": "input",
        "description": "Fires when the value of an element has been changed."
+      },
+      {
+       "name": "change",
+       "description": "Emitted when the checked state of the switch changes."
       }
      ],
      "slots": [],
@@ -4914,7 +5402,16 @@
     {
      "name": "VTextArea",
      "description": "Base class for text-area",
-     "attributes": [],
+     "attributes": [
+      {
+       "name": "currentValue",
+       "description": "The current value of the text-area.",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      }
+     ],
      "events": [
       {
        "name": "click",
@@ -4935,6 +5432,10 @@
       {
        "name": "keyup",
        "description": "Fires when a key is released."
+      },
+      {
+       "name": "input",
+       "description": "Fires when the value of an element has been changed."
       }
      ],
      "slots": [],
@@ -5020,6 +5521,14 @@
         "type": "string"
        }
       },
+      {
+       "name": "currentValue",
+       "description": "The current value of the element. This property serves as a mechanism\nto set the `value` property through both property assignment and the\n.setAttribute() method. This is useful for setting the field's value\nin UI libraries that bind data through the .setAttribute() API\nand don't support IDL attribute binding.",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
+      },
       {
        "name": "name",
        "description": "The name of the element. This element's value will be surfaced during form submission under the provided name.",
@@ -5159,6 +5668,10 @@
        "name": "keyup",
        "description": "Fires when a key is released."
       },
+      {
+       "name": "input",
+       "description": "Fires when the value of an element has been changed."
+      },
       {
        "name": "change",
        "description": "Fires a custom 'change' event when the value has changed"
@@ -5637,6 +6150,13 @@
         "kind": "expression",
         "type": "'page' | 'step' | 'location' | 'date' | 'time' | 'true' | 'false'"
        }
+      },
+      {
+       "name": "ariaLabel",
+       "value": {
+        "kind": "expression",
+        "type": "string"
+       }
       }
      ],
      "events": [