@vonage/vivid-vue 4.23.0 → 4.25.0

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

@@ -6,11 +6,7 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         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.
      */
     checked: {
         type: PropType<boolean>;
@@ -24,7 +20,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>;
@@ -38,7 +35,14 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * 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: {
+        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: {
@@ -46,14 +50,14 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * Indicates the radio's label.
+     * The label for the form element.
      */
     label: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * 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: {
         type: PropType<string>;
@@ -74,11 +78,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>;
@@ -87,17 +87,23 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
 }, {
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcRadioElement | 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")[], 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")[], string, Readonly<import("vue").ExtractPropTypes<{
     ariaLabel: {
         type: PropType<string>;
         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.
      */
     checked: {
         type: PropType<boolean>;
@@ -111,7 +117,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>;
@@ -125,7 +132,14 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * 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: {
+        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: {
@@ -133,14 +147,14 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         default: undefined;
     };
     /**
-     * Indicates the radio's label.
+     * The label for the form element.
      */
     label: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * 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: {
         type: PropType<string>;
@@ -161,11 +175,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>;
@@ -181,6 +191,7 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
     required: boolean;
     checked: boolean;
     defaultChecked: boolean;
+    errorText: string;
     readonly: boolean;
     ariaLabel: string;
 }>;

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

@@ -7,11 +7,7 @@ declare const _default: import("vue").DefineComponent<{
         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.
      */
     checked: {
         type: PropType<boolean>;
@@ -25,7 +21,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>;
@@ -39,7 +36,14 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * 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: {
+        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: {
@@ -47,14 +51,14 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * Indicates the radio's label.
+     * The label for the form element.
      */
     label: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * 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: {
         type: PropType<string>;
@@ -75,11 +79,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>;
@@ -88,7 +88,17 @@ declare const _default: import("vue").DefineComponent<{
 }, {
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcRadioElement | 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}
@@ -172,11 +182,7 @@ declare const _default: import("vue").DefineComponent<{
         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.
      */
     checked: {
         type: PropType<boolean>;
@@ -190,7 +196,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>;
@@ -204,7 +211,14 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * 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: {
+        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: {
@@ -212,14 +226,14 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * Indicates the radio's label.
+     * The label for the form element.
      */
     label: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * 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: {
         type: PropType<string>;
@@ -240,11 +254,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>;
@@ -310,6 +320,7 @@ declare const _default: import("vue").DefineComponent<{
     required: boolean;
     checked: boolean;
     defaultChecked: boolean;
+    errorText: string;
     readonly: boolean;
     ariaLabel: string;
 }, SlotsType<Record<string, never>>>;

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

@@ -80,8 +80,14 @@ export interface VRadioGroupProps {
      * Disables the radio group and child radios.
      */
     disabled?: boolean;
+    errorText?: string;
     /**
-     * Indicates the group's label.
+     * 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 label for the radio group
      */
     label?: string;
     /**
@@ -97,6 +103,10 @@ export interface VRadioGroupProps {
      * When true, the child radios will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information.
      */
     readonly?: boolean;
+    /**
+     * When true, the radio group and all its radio buttons will be required
+     */
+    required?: boolean;
     /**
      * The value of the checked radio
      */

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

@@ -8,8 +8,20 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         type: PropType<boolean>;
         default: undefined;
     };
+    errorText: {
+        type: PropType<string>;
+        default: undefined;
+    };
     /**
-     * Indicates the group's label.
+     * 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 label for the radio group
      */
     label: {
         type: PropType<string>;
@@ -37,6 +49,13 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         type: PropType<boolean>;
         default: undefined;
     };
+    /**
+     * When true, the radio group and all its radio buttons will be required
+     */
+    required: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
     /**
      * The value of the checked radio
      */
@@ -64,8 +83,20 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         type: PropType<boolean>;
         default: undefined;
     };
+    errorText: {
+        type: PropType<string>;
+        default: undefined;
+    };
     /**
-     * Indicates the group's label.
+     * 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 label for the radio group
      */
     label: {
         type: PropType<string>;
@@ -93,6 +124,13 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
         type: PropType<boolean>;
         default: undefined;
     };
+    /**
+     * When true, the radio group and all its radio buttons will be required
+     */
+    required: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
     /**
      * The value of the checked radio
      */
@@ -112,7 +150,10 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
     value: string;
     disabled: boolean;
     label: string;
+    required: boolean;
     modelValue: string;
+    errorText: string;
+    helperText: string;
     readonly: boolean;
     orientation: "horizontal" | "vertical";
 }>;

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

@@ -9,8 +9,20 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: undefined;
     };
+    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;
+    };
     /**
-     * Indicates the group's label.
+     * The label for the radio group
      */
     label: {
         type: PropType<string>;
@@ -38,6 +50,13 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: undefined;
     };
+    /**
+     * When true, the radio group and all its radio buttons will be required
+     */
+    required: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
     /**
      * The value of the checked radio
      */
@@ -148,8 +167,20 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: undefined;
     };
+    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;
+    };
     /**
-     * Indicates the group's label.
+     * The label for the radio group
      */
     label: {
         type: PropType<string>;
@@ -177,6 +208,13 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: undefined;
     };
+    /**
+     * When true, the radio group and all its radio buttons will be required
+     */
+    required: {
+        type: PropType<boolean>;
+        default: undefined;
+    };
     /**
      * The value of the checked radio
      */
@@ -247,7 +285,10 @@ declare const _default: import("vue").DefineComponent<{
     value: string;
     disabled: boolean;
     label: string;
+    required: boolean;
     modelValue: string;
+    errorText: string;
+    helperText: string;
     readonly: boolean;
     orientation: "horizontal" | "vertical";
 }, SlotsType<{
@@ -255,5 +296,9 @@ declare const _default: import("vue").DefineComponent<{
      * Default slot.
      */
     default: Record<string, never>;
+    /**
+     * Describes how to use the text-field. Alternative to the `helper-text` attribute.
+     */
+    'helper-text': Record<string, never>;
 }>>;
 export default _default;

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

@@ -135,7 +135,7 @@ export interface VRangeSliderProps {
      */
     initialStart?: 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;
@@ -184,11 +184,7 @@ export interface VRangeSliderProps {
      */
     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;
     /**

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

@@ -60,7 +60,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: {
@@ -142,11 +142,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>;
@@ -156,7 +152,16 @@ declare const _default: import("vue/types/v3-define-component").DefineComponent<
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcRangeSliderElement | null>;
 }, import("vue").Data, {}, {
+    /**
+     * Return the current validity of the element.
+     */
+    checkValidity(): boolean;
     formResetCallback(): unknown;
+    /**
+     * 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<{
     /**
      * Aria label for the end thumb
@@ -214,7 +219,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: {
@@ -296,11 +301,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>;

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

@@ -61,7 +61,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: {
@@ -143,11 +143,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>;
@@ -157,7 +153,16 @@ declare const _default: import("vue").DefineComponent<{
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<VwcRangeSliderElement | null>;
 }, unknown, {}, {
+    /**
+     * Return the current validity of the element.
+     */
+    checkValidity(): boolean;
     formResetCallback(): unknown;
+    /**
+     * 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.
@@ -325,7 +330,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: {
@@ -407,11 +412,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>;