@volverjs/ui-vue 0.0.13 → 0.0.14

package/dist/components/VvAlert/index.d.ts

@@ -0,0 +1,104 @@
+import type { ExtractPropTypes, PropType } from 'vue';
+import type { AlertModifier } from '@/types';
+import { AlertRole } from '@/constants';
+export declare const VvAlertProps: {
+    /**
+     * Component BEM modifiers
+     */
+    modifiers: {
+        type: PropType<AlertModifier | AlertModifier[]>;
+        default: undefined;
+    };
+    /**
+     * The alert is dismissable
+     * @default false
+     * @type boolean
+     */
+    dismissable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The alert auto close after the specified time in milliseconds
+     * @default 0
+     * @type number
+     */
+    autoClose: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * The alert close label
+     * @default 'Close'
+     * @type string
+     */
+    closeLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The alert title
+     * @default ''
+     * @type string
+     */
+    title: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * The alert content
+     * @default ''
+     * @type string
+     */
+    content: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * The alert footer
+     * @default ''
+     * @type string
+     */
+    footer: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * The alert role
+     * @default 'alert'
+     * @type string
+     * @values 'alert', 'alertdialog'
+     * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/Alert_Role
+     * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/Alertdialog_role
+     */
+    role: {
+        type: PropType<`${AlertRole}`>;
+        default: AlertRole;
+    };
+    icon: {
+        type: PropType<string | import("../VvIcon").VvIconProps>;
+        default: undefined;
+    };
+    iconPosition: {
+        type: PropType<`${import("@/constants").Position}`>;
+        default: import("@/constants").Position;
+        validation: (value: import("@/constants").Position) => boolean;
+    };
+    id: (NumberConstructor | StringConstructor)[];
+};
+export declare const VvAlertEvents: string[];
+export declare function useVvAlert(props: Readonly<ExtractPropTypes<typeof VvAlertProps>>, emit: (event: string, ...args: unknown[]) => void): {
+    close: () => void;
+    hasIcon: globalThis.ComputedRef<import("../VvIcon").VvIconProps | undefined>;
+    hasTitleId: globalThis.ComputedRef<string>;
+    hasProps: globalThis.ComputedRef<{
+        onMouseover: () => void;
+        onMouseleave: () => void;
+        class: Record<string, boolean>;
+        style: {
+            '--alert-duration': string;
+        };
+        role: "alert" | "alertdialog";
+        'aria-labelledby': string;
+    }>;
+};

package/dist/components/VvAlertGroup/VvAlertGroup.vue.d.ts

