maz-ui
Version:
A standalone components library for Vue.Js 3 & Nuxt.Js 3
96 lines (95 loc) • 3.57 kB
TypeScript
import type { RouterLinkProps } from 'vue-router';
import type { MazGalleryImage } from './types';
import { type HTMLAttributes } from 'vue';
export type { MazGalleryImage } from './types';
export interface Props {
/** 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(): {
attrs: Partial<{}>;
slots: {
header?(_: {}): any;
default?(_: {}): any;
title?(_: {}): any;
subtitle?(_: {}): any;
content?(_: {}): any;
footer?(_: {}): any;
actions?(_: {}): any;
};
refs: {};
rootEl: HTMLDivElement;
};
type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
declare const __VLS_component: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
header: string;
href: string;
to: RouterLinkProps["to"];
orientation: "column" | "row" | "row-reverse" | "column-reverse";
scale: boolean;
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, {}, HTMLDivElement>;
declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
export default _default;
type __VLS_WithTemplateSlots<T, S> = T & {
new (): {
$slots: S;
};
};