@vonage/vivid-vue 4.16.2 → 4.18.0

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

@@ -4,25 +4,24 @@ import type { Fab } from '@vonage/vivid/lib/fab/fab';
 import type { SlotsType } from 'vue';
 declare const _default: import("vue").DefineComponent<{
     /**
-     * A decorative icon the custom element should have.
-     * See the Vivid Icon Gallery for available icons: https://icons.vivid.vonage.com/
+     * Indicates the element that represents the current item within a container or set of related elements.
      */
-    icon: {
-        type: PropType<IconId>;
+    ariaCurrent: {
+        type: PropType<"page" | "step" | "location" | "date" | "time" | "true" | "false">;
         default: undefined;
     };
     /**
-     * Indicates the icon affix alignment.
+     * Determines if the element should receive document focus on page load.
      */
-    iconTrailing: {
+    autofocus: {
         type: PropType<boolean>;
         default: undefined;
     };
     /**
-     * Indicates the element that represents the current item within a container or set of related elements.
+     * The connotation the fab should have.
      */
-    ariaCurrent: {
-        type: PropType<"page" | "step" | "location" | "date" | "time" | "true" | "false">;
+    connotation: {
+        type: PropType<"cta" | "accent" | "announcement">;
         default: undefined;
     };
     /**
@@ -33,36 +32,31 @@ 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 id of a form to associate the element to.
      */
-    initialValue: {
+    form: {
         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.
+     * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details.
      */
-    value: {
+    formaction: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * The name of the element. This element's value will be surfaced during form submission under the provided name.
+     * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details.
      */
-    name: {
+    formenctype: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * Require the field to be completed prior to form submission.
+     * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details.
      */
-    required: {
-        type: PropType<boolean>;
+    formmethod: {
+        type: PropType<string>;
         default: undefined;
     };
     /**
@@ -73,66 +67,61 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * The connotation the fab should have.
-     */
-    connotation: {
-        type: PropType<"cta" | "accent" | "announcement">;
-        default: undefined;
-    };
-    /**
-     * The size the FAB should have.
+     * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details.
      */
-    size: {
-        type: PropType<"condensed" | "normal" | "expanded">;
+    formtarget: {
+        type: PropType<"_self" | "_blank" | "_parent" | "_top">;
         default: undefined;
     };
     /**
-     * Indicates the fab's label.
+     * A decorative icon the custom element should have.
+     * See the Vivid Icon Gallery for available icons: https://icons.vivid.vonage.com/
      */
-    label: {
-        type: PropType<string>;
+    icon: {
+        type: PropType<IconId>;
         default: undefined;
     };
     /**
-     * Determines if the element should receive document focus on page load.
+     * Indicates the icon affix alignment.
      */
-    autofocus: {
+    iconTrailing: {
         type: PropType<boolean>;
         default: undefined;
     };
     /**
-     * The id of a form to associate the element to.
+     * The initial value of the form. This value sets the `value` property
+     * only when the `value` property has not been explicitly set.
      */
-    form: {
+    initialValue: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details.
+     * Indicates the fab's label.
      */
-    formaction: {
+    label: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details.
+     * The name of the element. This element's value will be surfaced during form submission under the provided name.
      */
-    formenctype: {
+    name: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details.
+     * Require the field to be completed prior to form submission.
      */
-    formmethod: {
-        type: PropType<string>;
+    required: {
+        type: PropType<boolean>;
         default: undefined;
     };
     /**
-     * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details.
+     * The size the FAB should have.
      */
-    formtarget: {
-        type: PropType<"_self" | "_blank" | "_parent" | "_top">;
+    size: {
+        type: PropType<"condensed" | "normal" | "expanded">;
         default: undefined;
     };
     /**
@@ -142,6 +131,17 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<"submit" | "reset" | "button">;
         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.
+     */
+    value: {
+        type: PropType<string>;
+        default: undefined;
+    };
 }, {
     componentName: import("vue").Ref<string>;
     element: import("vue").Ref<{
@@ -167,6 +167,13 @@ declare const _default: import("vue").DefineComponent<{
      */
     validate(): void;
 }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    /**
+     * Fires when the element loses focus.
+     * @type {FocusEvent}
+     */
+    blur(event: FocusEvent & {
+        target: Fab;
+    }): 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}
@@ -182,10 +189,10 @@ declare const _default: import("vue").DefineComponent<{
         target: Fab;
     }): true;
     /**
-     * Fires when the element loses focus.
-     * @type {FocusEvent}
+     * Fires when the value of an element has been changed.
+     * @type {Event}
      */
-    blur(event: FocusEvent & {
+    input(event: Event & {
         target: Fab;
     }): true;
     /**
@@ -202,34 +209,26 @@ declare const _default: import("vue").DefineComponent<{
     keyup(event: KeyboardEvent & {
         target: Fab;
     }): true;
-    /**
-     * Fires when the value of an element has been changed.
-     * @type {Event}
-     */
-    input(event: Event & {
-        target: Fab;
-    }): true;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     /**
-     * A decorative icon the custom element should have.
-     * See the Vivid Icon Gallery for available icons: https://icons.vivid.vonage.com/
+     * Indicates the element that represents the current item within a container or set of related elements.
      */
-    icon: {
-        type: PropType<IconId>;
+    ariaCurrent: {
+        type: PropType<"page" | "step" | "location" | "date" | "time" | "true" | "false">;
         default: undefined;
     };
     /**
-     * Indicates the icon affix alignment.
+     * Determines if the element should receive document focus on page load.
      */
-    iconTrailing: {
+    autofocus: {
         type: PropType<boolean>;
         default: undefined;
     };
     /**
-     * Indicates the element that represents the current item within a container or set of related elements.
+     * The connotation the fab should have.
      */
-    ariaCurrent: {
-        type: PropType<"page" | "step" | "location" | "date" | "time" | "true" | "false">;
+    connotation: {
+        type: PropType<"cta" | "accent" | "announcement">;
         default: undefined;
     };
     /**
@@ -240,36 +239,31 @@ 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 id of a form to associate the element to.
      */
-    initialValue: {
+    form: {
         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.
+     * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details.
      */
-    value: {
+    formaction: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * The name of the element. This element's value will be surfaced during form submission under the provided name.
+     * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details.
      */
-    name: {
+    formenctype: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * Require the field to be completed prior to form submission.
+     * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details.
      */
-    required: {
-        type: PropType<boolean>;
+    formmethod: {
+        type: PropType<string>;
         default: undefined;
     };
     /**
@@ -280,66 +274,61 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     /**
-     * The connotation the fab should have.
-     */
-    connotation: {
-        type: PropType<"cta" | "accent" | "announcement">;
-        default: undefined;
-    };
-    /**
-     * The size the FAB should have.
+     * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details.
      */
-    size: {
-        type: PropType<"condensed" | "normal" | "expanded">;
+    formtarget: {
+        type: PropType<"_self" | "_blank" | "_parent" | "_top">;
         default: undefined;
     };
     /**
-     * Indicates the fab's label.
+     * A decorative icon the custom element should have.
+     * See the Vivid Icon Gallery for available icons: https://icons.vivid.vonage.com/
      */
-    label: {
-        type: PropType<string>;
+    icon: {
+        type: PropType<IconId>;
         default: undefined;
     };
     /**
-     * Determines if the element should receive document focus on page load.
+     * Indicates the icon affix alignment.
      */
-    autofocus: {
+    iconTrailing: {
         type: PropType<boolean>;
         default: undefined;
     };
     /**
-     * The id of a form to associate the element to.
+     * The initial value of the form. This value sets the `value` property
+     * only when the `value` property has not been explicitly set.
      */
-    form: {
+    initialValue: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details.
+     * Indicates the fab's label.
      */
-    formaction: {
+    label: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details.
+     * The name of the element. This element's value will be surfaced during form submission under the provided name.
      */
-    formenctype: {
+    name: {
         type: PropType<string>;
         default: undefined;
     };
     /**
-     * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details.
+     * Require the field to be completed prior to form submission.
      */
-    formmethod: {
-        type: PropType<string>;
+    required: {
+        type: PropType<boolean>;
         default: undefined;
     };
     /**
-     * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | <button> element for more details.
+     * The size the FAB should have.
      */
-    formtarget: {
-        type: PropType<"_self" | "_blank" | "_parent" | "_top">;
+    size: {
+        type: PropType<"condensed" | "normal" | "expanded">;
         default: undefined;
     };
     /**
@@ -349,25 +338,36 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<"submit" | "reset" | "button">;
         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.
+     */
+    value: {
+        type: PropType<string>;
+        default: undefined;
+    };
 }>> & {
     onKeydown?: ((event: KeyboardEvent & {
         target: Fab;
     }) => any) | undefined;
+    onBlur?: ((event: FocusEvent & {
+        target: Fab;
+    }) => any) | undefined;
     onClick?: ((event: MouseEvent & {
         target: Fab;
     }) => any) | undefined;
     onFocus?: ((event: FocusEvent & {
         target: Fab;
     }) => any) | undefined;
-    onBlur?: ((event: FocusEvent & {
+    onInput?: ((event: Event & {
         target: Fab;
     }) => any) | undefined;
     onKeyup?: ((event: KeyboardEvent & {
         target: Fab;
     }) => any) | undefined;
-    onInput?: ((event: Event & {
-        target: Fab;
-    }) => any) | undefined;
 }, {
     name: string;
     ariaCurrent: "page" | "step" | "location" | "date" | "time" | "true" | "false";
@@ -378,16 +378,16 @@ declare const _default: import("vue").DefineComponent<{
     size: "expanded" | "condensed" | "normal";
     connotation: "accent" | "announcement" | "cta";
     disabled: boolean;
-    initialValue: string;
-    required: boolean;
     autofocus: boolean;
-    formnovalidate: boolean;
-    label: string;
     form: string;
     formaction: string;
     formenctype: string;
     formmethod: string;
+    formnovalidate: boolean;
     formtarget: "_self" | "_blank" | "_parent" | "_top";
+    initialValue: string;
+    label: string;
+    required: boolean;
 }, SlotsType<{
     /**
      * Slot to add an icon to fab.