@vonage/vivid-vue 4.23.0 → 4.25.0

package/generated/components/VCombobox.vue2.d.ts

@@ -1,5 +1,6 @@
 import { PropType } from 'vue';
 import { IconId } from '../icons';
+import type { VwcComboboxElement } from '@vonage/vivid';
 declare const _default: import("vue/types/v3-define-component").DefineComponent<{
     /**
      * The appearance attribute.
@@ -16,14 +17,14 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * The disabled state of the listbox.
+     * Sets the element's disabled state. A disabled element will not be included during form submission.
      */
     disabled: {
         type: PropType<boolean>;
         default: undefined;
     };
     /**
-     * The error text for the form element.
+     * Provides a custom error message. Any current error state will be overridden.
      */
     errorText: {
         type: PropType<string>;
@@ -37,7 +38,8 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * The helper text for the form element.
+     * Provides additional information to help the user enter the correct information.
+     * To add HTML to the helper text, use the helper-text slot instead.
      */
     helperText: {
         type: PropType<string>;
@@ -52,7 +54,7 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * The initial value of the form. This value sets the `value` property
+     * The default value of the element. This value sets the `value` property
      * only when the `value` property has not been explicitly set.
      */
     initialValue: {
@@ -118,29 +120,21 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * The success text for the form element.
+     * Provides a custom success message. Any current error state will be overridden.
      */
     successText: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * The current value of the element. This property serves as a mechanism
-     * to set the `value` property through both property assignment and the
-     * .setAttribute() method. This is useful for setting the field's value
-     * in UI libraries that bind data through the .setAttribute() API
-     * and don't support IDL attribute binding.
+     * The current value of the element.
      */
     value: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * The current value of the element. This property serves as a mechanism
-     * to set the `value` property through both property assignment and the
-     * .setAttribute() method. This is useful for setting the field's value
-     * in UI libraries that bind data through the .setAttribute() API
-     * and don't support IDL attribute binding.
+     * The current value of the element.
      */
     modelValue: {
         type: PropType<string>;
@@ -148,37 +142,21 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
     };
 }, {
     componentName: import("vue").Ref<string>;
-    element: import("vue").Ref<{
-        autocomplete: import("@vonage/vivid/lib/combobox/combobox.options").ComboboxAutocomplete | undefined;
-        filteredOptions: import("@vonage/vivid").VwcOptionElement[];
-        appearance?: import("@vonage/vivid").ComboboxAppearance | undefined;
-        shape?: import("@vonage/vivid/lib/combobox/combobox").ComboboxShape | undefined;
-        scale?: import("@vonage/vivid/lib/combobox/combobox").ComboboxSize | undefined;
-        placement?: import("@vonage/vivid").PopupPlacement | undefined;
-        fixedDropdown: boolean;
-        _popup: import("@vonage/vivid/lib/popup/popup").Popup;
-        _anchor: HTMLElement;
-        validate: () => void;
-        open: boolean;
-        options: import("@vonage/vivid").VwcOptionElement[];
-        placeholder: string;
-        value: string;
-        connectedCallback: () => void;
-        filterOptions: () => void;
-        errorValidationMessage: string;
-        label: string;
-        userValid: boolean;
-        dirtyValue: boolean;
-        helperText?: string | undefined;
-        _helperTextSlottedContent?: HTMLElement[] | undefined;
-        errorText: string;
-        successText?: string | undefined;
-    } | null>;
+    element: import("vue").Ref<VwcComboboxElement | null>;
 }, import("vue").Data, {}, {
+    /**
+     * Return the current validity of the element.
+     */
+    checkValidity(): boolean;
     /**
      * Filter available options by text value.
      */
     filterOptions(): void;
+    /**
+     * Return the current validity of the element.
+     * If false, fires an invalid event at the element.
+     */
+    reportValidity(): boolean;
     /**
      * Moves focus to the first selectable option.
      */
@@ -207,14 +185,14 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * The disabled state of the listbox.
+     * Sets the element's disabled state. A disabled element will not be included during form submission.
      */
     disabled: {
         type: PropType<boolean>;
         default: undefined;
     };
     /**
-     * The error text for the form element.
+     * Provides a custom error message. Any current error state will be overridden.
      */
     errorText: {
         type: PropType<string>;
@@ -228,7 +206,8 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * The helper text for the form element.
+     * Provides additional information to help the user enter the correct information.
+     * To add HTML to the helper text, use the helper-text slot instead.
      */
     helperText: {
         type: PropType<string>;
@@ -243,7 +222,7 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * The initial value of the form. This value sets the `value` property
+     * The default value of the element. This value sets the `value` property
      * only when the `value` property has not been explicitly set.
      */
     initialValue: {
@@ -309,29 +288,21 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * The success text for the form element.
+     * Provides a custom success message. Any current error state will be overridden.
      */
     successText: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * The current value of the element. This property serves as a mechanism
-     * to set the `value` property through both property assignment and the
-     * .setAttribute() method. This is useful for setting the field's value
-     * in UI libraries that bind data through the .setAttribute() API
-     * and don't support IDL attribute binding.
+     * The current value of the element.
      */
     value: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * The current value of the element. This property serves as a mechanism
-     * to set the `value` property through both property assignment and the
-     * .setAttribute() method. This is useful for setting the field's value
-     * in UI libraries that bind data through the .setAttribute() API
-     * and don't support IDL attribute binding.
+     * The current value of the element.
      */
     modelValue: {
         type: PropType<string>;

package/generated/components/VCombobox.vue3.d.ts

@@ -18,14 +18,14 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * The disabled state of the listbox.
+     * Sets the element's disabled state. A disabled element will not be included during form submission.
      */
     disabled: {
         type: PropType<boolean>;
         default: undefined;
     };
     /**
-     * The error text for the form element.
+     * Provides a custom error message. Any current error state will be overridden.
      */
     errorText: {
         type: PropType<string>;
@@ -39,7 +39,8 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * The helper text for the form element.
+     * Provides additional information to help the user enter the correct information.
+     * To add HTML to the helper text, use the helper-text slot instead.
      */
     helperText: {
         type: PropType<string>;
@@ -54,7 +55,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * The initial value of the form. This value sets the `value` property
+     * The default value of the element. This value sets the `value` property
      * only when the `value` property has not been explicitly set.
      */
     initialValue: {
@@ -120,29 +121,21 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * The success text for the form element.
+     * Provides a custom success message. Any current error state will be overridden.
      */
     successText: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * The current value of the element. This property serves as a mechanism
-     * to set the `value` property through both property assignment and the
-     * .setAttribute() method. This is useful for setting the field's value
-     * in UI libraries that bind data through the .setAttribute() API
-     * and don't support IDL attribute binding.
+     * The current value of the element.
      */
     value: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * The current value of the element. This property serves as a mechanism
-     * to set the `value` property through both property assignment and the
-     * .setAttribute() method. This is useful for setting the field's value
-     * in UI libraries that bind data through the .setAttribute() API
-     * and don't support IDL attribute binding.
+     * The current value of the element.
      */
     modelValue: {
         type: PropType<string>;
@@ -150,37 +143,21 @@ declare const _default: import("vue").DefineComponent<{
     };
 }, {
     componentName: import("vue").Ref<string>;
-    element: import("vue").Ref<{
-        autocomplete: import("@vonage/vivid/lib/combobox/combobox.options").ComboboxAutocomplete | undefined;
-        filteredOptions: import("@vonage/vivid").VwcOptionElement[];
-        appearance?: import("@vonage/vivid").ComboboxAppearance | undefined;
-        shape?: import("@vonage/vivid/lib/combobox/combobox").ComboboxShape | undefined;
-        scale?: import("@vonage/vivid/lib/combobox/combobox").ComboboxSize | undefined;
-        placement?: import("@vonage/vivid").PopupPlacement | undefined;
-        fixedDropdown: boolean;
-        _popup: import("@vonage/vivid/lib/popup/popup").Popup;
-        _anchor: HTMLElement;
-        validate: () => void;
-        open: boolean;
-        options: import("@vonage/vivid").VwcOptionElement[];
-        placeholder: string;
-        value: string;
-        connectedCallback: () => void;
-        filterOptions: () => void;
-        errorValidationMessage: string;
-        label: string;
-        userValid: boolean;
-        dirtyValue: boolean;
-        helperText?: string | undefined;
-        _helperTextSlottedContent?: HTMLElement[] | undefined;
-        errorText: string;
-        successText?: string | undefined;
-    } | null>;
+    element: import("vue").Ref<VwcComboboxElement | null>;
 }, unknown, {}, {
+    /**
+     * Return the current validity of the element.
+     */
+    checkValidity(): boolean;
     /**
      * Filter available options by text value.
      */
     filterOptions(): void;
+    /**
+     * Return the current validity of the element.
+     * If false, fires an invalid event at the element.
+     */
+    reportValidity(): boolean;
     /**
      * Moves focus to the first selectable option.
      */
@@ -292,14 +269,14 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * The disabled state of the listbox.
+     * Sets the element's disabled state. A disabled element will not be included during form submission.
      */
     disabled: {
         type: PropType<boolean>;
         default: undefined;
     };
     /**
-     * The error text for the form element.
+     * Provides a custom error message. Any current error state will be overridden.
      */
     errorText: {
         type: PropType<string>;
@@ -313,7 +290,8 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * The helper text for the form element.
+     * Provides additional information to help the user enter the correct information.
+     * To add HTML to the helper text, use the helper-text slot instead.
      */
     helperText: {
         type: PropType<string>;
@@ -328,7 +306,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * The initial value of the form. This value sets the `value` property
+     * The default value of the element. This value sets the `value` property
      * only when the `value` property has not been explicitly set.
      */
     initialValue: {
@@ -394,29 +372,21 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * The success text for the form element.
+     * Provides a custom success message. Any current error state will be overridden.
      */
     successText: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * The current value of the element. This property serves as a mechanism
-     * to set the `value` property through both property assignment and the
-     * .setAttribute() method. This is useful for setting the field's value
-     * in UI libraries that bind data through the .setAttribute() API
-     * and don't support IDL attribute binding.
+     * The current value of the element.
      */
     value: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * The current value of the element. This property serves as a mechanism
-     * to set the `value` property through both property assignment and the
-     * .setAttribute() method. This is useful for setting the field's value
-     * in UI libraries that bind data through the .setAttribute() API
-     * and don't support IDL attribute binding.
+     * The current value of the element.
      */
     modelValue: {
         type: PropType<string>;
@@ -503,7 +473,7 @@ declare const _default: import("vue").DefineComponent<{
      */
     'helper-text': Record<string, never>;
     /**
-     * Slot to add an icon to the combobox control.
+     * The preferred way to add an icon to the combobox control.
      */
     icon: Record<string, never>;
     /**

package/generated/components/VDataGrid.types.d.ts

@@ -82,7 +82,7 @@ export interface VDataGridProps {
      */
     generateHeader?: 'none' | 'default' | 'sticky';
     /**
-     * String that gets applied to the the css gridTemplateColumns attribute of child rows
+     * String that gets applied to the css gridTemplateColumns attribute of child rows
      */
     gridTemplateColumns?: string;
     /**

package/generated/components/VDataGrid.vue2.d.ts

@@ -9,7 +9,7 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * String that gets applied to the the css gridTemplateColumns attribute of child rows
+     * String that gets applied to the css gridTemplateColumns attribute of child rows
      */
     gridTemplateColumns: {
         type: PropType<string>;
@@ -51,7 +51,7 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * String that gets applied to the the css gridTemplateColumns attribute of child rows
+     * String that gets applied to the css gridTemplateColumns attribute of child rows
      */
     gridTemplateColumns: {
         type: PropType<string>;

package/generated/components/VDataGrid.vue3.d.ts

@@ -10,7 +10,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * String that gets applied to the the css gridTemplateColumns attribute of child rows
+     * String that gets applied to the css gridTemplateColumns attribute of child rows
      */
     gridTemplateColumns: {
         type: PropType<string>;
@@ -135,7 +135,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * String that gets applied to the the css gridTemplateColumns attribute of child rows
+     * String that gets applied to the css gridTemplateColumns attribute of child rows
      */
     gridTemplateColumns: {
         type: PropType<string>;

package/generated/components/VDataGridRow.vue2.d.ts

@@ -54,8 +54,8 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
 }>>, {
-    ariaSelected: string;
     gridTemplateColumns: string;
+    ariaSelected: string;
     rowType: "default" | "header" | "sticky-header";
 }>;
 export default _default;

package/generated/components/VDataGridRow.vue3.d.ts

@@ -211,8 +211,8 @@ declare const _default: import("vue").DefineComponent<{
         currentTarget: VwcDataGridRowElement;
     }) => any) | undefined;
 }, {
-    ariaSelected: string;
     gridTemplateColumns: string;
+    ariaSelected: string;
     rowType: "default" | "header" | "sticky-header";
 }, SlotsType<{
     /**

package/generated/components/VDatePicker.types.d.ts

@@ -81,11 +81,17 @@ export interface VDatePickerProps {
      */
     disabled?: boolean;
     /**
-     * The error text for the form element.
+     * Provides a custom error message. Any current error state will be overridden.
      */
     errorText?: string;
     /**
-     * The initial value of the date-picker.
+     * Provides additional information to help the user enter the correct information.
+     * To add HTML to the helper text, use the helper-text slot instead.
+     */
+    helperText?: string;
+    /**
+     * The default value of the element. This value sets the `value` property
+     * only when the `value` property has not been explicitly set.
      */
     initialValue?: string;
     /**
@@ -113,11 +119,11 @@ export interface VDatePickerProps {
      */
     required?: boolean;
     /**
-     * The current value of the date-picker.
+     * The current value of the element.
      */
     value?: string;
     /**
-     * The current value of the date-picker.
+     * The current value of the element.
      */
     modelValue?: string;
     /**

package/generated/components/VDatePicker.vue2.d.ts

@@ -12,14 +12,23 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * The error text for the form element.
+     * Provides a custom error message. Any current error state will be overridden.
      */
     errorText: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * The initial value of the date-picker.
+     * Provides additional information to help the user enter the correct information.
+     * To add HTML to the helper text, use the helper-text slot instead.
+     */
+    helperText: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * The default value of the element. This value sets the `value` property
+     * only when the `value` property has not been explicitly set.
      */
     initialValue: {
         type: PropType<string>;
@@ -68,14 +77,14 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * The current value of the date-picker.
+     * The current value of the element.
      */
     value: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * The current value of the date-picker.
+     * The current value of the element.
      */
     modelValue: {
         type: PropType<string>;
@@ -84,7 +93,17 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
 }, {
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcDatePickerElement | null>;
-}, import("vue").Data, {}, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, ("blur" | "change" | "click" | "focus" | "input" | "keydown" | "keyup" | "update:modelValue")[], string, Readonly<import("vue").ExtractPropTypes<{
+}, import("vue").Data, {}, {
+    /**
+     * Return the current validity of the element.
+     */
+    checkValidity(): boolean;
+    /**
+     * Return the current validity of the element.
+     * If false, fires an invalid event at the element.
+     */
+    reportValidity(): boolean;
+}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, ("blur" | "change" | "click" | "focus" | "input" | "keydown" | "keyup" | "update:modelValue")[], string, Readonly<import("vue").ExtractPropTypes<{
     /**
      * Sets the element's disabled state. A disabled element will not be included during form submission.
      */
@@ -93,14 +112,23 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * The error text for the form element.
+     * Provides a custom error message. Any current error state will be overridden.
      */
     errorText: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * The initial value of the date-picker.
+     * Provides additional information to help the user enter the correct information.
+     * To add HTML to the helper text, use the helper-text slot instead.
+     */
+    helperText: {
+        type: PropType<string>;
+        default: undefined;
+    };
+    /**
+     * The default value of the element. This value sets the `value` property
+     * only when the `value` property has not been explicitly set.
      */
     initialValue: {
         type: PropType<string>;
@@ -149,14 +177,14 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * The current value of the date-picker.
+     * The current value of the element.
      */
     value: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * The current value of the date-picker.
+     * The current value of the element.
      */
     modelValue: {
         type: PropType<string>;
@@ -171,6 +199,7 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
     required: boolean;
     modelValue: string;
     errorText: string;
+    helperText: string;
     readonly: boolean;
     max: string;
     min: string;