maz-ui 3.50.1 → 4.0.0-alpha.2

package/dist/types/components/MazAnimatedText.vue.d.ts

@@ -0,0 +1,55 @@
+export interface MazAnimatedTextProps {
+    /**
+     * The text to animate
+     * @example "Hello"
+     */
+    text: string;
+    /**
+     * The last word(s) to be highlighted
+     * @example "world"
+     */
+    lastWord?: string;
+    /**
+     * The delay of the animation
+     * @default 0
+     */
+    delay?: number;
+    /**
+     * The direction of the animation
+     * @default "up"
+     * @values "up", "down", "left", "right"
+     */
+    direction?: 'up' | 'down' | 'left' | 'right';
+    /**
+     * The tag to use for the text
+     * @default "span"
+     */
+    tag?: string;
+    /**
+     * The delay between each word
+     * @default 75
+     */
+    wordDelay?: number;
+    /**
+     * The column gap between each word
+     * @default 0.5
+     */
+    columnGap?: number;
+    /**
+     * The row gap between each word
+     * @default 0
+     */
+    rowGap?: number;
+    /**
+     * The duration of the animation
+     * @default 2000
+     */
+    duration?: number;
+    /**
+     * Play the animation only once
+     * @default true
+     */
+    once?: boolean;
+}
+declare const _default: import('vue').DefineComponent<MazAnimatedTextProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<MazAnimatedTextProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/types/components/MazAvatar.vue.d.ts