@@ -0,0 +1,97 @@
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: __VLS_WithSlots<import("vue").DefineComponent<globalThis.ExtractPropTypes<{
+    name: {
+        type: StringConstructor;
+        required: boolean;
+    };
+    items: {
+        type: PropType<import("../..").Alert[]>;
+        default: () => never[];
+    };
+    stack: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    reverse: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    inline: {
+        type: PropType<"start" | "middle" | "end">;
+        default: undefined;
+    };
+    block: {
+        type: PropType<"top" | "center" | "bottom">;
+        default: undefined;
+    };
+    position: {
+        type: PropType<"absolute" | "fixed">;
+        default: undefined;
+    };
+    transition: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    modifiers: {
+        type: PropType<string | string[]>;
+        default: undefined;
+    };
+}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<globalThis.ExtractPropTypes<{
+    name: {
+        type: StringConstructor;
+        required: boolean;
+    };
+    items: {
+        type: PropType<import("../..").Alert[]>;
+        default: () => never[];
+    };
+    stack: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    reverse: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    inline: {
+        type: PropType<"start" | "middle" | "end">;
+        default: undefined;
+    };
+    block: {
+        type: PropType<"top" | "center" | "bottom">;
+        default: undefined;
+    };
+    position: {
+        type: PropType<"absolute" | "fixed">;
+        default: undefined;
+    };
+    transition: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    modifiers: {
+        type: PropType<string | string[]>;
+        default: undefined;
+    };
+}>> & Readonly<{}>, {
+    reverse: boolean;
+    modifiers: string | string[];
+    inline: "start" | "end" | "middle";
+    transition: string;
+    position: "absolute" | "fixed";
+    items: import("../..").Alert[];
+    stack: boolean;
+    block: "top" | "bottom" | "center";
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>, {
+    before?: (props: {}) => any;
+} & {
+    default?: (props: {}) => any;
+} & {
+    after?: (props: {}) => any;
+}>;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/VvAlertGroup/index.d.ts

@@ -0,0 +1,47 @@
+import type { ExtractPropTypes } from 'vue';
+import type { Alert } from '@/types';
+export declare const VvAlertGroupProps: {
+    name: {
+        type: StringConstructor;
+        required: boolean;
+    };
+    items: {
+        type: PropType<Alert[]>;
+        default: () => never[];
+    };
+    stack: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    reverse: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    inline: {
+        type: PropType<"start" | "middle" | "end">;
+        default: undefined;
+    };
+    block: {
+        type: PropType<"top" | "center" | "bottom">;
+        default: undefined;
+    };
+    position: {
+        type: PropType<"absolute" | "fixed">;
+        default: undefined;
+    };
+    transition: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    modifiers: {
+        type: PropType<string | string[]>;
+        default: undefined;
+    };
+};
+export declare const VvAlertGroupEvents: string[];
+export declare function useVvAlertGroup(props: Readonly<ExtractPropTypes<typeof VvAlertGroupProps>>, emit: (event: string, ...args: unknown[]) => void): {
+    hasTransition: globalThis.ComputedRef<string>;
+    hasProps: globalThis.ComputedRef<{
+        class: (string | Record<string, boolean>)[];
+    }>;
+};

package/dist/components/VvAvatar/VvAvatar.vue.d.ts

@@ -0,0 +1,24 @@
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: __VLS_WithSlots<import("vue").DefineComponent<globalThis.ExtractPropTypes<{
+    imgSrc: StringConstructor;
+    modifiers: {
+        type: PropType<string | string[]>;
+        default: undefined;
+    };
+}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<globalThis.ExtractPropTypes<{
+    imgSrc: StringConstructor;
+    modifiers: {
+        type: PropType<string | string[]>;
+        default: undefined;
+    };
+}>> & Readonly<{}>, {
+    modifiers: string | string[];
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>, {
+    default?: (props: {}) => any;
+}>;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/VvAvatar/index.d.ts

@@ -0,0 +1,10 @@
+export declare const VvAvatarProps: {
+    /**
+     * Image src for avatar
+     */
+    imgSrc: StringConstructor;
+    modifiers: {
+        type: PropType<string | string[]>;
+        default: undefined;
+    };
+};

package/dist/components/VvAvatarGroup/VvAvatarGroup.vue.d.ts

@@ -0,0 +1,50 @@
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: __VLS_WithSlots<import("vue").DefineComponent<globalThis.ExtractPropTypes<{
+    items: {
+        type: PropType<import("@/components/VvAvatarGroup").AvatarItem[]>;
+        default: () => never[];
+        required: boolean;
+    };
+    toShow: {
+        type: NumberConstructor;
+        default: number;
+    };
+    totalItems: {
+        type: NumberConstructor;
+    };
+    avatarModifiers: PropType<string | string[]>;
+    modifiers: {
+        type: PropType<string | string[]>;
+        default: undefined;
+    };
+}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<globalThis.ExtractPropTypes<{
+    items: {
+        type: PropType<import("@/components/VvAvatarGroup").AvatarItem[]>;
+        default: () => never[];
+        required: boolean;
+    };
+    toShow: {
+        type: NumberConstructor;
+        default: number;
+    };
+    totalItems: {
+        type: NumberConstructor;
+    };
+    avatarModifiers: PropType<string | string[]>;
+    modifiers: {
+        type: PropType<string | string[]>;
+        default: undefined;
+    };
+}>> & Readonly<{}>, {
+    modifiers: string | string[];
+    items: import("@/components/VvAvatarGroup").AvatarItem[];
+    toShow: number;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>, {
+    default?: (props: {}) => any;
+}>;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/VvAvatarGroup/index.d.ts

@@ -0,0 +1,28 @@
+export type AvatarItem = {
+    key?: string;
+    text?: string;
+    imgSrc?: string;
+    modifiers?: string | string[];
+};
+export declare const VvAvatarGroupProps: {
+    /**
+     * avatar items
+     */
+    items: {
+        type: PropType<AvatarItem[]>;
+        default: () => never[];
+        required: boolean;
+    };
+    toShow: {
+        type: NumberConstructor;
+        default: number;
+    };
+    totalItems: {
+        type: NumberConstructor;
+    };
+    avatarModifiers: PropType<string | string[]>;
+    modifiers: {
+        type: PropType<string | string[]>;
+        default: undefined;
+    };
+};

package/dist/components/VvBadge/VvBadge.vue.d.ts

@@ -0,0 +1,24 @@
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: __VLS_WithSlots<import("vue").DefineComponent<globalThis.ExtractPropTypes<{
+    value: (NumberConstructor | StringConstructor)[];
+    modifiers: {
+        type: PropType<string | string[]>;
+        default: undefined;
+    };
+}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<globalThis.ExtractPropTypes<{
+    value: (NumberConstructor | StringConstructor)[];
+    modifiers: {
+        type: PropType<string | string[]>;
+        default: undefined;
+    };
+}>> & Readonly<{}>, {
+    modifiers: string | string[];
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>, {
+    default?: (props: {}) => any;
+}>;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/VvBadge/index.d.ts

@@ -0,0 +1,7 @@
+export declare const VvBadgeProps: {
+    value: (NumberConstructor | StringConstructor)[];
+    modifiers: {
+        type: PropType<string | string[]>;
+        default: undefined;
+    };
+};

package/dist/components/VvBreadcrumb/VvBreadcrumb.vue.d.ts

@@ -0,0 +1,39 @@
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: __VLS_WithSlots<import("vue").DefineComponent<globalThis.ExtractPropTypes<{
+    routes: PropType<import("../..").NavItem[]>;
+    modifiers: {
+        type: PropType<string | string[]>;
+        default: undefined;
+    };
+}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<globalThis.ExtractPropTypes<{
+    routes: PropType<import("../..").NavItem[]>;
+    modifiers: {
+        type: PropType<string | string[]>;
+        default: undefined;
+    };
+}>> & Readonly<{}>, {
+    modifiers: string | string[];
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>, {
+    label?: (props: {
+        index: number;
+        label: string;
+        isLast: boolean;
+        ariaLabel?: string;
+        title?: string;
+        to?: string | Record<string, unknown>;
+        href?: string;
+        target?: string;
+        rel?: string;
+        disabled?: boolean;
+        current?: boolean;
+        class?: string | string[];
+        on?: Record<"click" | string, () => void>;
+        data?: Record<string, unknown>;
+    }) => any;
+}>;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/VvBreadcrumb/index.d.ts

@@ -0,0 +1,8 @@
+import type { NavItem } from '../../types';
+export declare const VvBreadcrumbProps: {
+    routes: PropType<NavItem[]>;
+    modifiers: {
+        type: PropType<string | string[]>;
+        default: undefined;
+    };
+};

package/dist/components/VvButton/VvButton.vue.d.ts

@@ -0,0 +1,221 @@
+import { Side } from '../../constants';
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: __VLS_WithSlots<import("vue").DefineComponent<globalThis.ExtractPropTypes<{
+    iconPosition: {
+        type: PropType<`${Side}`>;
+        default: Side;
+        validator: (value: Side) => boolean;
+    };
+    loadingIcon: {
+        type: StringConstructor;
+        default: string;
+    };
+    toggle: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    value: {
+        type: (NumberConstructor | BooleanConstructor | StringConstructor)[];
+        default: undefined;
+    };
+    uncheckedValue: {
+        type: (NumberConstructor | BooleanConstructor | StringConstructor)[];
+        default: undefined;
+    };
+    modelValue: {
+        type: (NumberConstructor | BooleanConstructor | StringConstructor)[];
+        default: undefined;
+    };
+    icon: {
+        type: PropType<string | import("../VvIcon").VvIconProps>;
+        default: undefined;
+    };
+    loading: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    loadingLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    unselectable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    modifiers: {
+        type: PropType<string | string[]>;
+        default: undefined;
+    };
+    id: (NumberConstructor | StringConstructor)[];
+    type: {
+        type: PropType<`${import("../../constants").ButtonType}`>;
+        default: import("../../constants").ButtonType;
+        validator: (value: import("../../constants").ButtonType) => boolean;
+    };
+    ariaLabel: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    defaultTag: {
+        type: StringConstructor;
+        default: import("../../constants").ActionTag;
+    };
+    to: {
+        type: (ObjectConstructor | StringConstructor)[];
+    };
+    href: StringConstructor;
+    target: StringConstructor;
+    rel: {
+        type: StringConstructor;
+        default: string;
+    };
+    current: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    active: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    pressed: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    label: {
+        type: (NumberConstructor | StringConstructor)[];
+        default: undefined;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, {
+    /** Reference to the root element */
+    $el: globalThis.ComputedRef<HTMLElement | undefined>;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<globalThis.ExtractPropTypes<{
+    iconPosition: {
+        type: PropType<`${Side}`>;
+        default: Side;
+        validator: (value: Side) => boolean;
+    };
+    loadingIcon: {
+        type: StringConstructor;
+        default: string;
+    };
+    toggle: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    value: {
+        type: (NumberConstructor | BooleanConstructor | StringConstructor)[];
+        default: undefined;
+    };
+    uncheckedValue: {
+        type: (NumberConstructor | BooleanConstructor | StringConstructor)[];
+        default: undefined;
+    };
+    modelValue: {
+        type: (NumberConstructor | BooleanConstructor | StringConstructor)[];
+        default: undefined;
+    };
+    icon: {
+        type: PropType<string | import("../VvIcon").VvIconProps>;
+        default: undefined;
+    };
+    loading: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    loadingLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    unselectable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    modifiers: {
+        type: PropType<string | string[]>;
+        default: undefined;
+    };
+    id: (NumberConstructor | StringConstructor)[];
+    type: {
+        type: PropType<`${import("../../constants").ButtonType}`>;
+        default: import("../../constants").ButtonType;
+        validator: (value: import("../../constants").ButtonType) => boolean;
+    };
+    ariaLabel: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    defaultTag: {
+        type: StringConstructor;
+        default: import("../../constants").ActionTag;
+    };
+    to: {
+        type: (ObjectConstructor | StringConstructor)[];
+    };
+    href: StringConstructor;
+    target: StringConstructor;
+    rel: {
+        type: StringConstructor;
+        default: string;
+    };
+    current: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    active: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    pressed: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    label: {
+        type: (NumberConstructor | StringConstructor)[];
+        default: undefined;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{}>, {
+    modelValue: string | number | boolean;
+    toggle: boolean;
+    icon: string | import("../VvIcon").VvIconProps;
+    modifiers: string | string[];
+    label: string | number;
+    value: string | number | boolean;
+    disabled: boolean;
+    type: "button" | "submit" | "reset";
+    ariaLabel: string;
+    defaultTag: string;
+    rel: string;
+    current: boolean;
+    active: boolean;
+    pressed: boolean;
+    iconPosition: "top" | "right" | "bottom" | "left";
+    loadingIcon: string;
+    uncheckedValue: string | number | boolean;
+    loading: boolean;
+    loadingLabel: string;
+    unselectable: boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>, {
+    default?: (props: {}) => any;
+} & {
+    loading?: (props: {}) => any;
+} & {
+    before?: (props: {}) => any;
+} & {
+    label?: (props: {}) => any;
+} & {
+    after?: (props: {}) => any;
+}>;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};