@vonage/vivid-vue 4.23.0 → 4.25.0

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

@@ -13,14 +13,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>;
@@ -69,14 +78,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>;
@@ -85,7 +94,17 @@ declare const _default: import("vue").DefineComponent<{
 }, {
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcDatePickerElement | 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}
@@ -177,14 +196,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>;
@@ -233,14 +261,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>;
@@ -306,6 +334,7 @@ declare const _default: import("vue").DefineComponent<{
     required: boolean;
     modelValue: string;
     errorText: string;
+    helperText: string;
     readonly: boolean;
     max: string;
     min: string;

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

@@ -113,9 +113,14 @@ export interface VDateRangePickerProps {
      */
     end?: string;
     /**
-     * The error text for the form element.
+     * Provides a custom error message. Any current error state will be overridden.
      */
     errorText?: string;
+    /**
+     * 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 end value. This value sets the `end` property
      * only when the `end` property has not been explicitly set.
@@ -127,7 +132,8 @@ export interface VDateRangePickerProps {
      */
     initialStart?: string;
     /**
-     * The initial value of the date-picker.
+     * The default value of the element. This value sets the `value` property
+     * only when the `value` property has not been explicitly set.
      */
     initialValue?: string;
     /**
@@ -163,7 +169,7 @@ export interface VDateRangePickerProps {
      */
     start?: string;
     /**
-     * The current value of the date-picker.
+     * The current value of the element.
      */
     value?: string;
     /**

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

@@ -20,12 +20,20 @@ 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;
     };
+    /**
+     * 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 end value. This value sets the `end` property
      * only when the `end` property has not been explicitly set.
@@ -43,7 +51,8 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * The initial value of the date-picker.
+     * 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>;
@@ -103,7 +112,7 @@ 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>;
@@ -112,7 +121,17 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
 }, {
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcDateRangePickerElement | 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" | "input:end" | "input:start" | "update:end" | "update:start")[], 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" | "input:end" | "input:start" | "update:end" | "update:start")[], string, Readonly<import("vue").ExtractPropTypes<{
     /**
      * Sets the element's disabled state. A disabled element will not be included during form submission.
      */
@@ -132,12 +151,20 @@ 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;
     };
+    /**
+     * 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 end value. This value sets the `end` property
      * only when the `end` property has not been explicitly set.
@@ -155,7 +182,8 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * The initial value of the date-picker.
+     * 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>;
@@ -215,7 +243,7 @@ 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>;
@@ -230,6 +258,7 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
     required: boolean;
     start: string;
     errorText: string;
+    helperText: string;
     readonly: boolean;
     max: string;
     min: string;

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

@@ -21,12 +21,20 @@ 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;
     };
+    /**
+     * 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 end value. This value sets the `end` property
      * only when the `end` property has not been explicitly set.
@@ -44,7 +52,8 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * The initial value of the date-picker.
+     * 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>;
@@ -104,7 +113,7 @@ 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>;
@@ -113,7 +122,17 @@ declare const _default: import("vue").DefineComponent<{
 }, {
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcDateRangePickerElement | 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}
@@ -243,12 +262,20 @@ 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;
     };
+    /**
+     * 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 end value. This value sets the `end` property
      * only when the `end` property has not been explicitly set.
@@ -266,7 +293,8 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * The initial value of the date-picker.
+     * 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>;
@@ -326,7 +354,7 @@ 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>;
@@ -407,6 +435,7 @@ declare const _default: import("vue").DefineComponent<{
     required: boolean;
     start: string;
     errorText: string;
+    helperText: string;
     readonly: boolean;
     max: string;
     min: string;

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

@@ -85,11 +85,17 @@ export interface VDateTimePickerProps {
      */
     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;
     /**
@@ -141,11 +147,11 @@ export interface VDateTimePickerProps {
      */
     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/VDateTimePicker.vue2.d.ts

@@ -19,14 +19,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>;
@@ -117,14 +126,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>;
@@ -133,7 +142,17 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
 }, {
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcDateTimePickerElement | 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.
      */
@@ -149,14 +168,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>;
@@ -247,14 +275,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>;
@@ -269,6 +297,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/VDateTimePicker.vue3.d.ts

@@ -20,14 +20,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>;
@@ -118,14 +127,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>;
@@ -134,7 +143,17 @@ declare const _default: import("vue").DefineComponent<{
 }, {
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcDateTimePickerElement | 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}
@@ -233,14 +252,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>;
@@ -331,14 +359,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>;
@@ -404,6 +432,7 @@ declare const _default: import("vue").DefineComponent<{
     required: boolean;
     modelValue: string;
     errorText: string;
+    helperText: string;
     readonly: boolean;
     max: string;
     min: string;

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

@@ -106,6 +106,10 @@ export interface VDialPadEvents {
     'update:modelValue': string;
 }
 export interface VDialPadProps {
+    /**
+     * Indicates that this element should get focus after the page finishes loading.
+     */
+    autofocus?: boolean;
     /**
      * Indicates the active state of the dial-pad.
      */

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

@@ -4,6 +4,13 @@ import type { VwcDialPadElement } from '@vonage/vivid';
  * Base class for dial-pad
  */
 declare const _default: import("vue/types/v3-define-component").DefineComponent<{
+    /**
+     * Indicates that this element should get focus after the page finishes loading.
+     */
+    autofocus: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
     /**
      * Indicates the active state of the dial-pad.
      */
@@ -86,8 +93,19 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcDialPadElement | null>;
 }, import("vue").Data, {}, {
+    /**
+     * Moves focus into the diapl-pad.
+     */
+    focus(): void;
     valueChanged(_oldValue: string, newValue: string): unknown;
 }, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, ("blur" | "change" | "click" | "focus" | "input" | "keydown" | "keyup" | "update:modelValue" | "dial" | "end-call" | "keypad-click")[], string, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Indicates that this element should get focus after the page finishes loading.
+     */
+    autofocus: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
     /**
      * Indicates the active state of the dial-pad.
      */
@@ -169,6 +187,7 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
 }>>, {
     value: string;
     disabled: boolean;
+    autofocus: boolean;
     pending: boolean;
     modelValue: string;
     helperText: string;