@volverjs/ui-vue 0.0.10-beta.2 → 0.0.10-beta.21

package/dist/props/index.d.ts

@@ -1,6 +1,8 @@
 import type { PropType } from 'vue';
-import type { Option } from '../types/generic';
-import { Placement, Strategy, Position, Side, AnchorTarget, ButtonType } from '../constants';
+import type { Option } from '@/types/generic';
+import type { NavItem } from '@/types/nav';
+import { Placement, Strategy, Position, Side, AnchorTarget, ButtonType, ActionTag } from '@/constants';
+import type { VvIconProps } from '@/components/VvIcon';
 export declare const LinkProps: {
     /**
      * The router-link/nuxt-link property, if it is defined the button is rendered as a ruouter-link or nuxt-link.
@@ -18,6 +20,7 @@ export declare const LinkProps: {
      */
     target: {
         type: PropType<"_blank" | "_self" | "_parent" | "_top">;
+        default: undefined;
         validator: (value: AnchorTarget) => boolean;
     };
     /**
@@ -32,27 +35,42 @@ export declare const ValidProps: {
     /**
      * Valid status
      */
-    valid: BooleanConstructor;
+    valid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Valid label
      */
-    validLabel: (ArrayConstructor | StringConstructor)[];
+    validLabel: {
+        type: (ArrayConstructor | StringConstructor)[];
+        default: undefined;
+    };
 };
 export declare const InvalidProps: {
     /**
      * Invalid status
      */
-    invalid: BooleanConstructor;
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Invalid label
      */
-    invalidLabel: (ArrayConstructor | StringConstructor)[];
+    invalidLabel: {
+        type: (ArrayConstructor | StringConstructor)[];
+        default: undefined;
+    };
 };
 export declare const LoadingProps: {
     /**
      * Loading status
      */
-    loading: BooleanConstructor;
+    loading: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Loading label
      */
@@ -65,43 +83,73 @@ export declare const DisabledProps: {
     /**
      * Whether the form control is disabled
      */
-    disabled: BooleanConstructor;
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
 };
 export declare const SelectedProps: {
     /**
      * Whether the item is selected
      */
-    selected: BooleanConstructor;
+    selected: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
 };
 export declare const ActiveProps: {
     /**
      * Whether the item is active
      */
-    active: BooleanConstructor;
+    active: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+};
+export declare const CurrentProps: {
+    /**
+     * Whether the item is current
+     */
+    current: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
 };
 export declare const PressedProps: {
     /**
      * Whether the item is pressed
      */
-    pressed: BooleanConstructor;
+    pressed: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
 };
 export declare const LabelProps: {
     /**
      * The item label
      */
-    label: (StringConstructor | NumberConstructor)[];
+    label: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: undefined;
+    };
 };
 export declare const ReadonlyProps: {
     /**
      * The value is not editable
      */
-    readonly: BooleanConstructor;
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
 };
 export declare const ModifiersProps: {
     /**
      * Component BEM modifiers
      */
-    modifiers: PropType<string | string[]>;
+    modifiers: {
+        type: PropType<string | string[]>;
+        default: undefined;
+    };
 };
 export declare const HintProps: {
     hintLabel: {
@@ -144,7 +192,7 @@ export declare const CountProps: {
      * Show character limit
      */
     count: {
-        type: (StringConstructor | BooleanConstructor)[];
+        type: (BooleanConstructor | StringConstructor)[];
         default: boolean;
         validator: (value: string) => boolean;
     };
@@ -153,7 +201,10 @@ export declare const DebounceProps: {
     /**
      * Milliseconds to wait before emitting the input event
      */
-    debounce: (StringConstructor | NumberConstructor)[];
+    debounce: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: undefined;
+    };
 };
 export declare const IconProps: {
     /**
@@ -161,7 +212,8 @@ export declare const IconProps: {
      * @see VVIcon
      */
     icon: {
-        type: (ObjectConstructor | StringConstructor)[];
+        type: PropType<string | VvIconProps>;
+        default: undefined;
     };
     /**
      * VvIcon position
@@ -186,7 +238,10 @@ export declare const FloatingLabelProps: {
     /**
      * If true the label will be floating
      */
-    floating: BooleanConstructor;
+    floating: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
 };
 export declare const UnselectableProps: {
     /**
@@ -226,6 +281,7 @@ export declare const DropdownProps: {
      */
     transitionName: {
         type: StringConstructor;
+        default: undefined;
     };
     /**
      * Offset of the dropdown from the trigger
@@ -241,24 +297,24 @@ export declare const DropdownProps: {
      */
     shift: {
         type: PropType<boolean | {
-            mainAxis?: boolean | undefined;
-            crossAxis?: boolean | undefined;
             rootBoundary?: import("@floating-ui/core").RootBoundary | undefined;
             elementContext?: import("@floating-ui/core").ElementContext | undefined;
             altBoundary?: boolean | undefined;
             padding?: import("@floating-ui/utils").Padding | undefined;
+            crossAxis?: boolean | undefined;
+            mainAxis?: boolean | undefined;
             limiter?: {
                 fn: (state: import("@floating-ui/core").MiddlewareState) => import("@floating-ui/core").Coords;
                 options?: any;
             } | undefined;
             boundary?: import("@floating-ui/dom").Boundary | undefined;
         } | import("@floating-ui/dom").Derivable<{
-            mainAxis?: boolean | undefined;
-            crossAxis?: boolean | undefined;
             rootBoundary?: import("@floating-ui/core").RootBoundary | undefined;
             elementContext?: import("@floating-ui/core").ElementContext | undefined;
             altBoundary?: boolean | undefined;
             padding?: import("@floating-ui/utils").Padding | undefined;
+            crossAxis?: boolean | undefined;
+            mainAxis?: boolean | undefined;
             limiter?: {
                 fn: (state: import("@floating-ui/core").MiddlewareState) => import("@floating-ui/core").Coords;
                 options?: any;
@@ -273,24 +329,24 @@ export declare const DropdownProps: {
      */
     flip: {
         type: PropType<boolean | {
-            mainAxis?: boolean | undefined;
-            crossAxis?: boolean | undefined;
             rootBoundary?: import("@floating-ui/core").RootBoundary | undefined;
             elementContext?: import("@floating-ui/core").ElementContext | undefined;
             altBoundary?: boolean | undefined;
             padding?: import("@floating-ui/utils").Padding | undefined;
+            crossAxis?: boolean | undefined;
+            mainAxis?: boolean | undefined;
             fallbackPlacements?: import("@floating-ui/utils").Placement[] | undefined;
             fallbackStrategy?: "initialPlacement" | "bestFit" | undefined;
             fallbackAxisSideDirection?: "start" | "end" | "none" | undefined;
             flipAlignment?: boolean | undefined;
             boundary?: import("@floating-ui/dom").Boundary | undefined;
         } | import("@floating-ui/dom").Derivable<{
-            mainAxis?: boolean | undefined;
-            crossAxis?: boolean | undefined;
             rootBoundary?: import("@floating-ui/core").RootBoundary | undefined;
             elementContext?: import("@floating-ui/core").ElementContext | undefined;
             altBoundary?: boolean | undefined;
             padding?: import("@floating-ui/utils").Padding | undefined;
+            crossAxis?: boolean | undefined;
+            mainAxis?: boolean | undefined;
             fallbackPlacements?: import("@floating-ui/utils").Placement[] | undefined;
             fallbackStrategy?: "initialPlacement" | "bestFit" | undefined;
             fallbackAxisSideDirection?: "start" | "end" | "none" | undefined;
@@ -322,6 +378,9 @@ export declare const DropdownProps: {
                 elements: import("@floating-ui/dom").Elements;
             } & {
                 availableWidth: number;
+                /**
+                 * Milliseconds to wait before emitting the input event
+                 */
                 availableHeight: number;
             }) => void | Promise<void>) | undefined;
         } | import("@floating-ui/dom").Derivable<{
@@ -342,6 +401,9 @@ export declare const DropdownProps: {
                 elements: import("@floating-ui/dom").Elements;
             } & {
                 availableWidth: number;
+                /**
+                 * Milliseconds to wait before emitting the input event
+                 */
                 availableHeight: number;
             }) => void | Promise<void>) | undefined;
         }> | undefined>;
@@ -355,21 +417,21 @@ export declare const DropdownProps: {
      */
     autoPlacement: {
         type: PropType<boolean | {
-            crossAxis?: boolean | undefined;
             rootBoundary?: import("@floating-ui/core").RootBoundary | undefined;
             elementContext?: import("@floating-ui/core").ElementContext | undefined;
             altBoundary?: boolean | undefined;
             padding?: import("@floating-ui/utils").Padding | undefined;
+            crossAxis?: boolean | undefined;
             alignment?: import("@floating-ui/utils").Alignment | null | undefined;
             autoAlignment?: boolean | undefined;
             allowedPlacements?: import("@floating-ui/utils").Placement[] | undefined;
             boundary?: import("@floating-ui/dom").Boundary | undefined;
         } | import("@floating-ui/dom").Derivable<{
-            crossAxis?: boolean | undefined;
             rootBoundary?: import("@floating-ui/core").RootBoundary | undefined;
             elementContext?: import("@floating-ui/core").ElementContext | undefined;
             altBoundary?: boolean | undefined;
             padding?: import("@floating-ui/utils").Padding | undefined;
+            crossAxis?: boolean | undefined;
             alignment?: import("@floating-ui/utils").Alignment | null | undefined;
             autoAlignment?: boolean | undefined;
             allowedPlacements?: import("@floating-ui/utils").Placement[] | undefined;
@@ -404,6 +466,7 @@ export declare const DropdownProps: {
      */
     triggerWidth: {
         type: BooleanConstructor;
+        default: boolean;
     };
 };
 export declare const IdNameProps: {
@@ -427,7 +490,10 @@ export declare const AutofocusProps: {
      * Global attribute autofocus
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus
      */
-    autofocus: BooleanConstructor;
+    autofocus: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
 };
 export declare const AutocompleteProps: {
     /**
@@ -446,42 +512,61 @@ export declare const InputTextareaProps: {
      * Available for input types: text, search, url, tel, email, password
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#minlength
      */
-    minlength: (StringConstructor | NumberConstructor)[];
+    minlength: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: undefined;
+    };
     /**
      * Input / Textarea maxlength
      * Maximum length (number of characters) of value
      * Available for input types: text, search, url, tel, email, password
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#maxlength
      */
-    maxlength: (StringConstructor | NumberConstructor)[];
+    maxlength: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: undefined;
+    };
     /**
      * Input / Textarea placeholder
      * Text that appears in the form control when it has no value set
      * Available for input types: text, search, url, tel, email, password, number
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#placeholder
      */
-    placeholder: StringConstructor;
+    placeholder: {
+        type: StringConstructor;
+        default: undefined;
+    };
     /**
      * Input / Textarea required
      * A value is required or must be check for the form to be submittable
      * Available for all input types except color
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#required
      */
-    required: BooleanConstructor;
+    required: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * The item label
      */
-    label: (StringConstructor | NumberConstructor)[];
+    label: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: undefined;
+    };
     /**
      * If true the label will be floating
      */
-    floating: BooleanConstructor;
+    floating: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * VvIcon name or props
      * @see VVIcon
      */
     icon: {
-        type: (ObjectConstructor | StringConstructor)[];
+        type: PropType<string | VvIconProps>;
+        default: undefined;
     };
     /**
      * VvIcon position
@@ -494,23 +579,32 @@ export declare const InputTextareaProps: {
     /**
      * Milliseconds to wait before emitting the input event
      */
-    debounce: (StringConstructor | NumberConstructor)[];
+    debounce: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: undefined;
+    };
     /**
      * Show character limit
      */
     count: {
-        type: (StringConstructor | BooleanConstructor)[];
+        type: (BooleanConstructor | StringConstructor)[];
         default: boolean;
         validator: (value: string) => boolean;
     };
     /**
      * Component BEM modifiers
      */
-    modifiers: PropType<string | string[]>;
+    modifiers: {
+        type: PropType<string | string[]>;
+        default: undefined;
+    };
     /**
      * Loading status
      */
-    loading: BooleanConstructor;
+    loading: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Loading label
      */
@@ -525,27 +619,45 @@ export declare const InputTextareaProps: {
     /**
      * Invalid status
      */
-    invalid: BooleanConstructor;
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Invalid label
      */
-    invalidLabel: (ArrayConstructor | StringConstructor)[];
+    invalidLabel: {
+        type: (ArrayConstructor | StringConstructor)[];
+        default: undefined;
+    };
     /**
      * Valid status
      */
-    valid: BooleanConstructor;
+    valid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Valid label
      */
-    validLabel: (ArrayConstructor | StringConstructor)[];
+    validLabel: {
+        type: (ArrayConstructor | StringConstructor)[];
+        default: undefined;
+    };
     /**
      * The value is not editable
      */
-    readonly: BooleanConstructor;
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Whether the form control is disabled
      */
-    disabled: BooleanConstructor;
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Global attribute tabindex
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex
@@ -566,7 +678,10 @@ export declare const InputTextareaProps: {
      * Global attribute autofocus
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus
      */
-    autofocus: BooleanConstructor;
+    autofocus: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Input / Textarea name
      * Name of the form control. Submitted with the form as part of a name/value pair
@@ -587,15 +702,24 @@ export declare const CheckboxRadioProps: {
      * Input value
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#value
      */
-    value: (StringConstructor | BooleanConstructor | NumberConstructor)[];
+    value: {
+        type: (BooleanConstructor | StringConstructor | NumberConstructor)[];
+        default: undefined;
+    };
     /**
      * Input value
      */
-    modelValue: (ObjectConstructor | StringConstructor | BooleanConstructor | NumberConstructor)[];
+    modelValue: {
+        type: (ObjectConstructor | BooleanConstructor | StringConstructor | NumberConstructor)[];
+        default: undefined;
+    };
     /**
      * Loading status
      */
-    loading: BooleanConstructor;
+    loading: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Loading label
      */
@@ -606,19 +730,31 @@ export declare const CheckboxRadioProps: {
     /**
      * The item label
      */
-    label: (StringConstructor | NumberConstructor)[];
+    label: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: undefined;
+    };
     /**
      * Component BEM modifiers
      */
-    modifiers: PropType<string | string[]>;
+    modifiers: {
+        type: PropType<string | string[]>;
+        default: undefined;
+    };
     /**
      * The value is not editable
      */
-    readonly: BooleanConstructor;
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Whether the form control is disabled
      */
-    disabled: BooleanConstructor;
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     hintLabel: {
         type: StringConstructor;
         default: string;
@@ -626,19 +762,31 @@ export declare const CheckboxRadioProps: {
     /**
      * Invalid status
      */
-    invalid: BooleanConstructor;
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Invalid label
      */
-    invalidLabel: (ArrayConstructor | StringConstructor)[];
+    invalidLabel: {
+        type: (ArrayConstructor | StringConstructor)[];
+        default: undefined;
+    };
     /**
      * Valid status
      */
-    valid: BooleanConstructor;
+    valid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Valid label
      */
-    validLabel: (ArrayConstructor | StringConstructor)[];
+    validLabel: {
+        type: (ArrayConstructor | StringConstructor)[];
+        default: undefined;
+    };
     /**
      * Global attribute tabindex
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex
@@ -666,7 +814,10 @@ export declare const CheckboxRadioGroupProps: {
     /**
      * Input value
      */
-    modelValue: (SymbolConstructor | ArrayConstructor | StringConstructor | BooleanConstructor | NumberConstructor)[];
+    modelValue: {
+        type: (SymbolConstructor | ArrayConstructor | BooleanConstructor | StringConstructor | NumberConstructor)[];
+        default: undefined;
+    };
     /**
      * Input name
      */
@@ -677,11 +828,17 @@ export declare const CheckboxRadioGroupProps: {
     /**
      * If true, the group will be displayed in a vertical column
      */
-    vertical: BooleanConstructor;
+    vertical: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Loading status
      */
-    loading: BooleanConstructor;
+    loading: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Loading label
      */
@@ -692,19 +849,31 @@ export declare const CheckboxRadioGroupProps: {
     /**
      * The item label
      */
-    label: (StringConstructor | NumberConstructor)[];
+    label: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: undefined;
+    };
     /**
      * Component BEM modifiers
      */
-    modifiers: PropType<string | string[]>;
+    modifiers: {
+        type: PropType<string | string[]>;
+        default: undefined;
+    };
     /**
      * The value is not editable
      */
-    readonly: BooleanConstructor;
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Whether the form control is disabled
      */
-    disabled: BooleanConstructor;
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     hintLabel: {
         type: StringConstructor;
         default: string;
@@ -740,19 +909,31 @@ export declare const CheckboxRadioGroupProps: {
     /**
      * Invalid status
      */
-    invalid: BooleanConstructor;
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Invalid label
      */
-    invalidLabel: (ArrayConstructor | StringConstructor)[];
+    invalidLabel: {
+        type: (ArrayConstructor | StringConstructor)[];
+        default: undefined;
+    };
     /**
      * Valid status
      */
-    valid: BooleanConstructor;
+    valid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Valid label
      */
-    validLabel: (ArrayConstructor | StringConstructor)[];
+    validLabel: {
+        type: (ArrayConstructor | StringConstructor)[];
+        default: undefined;
+    };
 };
 export declare const ActionProps: {
     /**
@@ -770,6 +951,13 @@ export declare const ActionProps: {
         type: StringConstructor;
         default: undefined;
     };
+    /**
+     * Default tag for the action
+     */
+    defaultTag: {
+        type: StringConstructor;
+        default: ActionTag;
+    };
     /**
      * The router-link/nuxt-link property, if it is defined the button is rendered as a ruouter-link or nuxt-link.
      * @see Documentation of [router-link](https://router.vuejs.org/api/#router-link) and [nuxt-link](https://nuxtjs.org/api/components-nuxt-link/)
@@ -786,6 +974,7 @@ export declare const ActionProps: {
      */
     target: {
         type: PropType<"_blank" | "_self" | "_parent" | "_top">;
+        default: undefined;
         validator: (value: AnchorTarget) => boolean;
     };
     /**
@@ -795,20 +984,45 @@ export declare const ActionProps: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether the item is current
+     */
+    current: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Whether the item is active
      */
-    active: BooleanConstructor;
+    active: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Whether the item is pressed
      */
-    pressed: BooleanConstructor;
+    pressed: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * The item label
      */
-    label: (StringConstructor | NumberConstructor)[];
+    label: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: undefined;
+    };
     /**
      * Whether the form control is disabled
      */
-    disabled: BooleanConstructor;
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+};
+export declare const NavProps: {
+    items: {
+        type: PropType<NavItem[]>;
+        default: () => never[];
+    };
 };