@vonage/vivid-vue 4.24.0 → 4.26.0

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

@@ -22,7 +22,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * Whether to show the character count.
+     * Use in combination with `maxlength` to display a character count.
      */
     charCount: {
         type: PropType<boolean>;
@@ -36,14 +36,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>;
@@ -58,7 +59,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: {
@@ -162,7 +163,7 @@ 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>;
@@ -176,22 +177,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>;
@@ -201,7 +194,16 @@ declare const _default: import("vue").DefineComponent<{
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcTextFieldElement | null>;
 }, unknown, {}, {
+    /**
+     * Return the current validity of the element.
+     */
+    checkValidity(): boolean;
     focus(): unknown;
+    /**
+     * 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 field
      */
@@ -310,7 +312,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * Whether to show the character count.
+     * Use in combination with `maxlength` to display a character count.
      */
     charCount: {
         type: PropType<boolean>;
@@ -324,14 +326,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>;
@@ -346,7 +349,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: {
@@ -450,7 +453,7 @@ 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>;
@@ -464,22 +467,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>;
@@ -559,9 +554,9 @@ declare const _default: import("vue").DefineComponent<{
     scale: "condensed" | "normal";
     pattern: string;
     autoComplete: string;
-    charCount: boolean;
     maxlength: number;
     minlength: number;
+    charCount: boolean;
     spellcheck: boolean;
     inputmode: string;
 }, SlotsType<{

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

@@ -85,11 +85,17 @@ export interface VTimePickerProps {
      */
     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;
     /**
@@ -125,11 +131,11 @@ export interface VTimePickerProps {
      */
     secondsStep?: number;
     /**
-     * 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/VTimePicker.vue2.d.ts

@@ -16,14 +16,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>;
@@ -86,14 +95,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>;
@@ -102,7 +111,17 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
 }, {
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcTimePickerElement | 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<{
     /**
      * Forces a 12h or 24h clock to be used.
      */
@@ -118,14 +137,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>;
@@ -188,14 +216,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>;
@@ -210,6 +238,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;

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

@@ -17,14 +17,23 @@ 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 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>;
@@ -87,14 +96,14 @@ declare const _default: import("vue").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>;
@@ -103,7 +112,17 @@ declare const _default: import("vue").DefineComponent<{
 }, {
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcTimePickerElement | 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}
@@ -202,14 +221,23 @@ 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 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>;
@@ -272,14 +300,14 @@ declare const _default: import("vue").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>;
@@ -345,6 +373,7 @@ declare const _default: import("vue").DefineComponent<{
     required: boolean;
     modelValue: string;
     errorText: string;
+    helperText: string;
     readonly: boolean;
     max: string;
     min: string;

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

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