@vonage/vivid-vue 4.23.0 → 4.25.0

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

@@ -3,22 +3,14 @@ import type { VwcSwitchElement } from '@vonage/vivid';
 import type { SlotsType } from 'vue';
 declare const _default: import("vue").DefineComponent<{
     /**
-     * The current checkedness of the element. This property serves as a mechanism
-     * to set the `checked` property through both property assignment and the
-     * .setAttribute() method. This is useful for setting the field's checkedness
-     * in UI libraries that bind data through the .setAttribute() API
-     * and don't support IDL attribute binding.
+     * The current checkedness of the element.
      */
     checked: {
         type: PropType<boolean>;
         default: undefined;
     };
     /**
-     * The current checkedness of the element. This property serves as a mechanism
-     * to set the `checked` property through both property assignment and the
-     * .setAttribute() method. This is useful for setting the field's checkedness
-     * in UI libraries that bind data through the .setAttribute() API
-     * and don't support IDL attribute binding.
+     * The current checkedness of the element.
      */
     modelValue: {
         type: PropType<boolean>;
@@ -32,7 +24,8 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * Provides the default checkedness of the input element
+     * The default checkedness of the element. This value sets the `checked` property
+     * only when the `checked` property has not been explicitly set.
      */
     defaultChecked: {
         type: PropType<boolean>;
@@ -46,7 +39,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: {
@@ -82,11 +75,7 @@ declare const _default: import("vue").DefineComponent<{
         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>;
@@ -95,7 +84,17 @@ declare const _default: import("vue").DefineComponent<{
 }, {
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcSwitchElement | null>;
-}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+}, unknown, {}, {
+    /**
+     * 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").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     /**
      * Fires when the element loses focus.
      * @type {FocusEvent}
@@ -180,22 +179,14 @@ declare const _default: import("vue").DefineComponent<{
     "update:modelValue"(event: boolean): true;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     /**
-     * The current checkedness of the element. This property serves as a mechanism
-     * to set the `checked` property through both property assignment and the
-     * .setAttribute() method. This is useful for setting the field's checkedness
-     * in UI libraries that bind data through the .setAttribute() API
-     * and don't support IDL attribute binding.
+     * The current checkedness of the element.
      */
     checked: {
         type: PropType<boolean>;
         default: undefined;
     };
     /**
-     * The current checkedness of the element. This property serves as a mechanism
-     * to set the `checked` property through both property assignment and the
-     * .setAttribute() method. This is useful for setting the field's checkedness
-     * in UI libraries that bind data through the .setAttribute() API
-     * and don't support IDL attribute binding.
+     * The current checkedness of the element.
      */
     modelValue: {
         type: PropType<boolean>;
@@ -209,7 +200,8 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * Provides the default checkedness of the input element
+     * The default checkedness of the element. This value sets the `checked` property
+     * only when the `checked` property has not been explicitly set.
      */
     defaultChecked: {
         type: PropType<boolean>;
@@ -223,7 +215,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: {
@@ -259,11 +251,7 @@ declare const _default: import("vue").DefineComponent<{
         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>;

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

@@ -63,7 +63,6 @@ export interface VTabEvents {
     };
 }
 export interface VTabProps {
-    ariaSelected?: string;
     /**
      * The connotation the tab should have.
      */
@@ -86,7 +85,7 @@ export interface VTabProps {
      */
     label?: string;
     /**
-     * Indicates the tab's label.
+     * Adds a close button
      */
     removable?: boolean;
     /**

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

@@ -2,10 +2,6 @@ import { PropType } from 'vue';
 import { IconId } from '../icons';
 import type { VwcTabElement } from '@vonage/vivid';
 declare const _default: import("vue/types/v3-define-component").DefineComponent<{
-    ariaSelected: {
-        type: PropType<string>;
-        default: undefined;
-    };
     /**
      * The connotation the tab should have.
      */
@@ -43,7 +39,7 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * Indicates the tab's label.
+     * Adds a close button
      */
     removable: {
         type: PropType<boolean>;
@@ -67,10 +63,6 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
     _handleCloseClick(e: Event): unknown;
     _onKeyDown(e: KeyboardEvent): unknown;
 }, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, ("blur" | "click" | "focus" | "input" | "keydown" | "keyup")[], string, Readonly<import("vue").ExtractPropTypes<{
-    ariaSelected: {
-        type: PropType<string>;
-        default: undefined;
-    };
     /**
      * The connotation the tab should have.
      */
@@ -108,7 +100,7 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * Indicates the tab's label.
+     * Adds a close button
      */
     removable: {
         type: PropType<boolean>;
@@ -133,7 +125,6 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
     removable: boolean;
     disabled: boolean;
     label: string;
-    ariaSelected: string;
     tabIndex: number;
 }>;
 export default _default;

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

@@ -3,10 +3,6 @@ import { IconId } from '../icons';
 import type { VwcTabElement } from '@vonage/vivid';
 import type { SlotsType } from 'vue';
 declare const _default: import("vue").DefineComponent<{
-    ariaSelected: {
-        type: PropType<string>;
-        default: undefined;
-    };
     /**
      * The connotation the tab should have.
      */
@@ -44,7 +40,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * Indicates the tab's label.
+     * Adds a close button
      */
     removable: {
         type: PropType<boolean>;
@@ -135,10 +131,6 @@ declare const _default: import("vue").DefineComponent<{
         currentTarget: VwcTabElement;
     }): true;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    ariaSelected: {
-        type: PropType<string>;
-        default: undefined;
-    };
     /**
      * The connotation the tab should have.
      */
@@ -176,7 +168,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * Indicates the tab's label.
+     * Adds a close button
      */
     removable: {
         type: PropType<boolean>;
@@ -244,11 +236,10 @@ declare const _default: import("vue").DefineComponent<{
     removable: boolean;
     disabled: boolean;
     label: string;
-    ariaSelected: string;
     tabIndex: number;
 }, SlotsType<{
     /**
-     * Slot to add an icon to tab.
+     * The preferred way to add an icon to the component.
      */
     icon: Record<string, never>;
 }>>;

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

@@ -77,7 +77,7 @@ export interface VTabsProps {
      */
     activeid?: string;
     /**
-     * Whether or not to show the active indicator
+     * Deprecated attribute. It has no effect.
      */
     activeindicator?: boolean;
     /**

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

@@ -9,7 +9,7 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * Whether or not to show the active indicator
+     * Deprecated attribute. It has no effect.
      */
     activeindicator: {
         type: PropType<boolean>;
@@ -55,7 +55,8 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
     element: import("vue").Ref<VwcTabsElement | null>;
 }, import("vue").Data, {}, {
     /**
-     * The adjust method for FASTTabs
+     * Adjusts the active index by numerical increments.
+     * Only enabled tabs are considered.
      */
     adjust(adjustment: number): void;
 }, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, ("blur" | "change" | "click" | "focus" | "input" | "keydown" | "keyup")[], string, Readonly<import("vue").ExtractPropTypes<{
@@ -67,7 +68,7 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * Whether or not to show the active indicator
+     * Deprecated attribute. It has no effect.
      */
     activeindicator: {
         type: PropType<boolean>;

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

@@ -10,7 +10,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * Whether or not to show the active indicator
+     * Deprecated attribute. It has no effect.
      */
     activeindicator: {
         type: PropType<boolean>;
@@ -56,7 +56,8 @@ declare const _default: import("vue").DefineComponent<{
     element: import("vue").Ref<VwcTabsElement | null>;
 }, unknown, {}, {
     /**
-     * The adjust method for FASTTabs
+     * Adjusts the active index by numerical increments.
+     * Only enabled tabs are considered.
      */
     adjust(adjustment: number): void;
 }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
@@ -146,7 +147,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * Whether or not to show the active indicator
+     * Deprecated attribute. It has no effect.
      */
     activeindicator: {
         type: PropType<boolean>;

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

@@ -297,7 +297,7 @@ declare const _default: import("vue").DefineComponent<{
     selectable: boolean;
 }, SlotsType<{
     /**
-     * Add an icon to the component.
+     * The preferred way to add an icon to the component.
      */
     icon: Record<string, never>;
 }>>;

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

@@ -81,7 +81,7 @@ export interface VTextAreaProps {
      */
     autofocus?: boolean;
     /**
-     * Whether to show the character count.
+     * Use in combination with `maxlength` to display a character count.
      */
     charCount?: boolean;
     /**
@@ -93,7 +93,7 @@ export interface VTextAreaProps {
      */
     disabled?: boolean;
     /**
-     * The error text for the form element.
+     * Provides a custom error message. Any current error state will be overridden.
      */
     errorText?: string;
     /**
@@ -101,11 +101,12 @@ export interface VTextAreaProps {
      */
     form?: string;
     /**
-     * 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?: string;
     /**
-     * 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?: string;
@@ -126,7 +127,7 @@ export interface VTextAreaProps {
      */
     minlength?: number;
     /**
-     * The name of the element.
+     * The name of the element. This element's value will be surfaced during form submission under the provided name.
      */
     name?: string;
     /**
@@ -155,23 +156,15 @@ export interface VTextAreaProps {
      */
     spellcheck?: boolean;
     /**
-     * The success text for the form element.
+     * Provides a custom success message. Any current error state will be overridden.
      */
     successText?: string;
     /**
-     * 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?: string;
     /**
-     * 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?: string;
     /**

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

@@ -9,7 +9,7 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * Whether to show the character count.
+     * Use in combination with `maxlength` to display a character count.
      */
     charCount: {
         type: PropType<boolean>;
@@ -30,7 +30,7 @@ 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>;
@@ -44,14 +44,15 @@ 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>;
         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: {
@@ -87,7 +88,7 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * The name of the element.
+     * The name of the element. This element's value will be surfaced during form submission under the provided name.
      */
     name: {
         type: PropType<string>;
@@ -137,29 +138,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>;
@@ -176,6 +169,15 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcTextAreaElement | null>;
 }, 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;
     /**
      * Selects all the text in the text area
      */
@@ -193,7 +195,7 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * Whether to show the character count.
+     * Use in combination with `maxlength` to display a character count.
      */
     charCount: {
         type: PropType<boolean>;
@@ -214,7 +216,7 @@ 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>;
@@ -228,14 +230,15 @@ 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>;
         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: {
@@ -271,7 +274,7 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * The name of the element.
+     * The name of the element. This element's value will be surfaced during form submission under the provided name.
      */
     name: {
         type: PropType<string>;
@@ -321,29 +324,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>;
@@ -371,9 +366,9 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
     successText: string;
     list: string;
     placeholder: string;
-    charCount: boolean;
     maxlength: number;
     minlength: number;
+    charCount: boolean;
     cols: number;
     readOnly: boolean;
     resize: "none" | "both" | "horizontal" | "vertical";