@@ -0,0 +1,100 @@
+import { Color } from './types';
+import { HTMLAttributes } from 'vue';
+export interface MazAvatarProps {
+    /** The style of the component */
+    style?: HTMLAttributes['style'];
+    /** The class of the component */
+    class?: HTMLAttributes['class'];
+    /** The source of the image */
+    src?: string | null;
+    /** The caption of the avatar */
+    caption?: string | null;
+    /** The link of the avatar */
+    href?: string;
+    /** The link (router-link) of the avatar */
+    to?: string | Record<string, unknown>;
+    /** The alt of the image */
+    alt?: string;
+    /** The target of the link */
+    target?: string;
+    /** The size of the avatar */
+    size?: string;
+    /** Add a border to the avatar */
+    bordered?: boolean;
+    /** Make the avatar clickable */
+    clickable?: boolean;
+    /** Make the avatar square */
+    square?: boolean;
+    /** Remove the shadow */
+    noElevation?: boolean;
+    /** Show the caption */
+    showCaption?: boolean;
+    /** Make the image height full */
+    imageHeightFull?: boolean;
+    /** Remove the loader */
+    noLoader?: boolean;
+    /** The color of the clickable button */
+    buttonColor?: Color;
+    /** Remove the icon on hover when component is clickable */
+    noClickableIcon?: boolean;
+    /** Number of letters to display in the round text */
+    letterCount?: number;
+    /**
+     * Size of the rounded
+     * @values `'none' | 'sm' | 'md' | 'lg' | 'xl' | 'full'`
+     */
+    roundedSize?: 'none' | 'sm' | 'md' | 'lg' | 'xl' | 'full';
+    /** The fallback src to replace the src on loading error */
+    fallbackSrc?: string;
+    /** Load the fallback image by default */
+    noPhoto?: boolean;
+    /**
+     * The loading strategy of the image - lazy, eager or intersecting
+     * @default 'intersecting'
+     * @values `'lazy' | 'eager' | 'intersecting'`
+     */
+    loading?: 'lazy' | 'eager' | 'intersecting';
+}
+declare function __VLS_template(): {
+    slots: {
+        "round-text"?(_: {}): any;
+        icon?(_: {}): any;
+        caption?(_: {}): any;
+    };
+    refs: {};
+    attrs: Partial<{}>;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<MazAvatarProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+    click: (event: MouseEvent) => any;
+    error: (el: Element) => any;
+    loaded: (el: Element) => any;
+    loading: (el: Element) => any;
+    intersecting: (el: Element) => any;
+}, string, import('vue').PublicProps, Readonly<MazAvatarProps> & Readonly<{
+    onClick?: ((event: MouseEvent) => any) | undefined;
+    onError?: ((el: Element) => any) | undefined;
+    onLoaded?: ((el: Element) => any) | undefined;
+    onLoading?: ((el: Element) => any) | undefined;
+    onIntersecting?: ((el: Element) => any) | undefined;
+}>, {
+    size: string;
+    caption: string | null;
+    src: string | null;
+    roundedSize: "none" | "sm" | "md" | "lg" | "xl" | "full";
+    loading: "lazy" | "eager" | "intersecting";
+    href: string;
+    to: string | Record<string, unknown>;
+    target: string;
+    alt: string;
+    fallbackSrc: string;
+    buttonColor: Color;
+    letterCount: number;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/types/components/MazBackdrop.vue.d.ts

@@ -0,0 +1,70 @@
+import { HTMLAttributes } from 'vue';
+export interface MazBackdropProps {
+    /** @model Modal's model value */
+    modelValue?: boolean;
+    /** Teleport selector */
+    teleportSelector?: string;
+    /** Function called before modal is close */
+    beforeClose?: () => Promise<void> | void;
+    /** Persistent dialog (not closable by clicking outside and remove close button) */
+    persistent?: boolean;
+    /** Prevent close on escape key */
+    noCloseOnEscKey?: boolean;
+    /** Transition name */
+    transitionName?: string;
+    /** Backdrop class */
+    backdropClass?: HTMLAttributes['class'];
+    /** Backdrop content class */
+    backdropContentClass?: HTMLAttributes['class'];
+    /** Add padding to the content */
+    contentPadding?: boolean;
+    /** Justify content */
+    justify?: 'center' | 'end' | 'start' | 'space-between' | 'space-around' | 'none';
+    /** Align content */
+    align?: 'center' | 'end' | 'start' | 'none';
+    /** Variant */
+    variant?: 'bottom-sheet' | 'dialog' | 'drawer';
+}
+declare function close(): void;
+declare function toggleModal(value: any): Promise<void>;
+declare function onBackdropAnimationEnter(): void;
+declare function onBackdropAnimationLeave(): void;
+declare function onBackdropClicked(): void;
+declare function onKeyPress(event: KeyboardEvent): void;
+declare function __VLS_template(): {
+    slots: {
+        default?(_: {
+            close: typeof close;
+            onBackdropClicked: typeof onBackdropClicked;
+        }): any;
+    };
+    refs: {};
+    attrs: Partial<{}>;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<MazBackdropProps, {
+    onBackdropAnimationEnter: typeof onBackdropAnimationEnter;
+    onBackdropAnimationLeave: typeof onBackdropAnimationLeave;
+    onBackdropClicked: typeof onBackdropClicked;
+    close: typeof close;
+    present: import('vue').Ref<boolean, boolean>;
+    toggleModal: typeof toggleModal;
+    onKeyPress: typeof onKeyPress;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    close: (value: void) => any;
+    open: (value: void) => any;
+    "update:model-value": (value: boolean) => any;
+    "before-close": (value: void) => any;
+}, string, import('vue').PublicProps, Readonly<MazBackdropProps> & Readonly<{
+    onClose?: ((value?: void | undefined) => any) | undefined;
+    onOpen?: ((value?: void | undefined) => any) | undefined;
+    "onUpdate:model-value"?: ((value: boolean) => any) | undefined;
+    "onBefore-close"?: ((value?: void | undefined) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/types/components/MazBadge.vue.d.ts

@@ -0,0 +1,38 @@
+import { Color } from './types';
+export type MazBadgeColor = Color | 'gray';
+export type MazBadgeRoundedSize = 'none' | 'sm' | 'md' | 'lg' | 'xl' | 'full';
+export interface MazBadgeProps {
+    color?: MazBadgeColor;
+    size?: string;
+    nowrap?: boolean;
+    outline?: boolean;
+    pastel?: boolean;
+    /**
+     * Size radius of the component's border
+     * @values `'none' | 'sm' | 'md' | 'lg' | 'xl' | 'full'`
+     */
+    roundedSize?: MazBadgeRoundedSize;
+}
+declare function __VLS_template(): {
+    slots: {
+        default?(_: {}): any;
+    };
+    refs: {};
+    attrs: Partial<{}>;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<MazBadgeProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<MazBadgeProps> & Readonly<{}>, {
+    size: string;
+    color: MazBadgeColor;
+    roundedSize: MazBadgeRoundedSize;
+    outline: boolean;
+    pastel: boolean;
+    nowrap: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/types/components/MazBottomSheet.vue.d.ts

@@ -0,0 +1,34 @@
+export interface MazBottomSheetProps {
+    /** @model Modal's model value */
+    modelValue?: boolean;
+    /** Remove the close button */
+    noClose?: boolean;
+    /** Remove the padding on the container */
+    noPadding?: boolean;
+}
+declare function __VLS_template(): {
+    slots: {
+        default?(_: {
+            close: () => void;
+        }): any;
+    };
+    refs: {};
+    attrs: Partial<{}>;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<MazBottomSheetProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    close: (value: void) => any;
+    open: (value: void) => any;
+    "update:model-value": (value: boolean) => any;
+}, string, import('vue').PublicProps, Readonly<MazBottomSheetProps> & Readonly<{
+    onClose?: ((value?: void | undefined) => any) | undefined;
+    onOpen?: ((value?: void | undefined) => any) | undefined;
+    "onUpdate:model-value"?: ((value: boolean) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/types/components/MazBtn.vue.d.ts

@@ -0,0 +1,133 @@
+import { Color, Icon, Size } from './types';
+export interface MazBtnProps {
+    /**
+     * The variant of the button - Change UI of component (link or button style)
+     * @values `'button' | 'link'`
+     * @deprecated Use the component <MazLink /> instead
+     */
+    variant?: 'button' | 'link';
+    /**
+     * The size of the button
+     * @values `'xl' | 'lg' | 'md' | 'sm' | 'xs' | 'mini'`
+     */
+    size?: Size;
+    /**
+     * The color of the button
+     * @values `'primary' | 'secondary' | 'info' | 'success' | 'warning' | 'danger' | 'white' | 'black' | 'transparent' | 'theme'`
+     */
+    color?: Color;
+    /**
+     * The type of the button
+     * @values `'submit' | 'reset' | 'button'`
+     */
+    type?: 'submit' | 'reset' | 'button';
+    /**
+     * If true, the button will have a full border radius
+     * @default false
+     */
+    rounded?: boolean;
+    /**
+     * Size of the rounded
+     * @values `'none' | 'sm' | 'md' | 'lg' | 'xl' | 'full'`
+     * @default 'lg'
+     */
+    roundedSize?: 'none' | 'sm' | 'md' | 'lg' | 'xl' | 'full';
+    /**
+     * If true, the button will have no border radius
+     * @default false
+     */
+    noRounded?: boolean;
+    /**
+     * If true, the button have the "border" style
+     * @default false
+     */
+    outline?: boolean;
+    /**
+     * If true, the button will have a pastel color
+     * @default false
+     */
+    pastel?: boolean;
+    /**
+     * If true, the button will have a full width
+     * @default false
+     */
+    block?: boolean;
+    /**
+     * If true, the button will have no underline on hover (useful with `variant="link"`)
+     * @default false
+     */
+    noUnderline?: boolean;
+    /**
+     * Enable the button loader
+     * @default false
+     */
+    loading?: boolean;
+    /**
+     * Disable the button
+     * @default false
+     */
+    disabled?: boolean;
+    /**
+     * If true, the button will have a fab style
+     * @default false
+     */
+    fab?: boolean;
+    /**
+     * The name of the icon to display or component, only with fab
+     * `@type` `{string | FunctionalComponent<SVGAttributes> | ComponentPublicInstance | Component}`
+     */
+    icon?: string | Icon;
+    /**
+     * The name of the icon or component to display on the left of the button
+     * `@type` `{string | FunctionalComponent<SVGAttributes> | ComponentPublicInstance | Component}`
+     */
+    leftIcon?: string | Icon;
+    /**
+     * The name of the icon or component to display on the right of the button
+     * `@type` `{string | FunctionalComponent<SVGAttributes> | ComponentPublicInstance | Component}`
+     */
+    rightIcon?: string | Icon;
+    /**
+     * If true, the button will have no padding
+     * @default false
+     */
+    noPadding?: boolean;
+    /**
+     * If true, the button will have no box-shadow
+     * @default false
+     */
+    noElevation?: boolean;
+    /**
+     * Choose how the elements are aligned in the button
+     */
+    justify?: 'start' | 'end' | 'center' | 'space-between' | 'space-around' | 'space-evenly';
+}
+declare function __VLS_template(): {
+    slots: {
+        "left-icon"?(_: {}): any;
+        icon?(_: {}): any;
+        default?(_: {}): any;
+        "right-icon"?(_: {}): any;
+    };
+    refs: {};
+    attrs: Partial<{}>;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<MazBtnProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<MazBtnProps> & Readonly<{}>, {
+    size: Size;
+    type: "submit" | "reset" | "button";
+    color: Color;
+    variant: "button" | "link";
+    roundedSize: "none" | "sm" | "md" | "lg" | "xl" | "full";
+    icon: string | Icon;
+    leftIcon: string | Icon;
+    rightIcon: string | Icon;
+    justify: "start" | "end" | "center" | "space-between" | "space-around" | "space-evenly";
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/types/components/MazCard.vue.d.ts

@@ -0,0 +1,93 @@
+import { MazGalleryImage } from './types';
+import { RouterLinkProps } from 'vue-router';
+import { HTMLAttributes } from 'vue';
+export interface MazCardProps {
+    /** Images displayed */
+    images?: MazGalleryImage[];
+    /** Card variant: Must be `column | row | row-reverse | column-reverse` */
+    orientation?: 'column' | 'row' | 'row-reverse' | 'column-reverse';
+    /** Make card a link (footer area excluded) */
+    href?: string;
+    /** Make card a link with a router-link (footer area excluded) */
+    to?: RouterLinkProps['to'];
+    /** Target option of link: Muse be one of `_blank | _self | _parent | _top | framename` */
+    hrefTarget?: '_blank' | '_self' | '_parent' | '_top' | string;
+    /** Footer text alignment: `right | left` */
+    footerAlign?: 'right' | 'left';
+    /** Gallery image width */
+    galleryWidth?: string | number;
+    /** Gallery image height */
+    galleryHeight?: string | number;
+    /** Enable "zoom" image on click (can't be used when the card has a link) */
+    zoom?: boolean;
+    /** Set elevation to card (box-shadow) */
+    elevation?: boolean;
+    /** Set radius to card */
+    radius?: boolean;
+    /** Set border to card (in dark mode, the card is always bordered) */
+    bordered?: boolean;
+    /** Number of images shown in the gallery */
+    imagesShowCount?: number;
+    /** Remove transparent layer with the remain count (ex: +2) */
+    noRemaining?: boolean;
+    /** scale animation on hover (only linked cards) */
+    scale?: boolean;
+    /** add classes to wrapper */
+    wrapperClass?: HTMLAttributes['class'];
+    /** Remove padding from content wrapper */
+    noPadding?: boolean;
+    /** Hide overflow */
+    overflowHidden?: boolean;
+    /**
+     * @deprecated Use `collapsible` instead
+     */
+    collapsable?: boolean;
+    /**
+     * Card can be open and close
+     */
+    collapsible?: boolean;
+    /** Card is open by default if `true` */
+    collapseOpen?: boolean;
+    /** Title of the card in header */
+    header?: string;
+    /** The card will be displayed in full width */
+    block?: boolean;
+}
+declare function __VLS_template(): {
+    slots: {
+        header?(_: {}): any;
+        default?(_: {}): any;
+        title?(_: {}): any;
+        subtitle?(_: {}): any;
+        content?(_: {}): any;
+        footer?(_: {}): any;
+        actions?(_: {}): any;
+    };
+    refs: {};
+    attrs: Partial<{}>;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<MazCardProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<MazCardProps> & Readonly<{}>, {
+    header: string;
+    href: string;
+    to: RouterLinkProps["to"];
+    scale: boolean;
+    orientation: "column" | "row" | "row-reverse" | "column-reverse";
+    images: MazGalleryImage[];
+    noRemaining: boolean;
+    hrefTarget: "_blank" | "_self" | "_parent" | "_top" | string;
+    footerAlign: "right" | "left";
+    galleryWidth: string | number;
+    galleryHeight: string | number;
+    elevation: boolean;
+    radius: boolean;
+    imagesShowCount: number;
+    wrapperClass: HTMLAttributes["class"];
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/types/components/MazCardSpotlight.vue.d.ts

@@ -0,0 +1,60 @@
+import { Color } from './types';
+import { HTMLAttributes, StyleValue } from 'vue';
+export interface MazCardSpotlightProps {
+    /**
+     * The color of the component.
+     * @default primary
+     */
+    color?: Color;
+    /**
+     * Remove the elevation of the component
+     * @default false
+     */
+    noElevation?: boolean;
+    /**
+     * Add padding to the content
+     * @default true
+     */
+    padding?: boolean;
+    /**
+     * The classes to apply to the content div
+     */
+    contentClass?: HTMLAttributes['class'];
+    /**
+     * Style apply to the content div
+     */
+    contentStyle?: StyleValue;
+    /**
+     * The opacity of the inner div - should be between 0 and 1
+     * When 0 the spotlight is completely visible
+     * When 1 the spotlight is only visible on borders
+     * @default 0.95
+     */
+    innerOpacity?: number;
+}
+declare function __VLS_template(): {
+    slots: {
+        default?(_: {}): any;
+    };
+    refs: {
+        blobElement: HTMLDivElement;
+        fakeblobElement: HTMLDivElement;
+    };
+    attrs: Partial<{}>;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<MazCardSpotlightProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<MazCardSpotlightProps> & Readonly<{}>, {
+    color: Color;
+    noElevation: boolean;
+    padding: boolean;
+    contentClass: HTMLAttributes["class"];
+    contentStyle: string | false | import('vue').CSSProperties | StyleValue[] | null;
+    innerOpacity: number;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/types/components/MazCarousel.vue.d.ts

@@ -0,0 +1,34 @@
+export interface MazCarouselProps {
+    /** Do not display the scroll buttons */
+    noScrollBtn?: boolean;
+    /** Aria label for the previous button */
+    ariaLabelPreviousButton?: string;
+    /** Aria label for the next button */
+    ariaLabelNextButton?: string;
+    /** Hide the scrollbar when not active */
+    hideScrollbar?: boolean;
+}
+declare function __VLS_template(): {
+    slots: {
+        title?(_: {}): any;
+        "previous-icon"?(_: {}): any;
+        "next-icon"?(_: {}): any;
+        default?(_: {}): any;
+    };
+    refs: {
+        MazCarouselItems: HTMLDivElement;
+    };
+    attrs: Partial<{}>;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<MazCarouselProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<MazCarouselProps> & Readonly<{}>, {
+    ariaLabelPreviousButton: string;
+    ariaLabelNextButton: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};