@vonage/vivid-vue 4.16.2 → 4.18.0

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

@@ -3,38 +3,46 @@ import type { Checkbox } from '@vonage/vivid/lib/checkbox/checkbox';
 import type { SlotsType } from 'vue';
 declare const _default: import("vue").DefineComponent<{
     /**
-     * The success text for the form element.
+     * Indicates the element that represents the current item within a container or set of related elements.
      */
-    successText: {
-        type: PropType<string>;
+    ariaCurrent: {
+        type: PropType<"page" | "step" | "location" | "date" | "time" | "true" | "false">;
         default: undefined;
     };
     /**
-     * The error text for the form element.
+     * 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.
      */
-    errorText: {
-        type: PropType<string>;
+    checked: {
+        type: PropType<boolean>;
         default: undefined;
     };
     /**
-     * The helper text for the form element.
+     * 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.
      */
-    helperText: {
-        type: PropType<string>;
+    modelValue: {
+        type: PropType<boolean>;
         default: undefined;
     };
     /**
-     * The label for the form element.
+     * The connotation the checklist should have.
      */
-    label: {
-        type: PropType<string>;
+    connotation: {
+        type: PropType<"accent" | "cta">;
         default: undefined;
     };
     /**
-     * Indicates the element that represents the current item within a container or set of related elements.
+     * Provides the default checkedness of the input element
      */
-    ariaCurrent: {
-        type: PropType<"page" | "step" | "location" | "date" | "time" | "true" | "false">;
+    defaultChecked: {
+        type: PropType<boolean>;
         default: undefined;
     };
     /**
@@ -45,68 +53,59 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * The initial value of the form. This value sets the `value` property
-     * only when the `value` property has not been explicitly set.
+     * The error text for the form element.
      */
-    initialValue: {
+    errorText: {
         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 helper text for the form element.
      */
-    value: {
+    helperText: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * The name of the element. This element's value will be surfaced during form submission under the provided name.
+     * The initial value of the form. This value sets the `value` property
+     * only when the `value` property has not been explicitly set.
      */
-    name: {
+    initialValue: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * Require the field to be completed prior to form submission.
+     * The label for the form element.
      */
-    required: {
-        type: PropType<boolean>;
+    label: {
+        type: PropType<string>;
         default: undefined;
     };
     /**
-     * Provides the default checkedness of the input element
+     * The name of the element. This element's value will be surfaced during form submission under the provided name.
      */
-    defaultChecked: {
-        type: PropType<boolean>;
+    name: {
+        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.
+     * When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information.
      */
-    checked: {
+    readonly: {
         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.
+     * Require the field to be completed prior to form submission.
      */
-    modelValue: {
+    required: {
         type: PropType<boolean>;
         default: undefined;
     };
-    ariaLabel: {
+    /**
+     * The success text for the form element.
+     */
+    successText: {
         type: PropType<string>;
         default: undefined;
     };
@@ -115,24 +114,14 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * The connotation the checklist should have.
-     */
-    connotation: {
-        type: PropType<"accent" | "cta">;
-        default: undefined;
-    };
-    /**
-     * The current checkbox state
-     */
-    ariaChecked: {
-        type: PropType<"true" | "false" | "mixed" | "undefined">;
-        default: undefined;
-    };
-    /**
-     * When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information.
+     * 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.
      */
-    readonly: {
-        type: PropType<boolean>;
+    value: {
+        type: PropType<string>;
         default: undefined;
     };
 }, {
@@ -141,6 +130,20 @@ declare const _default: import("vue").DefineComponent<{
 }, unknown, {}, {
     ariaCheckedChanged(): unknown;
 }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    /**
+     * Fires when the element loses focus.
+     * @type {FocusEvent}
+     */
+    blur(event: FocusEvent & {
+        target: Checkbox;
+    }): true;
+    /**
+     * Emitted when the checked state changes.
+     * @type {CustomEvent<undefined>}
+     */
+    change(event: CustomEvent<undefined> & {
+        target: Checkbox;
+    }): true;
     /**
      * Fires when a pointing device button (such as a mouse's primary mouse button) is both pressed and released while the pointer is located inside the element.
      * @type {MouseEvent}
@@ -156,10 +159,10 @@ declare const _default: import("vue").DefineComponent<{
         target: Checkbox;
     }): true;
     /**
-     * Fires when the element loses focus.
-     * @type {FocusEvent}
+     * Emitted when the checked state changes.
+     * @type {CustomEvent<undefined>}
      */
-    blur(event: FocusEvent & {
+    input(event: CustomEvent<undefined> & {
         target: Checkbox;
     }): true;
     /**
@@ -176,20 +179,6 @@ declare const _default: import("vue").DefineComponent<{
     keyup(event: KeyboardEvent & {
         target: Checkbox;
     }): true;
-    /**
-     * Emitted when the checked state changes.
-     * @type {CustomEvent<undefined>}
-     */
-    change(event: CustomEvent<undefined> & {
-        target: Checkbox;
-    }): true;
-    /**
-     * Emitted when the checked state changes.
-     * @type {CustomEvent<undefined>}
-     */
-    input(event: CustomEvent<undefined> & {
-        target: Checkbox;
-    }): true;
     /**
      * Fires when the modelValue value changes
      * @type {boolean}
@@ -199,38 +188,46 @@ declare const _default: import("vue").DefineComponent<{
     }): true;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     /**
-     * The success text for the form element.
+     * Indicates the element that represents the current item within a container or set of related elements.
      */
-    successText: {
-        type: PropType<string>;
+    ariaCurrent: {
+        type: PropType<"page" | "step" | "location" | "date" | "time" | "true" | "false">;
         default: undefined;
     };
     /**
-     * The error text for the form element.
+     * 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.
      */
-    errorText: {
-        type: PropType<string>;
+    checked: {
+        type: PropType<boolean>;
         default: undefined;
     };
     /**
-     * The helper text for the form element.
+     * 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.
      */
-    helperText: {
-        type: PropType<string>;
+    modelValue: {
+        type: PropType<boolean>;
         default: undefined;
     };
     /**
-     * The label for the form element.
+     * The connotation the checklist should have.
      */
-    label: {
-        type: PropType<string>;
+    connotation: {
+        type: PropType<"accent" | "cta">;
         default: undefined;
     };
     /**
-     * Indicates the element that represents the current item within a container or set of related elements.
+     * Provides the default checkedness of the input element
      */
-    ariaCurrent: {
-        type: PropType<"page" | "step" | "location" | "date" | "time" | "true" | "false">;
+    defaultChecked: {
+        type: PropType<boolean>;
         default: undefined;
     };
     /**
@@ -241,68 +238,59 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * The initial value of the form. This value sets the `value` property
-     * only when the `value` property has not been explicitly set.
+     * The error text for the form element.
      */
-    initialValue: {
+    errorText: {
         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 helper text for the form element.
      */
-    value: {
+    helperText: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * The name of the element. This element's value will be surfaced during form submission under the provided name.
+     * The initial value of the form. This value sets the `value` property
+     * only when the `value` property has not been explicitly set.
      */
-    name: {
+    initialValue: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * Require the field to be completed prior to form submission.
+     * The label for the form element.
      */
-    required: {
-        type: PropType<boolean>;
+    label: {
+        type: PropType<string>;
         default: undefined;
     };
     /**
-     * Provides the default checkedness of the input element
+     * The name of the element. This element's value will be surfaced during form submission under the provided name.
      */
-    defaultChecked: {
-        type: PropType<boolean>;
+    name: {
+        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.
+     * When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information.
      */
-    checked: {
+    readonly: {
         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.
+     * Require the field to be completed prior to form submission.
      */
-    modelValue: {
+    required: {
         type: PropType<boolean>;
         default: undefined;
     };
-    ariaLabel: {
+    /**
+     * The success text for the form element.
+     */
+    successText: {
         type: PropType<string>;
         default: undefined;
     };
@@ -311,46 +299,36 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * The connotation the checklist should have.
-     */
-    connotation: {
-        type: PropType<"accent" | "cta">;
-        default: undefined;
-    };
-    /**
-     * The current checkbox state
-     */
-    ariaChecked: {
-        type: PropType<"true" | "false" | "mixed" | "undefined">;
-        default: undefined;
-    };
-    /**
-     * When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information.
+     * 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.
      */
-    readonly: {
-        type: PropType<boolean>;
+    value: {
+        type: PropType<string>;
         default: undefined;
     };
 }>> & {
     onKeydown?: ((event: KeyboardEvent & {
         target: Checkbox;
     }) => any) | undefined;
-    onClick?: ((event: MouseEvent & {
+    onBlur?: ((event: FocusEvent & {
         target: Checkbox;
     }) => any) | undefined;
-    onFocus?: ((event: FocusEvent & {
+    onChange?: ((event: CustomEvent<undefined> & {
         target: Checkbox;
     }) => any) | undefined;
-    onBlur?: ((event: FocusEvent & {
+    onClick?: ((event: MouseEvent & {
         target: Checkbox;
     }) => any) | undefined;
-    onKeyup?: ((event: KeyboardEvent & {
+    onFocus?: ((event: FocusEvent & {
         target: Checkbox;
     }) => any) | undefined;
     onInput?: ((event: CustomEvent<undefined> & {
         target: Checkbox;
     }) => any) | undefined;
-    onChange?: ((event: CustomEvent<undefined> & {
+    onKeyup?: ((event: KeyboardEvent & {
         target: Checkbox;
     }) => any) | undefined;
     "onUpdate:modelValue"?: ((event: boolean & {
@@ -360,21 +338,19 @@ declare const _default: import("vue").DefineComponent<{
     name: string;
     ariaCurrent: "page" | "step" | "location" | "date" | "time" | "true" | "false";
     value: string;
-    ariaLabel: string;
     connotation: "accent" | "cta";
     disabled: boolean;
     initialValue: string;
-    required: boolean;
     label: string;
+    required: boolean;
     modelValue: boolean;
-    successText: string;
+    checked: boolean;
+    defaultChecked: boolean;
     errorText: string;
     helperText: string;
-    defaultChecked: boolean;
-    checked: boolean;
-    tabindex: string;
-    ariaChecked: "undefined" | "true" | "false" | "mixed";
     readonly: boolean;
+    successText: string;
+    tabindex: string;
 }, SlotsType<{
     /**
      * The default slot allows you to use rich content as the checkbox's label.