@vonage/vivid-vue 4.23.0 → 4.25.0

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

@@ -83,21 +83,18 @@ export interface VNumberFieldProps {
      * Indicates that this element should get focus after the page finishes loading. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefautofocus | autofocus HTML attribute for more information.
      */
     autofocus?: boolean;
-    /**
-     * Whether to show the character count.
-     */
-    charCount?: boolean;
     decrementButtonAriaLabel?: string;
     /**
      * Sets the element's disabled state. A disabled element will not be included during form submission.
      */
     disabled?: boolean;
     /**
-     * The error text for the form element.
+     * Provides a custom error message. Any current error state will be overridden.
      */
     errorText?: 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;
     /**
@@ -107,7 +104,7 @@ export interface VNumberFieldProps {
     icon?: IconId;
     incrementButtonAriaLabel?: 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;
@@ -165,23 +162,15 @@ export interface VNumberFieldProps {
      */
     step?: number;
     /**
-     * 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/VNumberField.vue2.d.ts

@@ -17,13 +17,6 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         type: PropType<boolean>;
         default: undefined;
     };
-    /**
-     * Whether to show the character count.
-     */
-    charCount: {
-        type: PropType<boolean>;
-        default: undefined;
-    };
     decrementButtonAriaLabel: {
         type: PropType<string>;
         default: undefined;
@@ -36,14 +29,15 @@ 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 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>;
@@ -62,7 +56,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: {
@@ -165,29 +159,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>;
@@ -197,6 +183,15 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcNumberFieldElement | 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 number field
      */
@@ -230,13 +225,6 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         type: PropType<boolean>;
         default: undefined;
     };
-    /**
-     * Whether to show the character count.
-     */
-    charCount: {
-        type: PropType<boolean>;
-        default: undefined;
-    };
     decrementButtonAriaLabel: {
         type: PropType<string>;
         default: undefined;
@@ -249,14 +237,15 @@ 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 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>;
@@ -275,7 +264,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: {
@@ -378,29 +367,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>;
@@ -429,7 +410,6 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
     max: number;
     min: number;
     autoComplete: string;
-    charCount: boolean;
     decrementButtonAriaLabel: string;
     incrementButtonAriaLabel: string;
     maxlength: number;

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

@@ -18,13 +18,6 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: undefined;
     };
-    /**
-     * Whether to show the character count.
-     */
-    charCount: {
-        type: PropType<boolean>;
-        default: undefined;
-    };
     decrementButtonAriaLabel: {
         type: PropType<string>;
         default: undefined;
@@ -37,14 +30,15 @@ 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>;
         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>;
@@ -63,7 +57,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: {
@@ -166,29 +160,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>;
@@ -198,6 +184,15 @@ declare const _default: import("vue").DefineComponent<{
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcNumberFieldElement | null>;
 }, 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;
     /**
      * Selects all the text in the number field
      */
@@ -314,13 +309,6 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: undefined;
     };
-    /**
-     * Whether to show the character count.
-     */
-    charCount: {
-        type: PropType<boolean>;
-        default: undefined;
-    };
     decrementButtonAriaLabel: {
         type: PropType<string>;
         default: undefined;
@@ -333,14 +321,15 @@ 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>;
         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>;
@@ -359,7 +348,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: {
@@ -462,29 +451,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>;
@@ -564,7 +545,6 @@ declare const _default: import("vue").DefineComponent<{
     max: number;
     min: number;
     autoComplete: string;
-    charCount: boolean;
     decrementButtonAriaLabel: string;
     incrementButtonAriaLabel: string;
     maxlength: number;

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

@@ -268,7 +268,7 @@ declare const _default: import("vue").DefineComponent<{
     tagConnotation: "accent" | "cta";
 }, SlotsType<{
     /**
-     * Slot to add an icon to the option.
+     * The preferred way to add an icon to the component.
      */
     icon: Record<string, never>;
 }>>;

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

@@ -79,7 +79,7 @@ export interface VProgressRingProps {
     /**
      * The value of the progress
      */
-    value?: boolean;
+    value?: number;
     /**
      * Fires when the element loses focus.
      */

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

@@ -34,7 +34,7 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
      * The value of the progress
      */
     value: {
-        type: PropType<boolean>;
+        type: PropType<number>;
         default: undefined;
     };
 }, {
@@ -74,11 +74,11 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
      * The value of the progress
      */
     value: {
-        type: PropType<boolean>;
+        type: PropType<number>;
         default: undefined;
     };
 }>>, {
-    value: boolean;
+    value: number;
     size: 0 | 1 | 2 | -1 | 3 | 4 | 5 | -6 | -5 | -4 | -3 | -2;
     connotation: "accent" | "success" | "alert" | "cta";
     max: number;

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

@@ -35,7 +35,7 @@ declare const _default: import("vue").DefineComponent<{
      * The value of the progress
      */
     value: {
-        type: PropType<boolean>;
+        type: PropType<number>;
         default: undefined;
     };
 }, {
@@ -142,7 +142,7 @@ declare const _default: import("vue").DefineComponent<{
      * The value of the progress
      */
     value: {
-        type: PropType<boolean>;
+        type: PropType<number>;
         default: undefined;
     };
 }>> & {
@@ -189,7 +189,7 @@ declare const _default: import("vue").DefineComponent<{
         currentTarget: VwcProgressRingElement;
     }) => any) | undefined;
 }, {
-    value: boolean;
+    value: number;
     size: 0 | 1 | 2 | -1 | 3 | 4 | 5 | -6 | -5 | -4 | -3 | -2;
     connotation: "accent" | "success" | "alert" | "cta";
     max: number;

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

@@ -74,11 +74,7 @@ export interface VRadioEvents {
 export interface VRadioProps {
     ariaLabel?: string;
     /**
-     * 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;
     /**
@@ -86,7 +82,8 @@ export interface VRadioProps {
      */
     connotation?: 'accent' | '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;
     /**
@@ -94,16 +91,20 @@ export interface VRadioProps {
      */
     disabled?: boolean;
     /**
-     * The initial value of the form. This value sets the `value` property
+     * Provides a custom error message. Any current error state will be overridden.
+     */
+    errorText?: 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;
     /**
-     * Indicates the radio's label.
+     * The label for the form element.
      */
     label?: string;
     /**
-     * The name of the radio. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname | name attribute for more info.
+     * The name of the element. This element's value will be surfaced during form submission under the provided name.
      */
     name?: string;
     /**
@@ -115,11 +116,7 @@ export interface VRadioProps {
      */
     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;
     /**