@vonage/vivid-vue 4.23.0 → 4.25.0

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

@@ -18,7 +18,7 @@ declare const _default: import("vue").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>;
@@ -32,7 +32,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: {
@@ -118,29 +119,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,8 +143,16 @@ declare const _default: import("vue").DefineComponent<{
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcSelectElement | null>;
 }, unknown, {}, {
+    /**
+     * Return the current validity of the element.
+     */
+    checkValidity(): boolean;
     formResetCallback(): unknown;
-    labelChanged(): unknown;
+    /**
+     * 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.
      */
@@ -261,7 +262,7 @@ declare const _default: import("vue").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>;
@@ -275,7 +276,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>;
@@ -297,7 +299,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: {
@@ -361,29 +363,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>;
@@ -470,7 +464,7 @@ declare const _default: import("vue").DefineComponent<{
      */
     'helper-text': Record<string, never>;
     /**
-     * Slot to add an icon to the select control.
+     * The preferred way to add an icon to the select control.
      */
     icon: Record<string, never>;
     /**

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

@@ -76,9 +76,6 @@ export interface VSelectableBoxProps {
      * Controls the checked state of the box
      */
     checked?: boolean;
-    /**
-     * DEPRECATED: Replaced by the clickable-box prop
-     */
     clickable?: boolean;
     /**
      * Makes the entire selectable box clickable

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

@@ -8,9 +8,6 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         type: PropType<boolean>;
         default: undefined;
     };
-    /**
-     * DEPRECATED: Replaced by the clickable-box prop
-     */
     clickable: {
         type: PropType<boolean>;
         default: undefined;
@@ -54,9 +51,6 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         type: PropType<boolean>;
         default: undefined;
     };
-    /**
-     * DEPRECATED: Replaced by the clickable-box prop
-     */
     clickable: {
         type: PropType<boolean>;
         default: undefined;
@@ -93,8 +87,8 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
     tight: boolean;
     connotation: "accent" | "cta";
     checked: boolean;
+    controlType: "checkbox" | "radio";
     clickable: boolean;
     clickableBox: boolean;
-    controlType: "checkbox" | "radio";
 }>;
 export default _default;

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

@@ -9,9 +9,6 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: undefined;
     };
-    /**
-     * DEPRECATED: Replaced by the clickable-box prop
-     */
     clickable: {
         type: PropType<boolean>;
         default: undefined;
@@ -133,9 +130,6 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: undefined;
     };
-    /**
-     * DEPRECATED: Replaced by the clickable-box prop
-     */
     clickable: {
         type: PropType<boolean>;
         default: undefined;
@@ -222,9 +216,9 @@ declare const _default: import("vue").DefineComponent<{
     tight: boolean;
     connotation: "accent" | "cta";
     checked: boolean;
+    controlType: "checkbox" | "radio";
     clickable: boolean;
     clickableBox: boolean;
-    controlType: "checkbox" | "radio";
 }, SlotsType<{
     /**
      * Slot for box's content.

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

@@ -85,7 +85,7 @@ export interface VSliderProps {
      */
     disabled?: boolean;
     /**
-     * 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;
@@ -130,19 +130,11 @@ export interface VSliderProps {
      */
     step?: number;
     /**
-     * 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/VSlider.vue2.d.ts

@@ -16,7 +16,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: {
@@ -94,22 +94,14 @@ declare const _default: import("vue/types/v3-define-component").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>;
         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>;
@@ -119,6 +111,10 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcSliderElement | null>;
 }, import("vue").Data, {}, {
+    /**
+     * Return the current validity of the element.
+     */
+    checkValidity(): boolean;
     /**
      * Decrement the value by the step
      */
@@ -127,6 +123,11 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
      * Increment the value by the step
      */
     increment(): void;
+    /**
+     * Return the current validity of the element.
+     * If false, fires an invalid event at the element.
+     */
+    reportValidity(): boolean;
     /**
      * Places the thumb based on the current value
      */
@@ -147,7 +148,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: {
@@ -225,22 +226,14 @@ declare const _default: import("vue/types/v3-define-component").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>;
         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/VSlider.vue3.d.ts

@@ -17,7 +17,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: {
@@ -95,22 +95,14 @@ 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>;
         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>;
@@ -120,6 +112,10 @@ declare const _default: import("vue").DefineComponent<{
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcSliderElement | null>;
 }, unknown, {}, {
+    /**
+     * Return the current validity of the element.
+     */
+    checkValidity(): boolean;
     /**
      * Decrement the value by the step
      */
@@ -128,6 +124,11 @@ declare const _default: import("vue").DefineComponent<{
      * Increment the value by the step
      */
     increment(): void;
+    /**
+     * Return the current validity of the element.
+     * If false, fires an invalid event at the element.
+     */
+    reportValidity(): boolean;
     /**
      * Places the thumb based on the current value
      */
@@ -231,7 +232,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: {
@@ -309,22 +310,14 @@ 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>;
         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/VSplitButton.vue3.d.ts

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

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

@@ -77,19 +77,11 @@ export interface VSwitchEvents {
 }
 export interface VSwitchProps {
     /**
-     * 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?: boolean;
     /**
-     * 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?: boolean;
     /**
@@ -97,7 +89,8 @@ export interface VSwitchProps {
      */
     connotation?: 'accent' | 'alert' | 'announcement' | 'success' | 'cta';
     /**
-     * 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?: boolean;
     /**
@@ -105,7 +98,7 @@ export interface VSwitchProps {
      */
     disabled?: boolean;
     /**
-     * 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,11 +119,7 @@ export interface VSwitchProps {
      */
     required?: boolean;
     /**
-     * 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;
     /**

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

@@ -2,22 +2,14 @@ import { PropType } from 'vue';
 import type { VwcSwitchElement } from '@vonage/vivid';
 declare const _default: import("vue/types/v3-define-component").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>;
@@ -31,7 +23,8 @@ declare const _default: import("vue/types/v3-define-component").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>;
@@ -45,7 +38,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: {
@@ -81,11 +74,7 @@ declare const _default: import("vue/types/v3-define-component").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>;
@@ -94,24 +83,26 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
 }, {
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcSwitchElement | 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, {}, {
     /**
-     * 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.
+     * 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<{
+    /**
+     * 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>;
@@ -125,7 +116,8 @@ declare const _default: import("vue/types/v3-define-component").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>;
@@ -139,7 +131,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: {
@@ -175,11 +167,7 @@ declare const _default: import("vue/types/v3-define-component").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>;